对于最新的稳定版本，请使用 Spring Boot 3.4.0！spring-doc.cadn.net.cn

Apache Kafka 支持

Apache Kafka 通过提供spring-kafka项目。spring-doc.cadn.net.cn

Kafka 配置由spring.kafka.*. 例如，您可以在application.properties:spring-doc.cadn.net.cn

spring.kafka.bootstrap-servers=localhost:9092
spring.kafka.consumer.group-id=myGroup
spring:
  kafka:
    bootstrap-servers: "localhost:9092"
    consumer:
      group-id: "myGroup"
要在启动时创建主题，请添加NewTopic. 如果主题已存在，则忽略该 Bean。

看KafkaProperties以获取更多支持的选项。spring-doc.cadn.net.cn

发送消息

Spring的KafkaTemplate是自动配置的，你可以直接在自己的 bean 中自动装配它，如以下示例所示：spring-doc.cadn.net.cn

import org.springframework.kafka.core.KafkaTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	private final KafkaTemplate<String, String> kafkaTemplate;

	public MyBean(KafkaTemplate<String, String> kafkaTemplate) {
		this.kafkaTemplate = kafkaTemplate;
	}

	// ...

	public void someMethod() {
		this.kafkaTemplate.send("someTopic", "Hello");
	}

}
import org.springframework.kafka.core.KafkaTemplate
import org.springframework.stereotype.Component

@Component
class MyBean(private val kafkaTemplate: KafkaTemplate<String, String>) {

	// ...

	fun someMethod() {
		kafkaTemplate.send("someTopic", "Hello")
	}

}
如果属性spring.kafka.producer.transaction-id-prefix定义时，一个KafkaTransactionManager将自动配置。 此外，如果RecordMessageConverterbean 时，它会自动关联到自动配置的KafkaTemplate.

接收消息

当存在 Apache Kafka 基础架构时，任何 bean 都可以使用@KafkaListener以创建侦听器终端节点。 如果没有KafkaListenerContainerFactory已定义，则会自动使用spring.kafka.listener.*.spring-doc.cadn.net.cn

以下组件在someTopic主题：spring-doc.cadn.net.cn

import org.springframework.kafka.annotation.KafkaListener;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	@KafkaListener(topics = "someTopic")
	public void processMessage(String content) {
		// ...
	}

}
import org.springframework.kafka.annotation.KafkaListener
import org.springframework.stereotype.Component

@Component
class MyBean {

	@KafkaListener(topics = ["someTopic"])
	fun processMessage(content: String?) {
		// ...
	}

}

如果KafkaTransactionManagerbean，它会自动关联到容器工厂。 同样，如果RecordFilterStrategy,CommonErrorHandler,AfterRollbackProcessor或ConsumerAwareRebalanceListenerbean，它会自动关联到默认工厂。spring-doc.cadn.net.cn

根据侦听器类型，RecordMessageConverter或BatchMessageConverterbean 与默认工厂相关联。 如果只有一个RecordMessageConverterbean 的 bean 被打包在BatchMessageConverter.spring-doc.cadn.net.cn

自定义ChainedKafkaTransactionManager必须标记@Primary因为它通常引用 auto-configuredKafkaTransactionManager豆。

Kafka 流

Spring for Apache Kafka 提供了一个工厂 Bean 来创建StreamsBuilder对象并管理其流的生命周期。 Spring Boot 会自动配置所需的KafkaStreamsConfigurationbean 只要kafka-streams位于 Classpath 上，并且 Kafka Streams 由@EnableKafkaStreams注解。spring-doc.cadn.net.cn

启用 Kafka Streams 意味着必须设置应用程序 ID 和引导服务器。 前者可以使用spring.kafka.streams.application-id，默认为spring.application.name如果未设置。 后者可以全局设置，也可以仅针对流专门覆盖。spring-doc.cadn.net.cn

使用专用属性可以使用多个其他属性;其他任意 Kafka 属性可以使用spring.kafka.streams.propertiesNamespace。 有关更多信息，另请参阅其他 Kafka 属性。spring-doc.cadn.net.cn

要使用工厂 Bean，请将 wireStreamsBuilder放入您的@Bean如以下示例所示：spring-doc.cadn.net.cn

import java.util.Locale;

import org.apache.kafka.common.serialization.Serdes;
import org.apache.kafka.streams.KeyValue;
import org.apache.kafka.streams.StreamsBuilder;
import org.apache.kafka.streams.kstream.KStream;
import org.apache.kafka.streams.kstream.Produced;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.kafka.annotation.EnableKafkaStreams;
import org.springframework.kafka.support.serializer.JsonSerde;

@Configuration(proxyBeanMethods = false)
@EnableKafkaStreams
public class MyKafkaStreamsConfiguration {

	@Bean
	public KStream<Integer, String> kStream(StreamsBuilder streamsBuilder) {
		KStream<Integer, String> stream = streamsBuilder.stream("ks1In");
		stream.map(this::uppercaseValue).to("ks1Out", Produced.with(Serdes.Integer(), new JsonSerde<>()));
		return stream;
	}

	private KeyValue<Integer, String> uppercaseValue(Integer key, String value) {
		return new KeyValue<>(key, value.toUpperCase(Locale.getDefault()));
	}

}
import org.apache.kafka.common.serialization.Serdes
import org.apache.kafka.streams.KeyValue
import org.apache.kafka.streams.StreamsBuilder
import org.apache.kafka.streams.kstream.KStream
import org.apache.kafka.streams.kstream.Produced
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.kafka.annotation.EnableKafkaStreams
import org.springframework.kafka.support.serializer.JsonSerde

@Configuration(proxyBeanMethods = false)
@EnableKafkaStreams
class MyKafkaStreamsConfiguration {

	@Bean
	fun kStream(streamsBuilder: StreamsBuilder): KStream<Int, String> {
		val stream = streamsBuilder.stream<Int, String>("ks1In")
		stream.map(this::uppercaseValue).to("ks1Out", Produced.with(Serdes.Integer(), JsonSerde()))
		return stream
	}

	private fun uppercaseValue(key: Int, value: String): KeyValue<Int?, String?> {
		return KeyValue(key, value.uppercase())
	}

}

默认情况下，由StreamsBuilder对象会自动启动。 您可以使用spring.kafka.streams.auto-startup财产。spring-doc.cadn.net.cn

其他 Kafka 属性

自动配置支持的属性显示在附录的 集成属性 部分中。 请注意，在大多数情况下，这些属性（带连字符或 camelCase）直接映射到 Apache Kafka 点分隔属性。 有关详细信息，请参阅 Apache Kafka 文档。spring-doc.cadn.net.cn

不包含客户端类型 （producer,consumer,admin或streams） 被视为通用的，适用于所有客户端。 如果需要，可以覆盖一个或多个客户端类型的大多数公共属性。spring-doc.cadn.net.cn

Apache Kafka 指定重要性为 HIGH、MEDIUM 或 LOW 的属性。 Spring Boot 自动配置支持所有 HIGH 重要性属性，一些选定的 MEDIUM 和 LOW 属性，以及任何没有默认值的属性。spring-doc.cadn.net.cn

只有 Kafka 支持的属性子集可以直接通过KafkaProperties类。 如果要使用不直接支持的其他属性配置各个客户端类型，请使用以下属性：spring-doc.cadn.net.cn

spring.kafka.properties[prop.one]=first
spring.kafka.admin.properties[prop.two]=second
spring.kafka.consumer.properties[prop.three]=third
spring.kafka.producer.properties[prop.four]=fourth
spring.kafka.streams.properties[prop.five]=fifth
spring:
  kafka:
    properties:
      "[prop.one]": "first"
    admin:
      properties:
        "[prop.two]": "second"
    consumer:
      properties:
        "[prop.three]": "third"
    producer:
      properties:
        "[prop.four]": "fourth"
    streams:
      properties:
        "[prop.five]": "fifth"

这将prop.oneKafka 属性设置为first（适用于创建者、使用者、管理员和流），则prop.twoadmin 属性设置为second这prop.threeconsumer 属性设置为third这prop.fourproducer 属性设置为fourth和prop.fivestreams 属性设置为fifth.spring-doc.cadn.net.cn

您还可以配置 Spring KafkaJsonDeserializer如下：spring-doc.cadn.net.cn

spring.kafka.consumer.value-deserializer=org.springframework.kafka.support.serializer.JsonDeserializer
spring.kafka.consumer.properties[spring.json.value.default.type]=com.example.Invoice
spring.kafka.consumer.properties[spring.json.trusted.packages]=com.example.main,com.example.another
spring:
  kafka:
    consumer:
      value-deserializer: "org.springframework.kafka.support.serializer.JsonDeserializer"
      properties:
        "[spring.json.value.default.type]": "com.example.Invoice"
        "[spring.json.trusted.packages]": "com.example.main,com.example.another"

同样，您可以禁用JsonSerializer在 Headers 中发送类型信息的默认行为：spring-doc.cadn.net.cn

spring.kafka.producer.value-serializer=org.springframework.kafka.support.serializer.JsonSerializer
spring.kafka.producer.properties[spring.json.add.type.headers]=false
spring:
  kafka:
    producer:
      value-serializer: "org.springframework.kafka.support.serializer.JsonSerializer"
      properties:
        "[spring.json.add.type.headers]": false
以这种方式设置的属性将覆盖 Spring Boot 显式支持的任何配置项。

使用嵌入式 Kafka 进行测试

Spring for Apache Kafka 提供了一种使用嵌入式 Apache Kafka 代理测试项目的便捷方法。 要使用此功能，请使用@EmbeddedKafka从spring-kafka-test模块。 有关更多信息，请参阅 Spring for Apache Kafka 参考手册。spring-doc.cadn.net.cn

要使 Spring Boot 自动配置与上述嵌入式 Apache Kafka 代理一起工作，您需要重新映射嵌入式代理地址的系统属性（由EmbeddedKafkaBroker） 添加到 Apache Kafka 的 Spring Boot 配置属性中。 有几种方法可以做到这一点：spring-doc.cadn.net.cn

  • 提供一个系统属性，用于将嵌入式代理地址映射到spring.kafka.bootstrap-servers在 test 类中：spring-doc.cadn.net.cn

	static {
		System.setProperty(EmbeddedKafkaBroker.BROKER_LIST_PROPERTY, "spring.kafka.bootstrap-servers");
	}
	init {
		System.setProperty(EmbeddedKafkaBroker.BROKER_LIST_PROPERTY, "spring.kafka.bootstrap-servers")
	}
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.kafka.test.context.EmbeddedKafka;

@SpringBootTest
@EmbeddedKafka(topics = "someTopic", bootstrapServersProperty = "spring.kafka.bootstrap-servers")
class MyTest {

	// ...

}
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.kafka.test.context.EmbeddedKafka

@SpringBootTest
@EmbeddedKafka(topics = ["someTopic"], bootstrapServersProperty = "spring.kafka.bootstrap-servers")
class MyTest {

	// ...

}
spring.kafka.bootstrap-servers=${spring.embedded.kafka.brokers}
spring:
  kafka:
    bootstrap-servers: "${spring.embedded.kafka.brokers}"