Lucene University：自包含的 Lucene 示例教程

该仓库包含 Apache Lucene 功能的自包含示例，其中包含详细的 Markdown 代码注释说明。

目标是提供可用于以下几种方式的代码示例：

1. 阅读源代码。注释应该能清楚地说明代码的用途。
2. 在你的 IDE 中打开代码示例，并使用调试器逐步执行。跟随注释理解代码逻辑。修改代码并查看会发生什么。（有些示例包含建议的修改。）
3. 通过 Docco 生成的网页阅读代码和文档，网址为 https://msfroh.github.io/lucene-university/docs/SimpleSearch.html。（转到右上角的“Jump to...”框以加载其他示例。）这应该感觉像在阅读一本书。

快速开始

该仓库目前依赖于 Lucene 10，它需要 JDK 21 或更高版本。

你可以克隆该仓库，并使用以下命令构建示例：

git clone https://github.com/msfroh/lucene-university.git
cd lucene-university
./gradlew build

使用 IntelliJ，你可以使用 "File -> New -> Project from Existing Sources..." 并指向代码克隆的位置。 选择 "Import Project from Existing Model" 并选择 "Gradle" （假设你已安装 Gradle 插件）。 如果你遇到关于类文件版本的错误，你可能需要转到 "File -> Project Structure..." 以确保你选择了正确的 JDK（21 或更高版本）并设置了合适的语言级别。

贡献

欢迎贡献！查看 GitHub issues 以获取请求和有关材料的建议。如果你认为还有其他东西可以使用示例，请随时直接打开一个包含示例的 pull request 或创建一个 issue 请求。

代码示例应满足以下条件：

1. 每个源文件应该是自包含的，并且应该只导入 Lucene 和 Java 类。示例类不应从任何其他类继承。如果你需要一个小的辅助类，请将其设置为 private static 内部类。
2. 每个示例类应该有一个 public static void main 方法，该方法清楚地逐步演示给定的功能。
3. 每个示例应以带有大标题的注释开头（// # This is title text），以及一个总结，解释该示例是关于什么的，然后再声明 package。

License

该仓库中的所有代码均根据 Apache License, Version 2.0 获得许可。 有关许可证的完整文本，请参阅仓库根目录中的 LICENSE 文件。

关于

Apache Lucene 功能的自包含示例。

资源

• Readme

License

• Apache-2.0 license
• Activity

Stars

• 116 stars

Watchers

• 6 watching

Forks

• 29 forks

报告仓库

Releases

尚未发布任何 releases

Packages 0

尚未发布任何 packages

Contributors 8

语言

• Java 100.0%