Apache Kafka的Spring框架

行为准则

请查看我们的行为准则。

报告安全漏洞

请查看我们的安全政策。

检出和构建

要检出项目并从源代码构建，请执行以下操作：

git clone git://github.com/spring-projects/spring-kafka.git
cd spring-kafka
./gradlew build

建议使用Java 17或更高版本来构建项目。

如果在构建过程中遇到内存不足错误，请在gradle.properties中更改org.gradle.jvmargs属性。

要构建并将jar安装到本地Maven缓存中：

./gradlew install

要构建API Javadoc（结果将在build/api中）：

./gradlew api

要构建参考文档（结果将在spring-kafka-docs/build/site中）：

./gradlew antora

要构建完整的分发包，包括-dist、-docs和-schema zip文件（结果将在build/distributions中）

./gradlew dist

使用Eclipse

要生成Eclipse元数据（.classpath和.project文件），请执行以下操作：

./gradlew eclipse

完成后，您可以像往常一样将项目导入Eclipse：

文件 -> 导入 -> 将现有项目导入工作空间

浏览到*'spring-kafka'*根目录。所有项目都应该无错误导入。

使用IntelliJ IDEA

要生成IDEA元数据（.iml和.ipr文件），请执行以下操作：

./gradlew idea

资源

欲了解更多信息，请访问Spring Kafka网站： 参考手册

为Spring Kafka做贡献

以下是您参与社区的一些方式：

• 在Spring社区论坛上参与讨论。 请在StackOverflow上回答问题并参与讨论，以提供帮助。
• 为bug和新功能创建GitHub issues，并对您感兴趣的问题进行评论和投票。
• GitHub是用于社交编码的平台：如果您想编写代码，我们鼓励通过此存储库的分支提交拉取请求来贡献。 如果您想以这种方式贡献代码，请同时引用一个GitHub issue，以涵盖您正在解决的具体问题。
• 通过订阅 springframework.org，关注即将发布的Spring相关文章。

在我们接受非平凡的补丁或拉取请求之前，您需要签署贡献者协议。 签署贡献者协议并不会授予任何人对主存储库的提交权限，但这意味着我们可以接受您的贡献，如果我们这样做，您将获得作者荣誉。 活跃的贡献者可能会被邀请加入核心团队，并获得合并拉取请求的权限。

代码约定和内务管理

这些都不是拉取请求的必要条件，但它们都会有所帮助。 它们也可以在原始拉取请求之后但在合并之前添加。

• 使用Spring Framework代码格式约定（如果您使用Eclipse，请从项目根目录导入eclipse-code-formatter.xml）。
• 确保所有新的.java文件都有一个简单的Javadoc类注释，至少包含一个标识您的@author标签，最好还有至少一段关于该类用途的说明。
• 为所有新的.java文件添加ASF许可证头注释（从项目中的现有文件复制）
• 如果您对.java文件进行了实质性修改（不仅仅是外观变化），请将自己添加为@author。
• 添加一些Javadocs，如果您更改了命名空间，还要添加一些XSD文档元素。
• 一些单元测试也会有很大帮助 - 总得有人来做这件事。
• 如果没有其他人使用您的分支，请将其变基到当前的主分支（或主项目中的另一个目标分支）。

获取支持

使用Stack Overflow上的spring-kafka标签来提问；包括代码和配置，并清楚地解释您的问题，如果可能的话，提供一个最小可复现示例。 也可以获得商业支持。

许可证

Spring Kafka根据Apache软件许可证2.0版的条款发布（参见LICENSE.txt）。