Provides Familiar Spring Abstractions for Apache Kafka
APACHE-2.0 License
Please see our Code of conduct.
Please see our Security policy.
To check out the project and build from source, do the following:
git clone git://github.com/spring-projects/spring-kafka.git
cd spring-kafka
./gradlew build
Java 17 or later version is recommended to build the project.
If you encounter out of memory errors during the build, change the org.gradle.jvmargs
property in gradle.properties
.
To build and install jars into your local Maven cache:
./gradlew install
To build API Javadoc (results will be in build/api
):
./gradlew api
To build reference documentation (results will be in spring-kafka-docs/build/site
):
./gradlew antora
To build complete distribution including -dist
, -docs
, and -schema
zip files (results will be in build/distributions
)
./gradlew dist
To generate Eclipse metadata (.classpath and .project files), do the following:
./gradlew eclipse
Once complete, you may then import the projects into Eclipse as usual:
File -> Import -> Existing projects into workspace
Browse to the 'spring-kafka' root directory. All projects should import free of errors.
To generate IDEA metadata (.iml and .ipr files), do the following:
./gradlew idea
For more information, please visit the Spring Kafka website at: Reference Manual
Here are some ways for you to get involved in the community:
Before we accept a non-trivial patch or pull request we will need you to sign the contributor's agreement. Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team and given the ability to merge pull requests.
None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.
eclipse-code-formatter.xml
from the root of the project if you are using Eclipse)..java
files to have a simple Javadoc class comment with at least an @author
tag identifying you, and preferably at least a paragraph on what the class is for..java
files (copy from existing files in the project)@author
to the .java
files that you modify substantially (more than cosmetic changes).Use the spring-kafka
tag on Stack Overflow to ask questions; include code and configuration and clearly explain your problem, providing an MCRE if possible.
Commercial support is also available.
Spring Kafka is released under the terms of the Apache Software License Version 2.0 (see LICENSE.txt).