Apache Kafka 支持

通过提供 spring-kafka 项目的自动配置来支持Apache Kafka。

Kafka 配置由 spring.kafka.* 中的外部配置属性控制。例如，你可以在 application.properties 中声明以下部分

属性
YAML

spring.kafka.bootstrap-servers=localhost:9092
spring.kafka.consumer.group-id=myGroup

spring:
  kafka:
    bootstrap-servers: "localhost:9092"
    consumer:
      group-id: "myGroup"

要在启动时创建主题，请添加类型为NewTopic的 Bean。如果主题已存在，则忽略该 Bean。

有关更多支持的选项，请参阅KafkaProperties。

发送消息

Spring 的KafkaTemplate已自动配置，您可以将其直接自动装配到您自己的 Bean 中，如下例所示

Java
Kotlin

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。此外，如果定义了RecordMessageConverter Bean，则会将其自动关联到自动配置的KafkaTemplate。

接收消息

当 Apache Kafka 基础设施存在时，任何 Bean 都可以使用@KafkaListener进行注释以创建侦听器端点。如果未定义KafkaListenerContainerFactory，则会自动配置一个默认的，其中包含spring.kafka.listener.*中定义的键。

以下组件在someTopic主题上创建了一个侦听器端点

Java
Kotlin

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?) {
		// ...
	}

}

如果定义了KafkaTransactionManager Bean，则会将其自动关联到容器工厂。类似地，如果定义了RecordFilterStrategy、CommonErrorHandler、AfterRollbackProcessor或ConsumerAwareRebalanceListener Bean，则会将其自动关联到默认工厂。

根据侦听器类型，RecordMessageConverter或BatchMessageConverter Bean 会关联到默认工厂。如果批处理侦听器仅存在RecordMessageConverter Bean，则将其包装在BatchMessageConverter中。

自定义ChainedKafkaTransactionManager必须标记为@Primary，因为它通常引用自动配置的KafkaTransactionManager Bean。

Kafka Streams

Spring for Apache Kafka 提供了一个工厂 Bean 来创建StreamsBuilder对象并管理其流的生命周期。只要kafka-streams位于类路径上并且 Kafka Streams 由@EnableKafkaStreams注释启用，Spring Boot 就会自动配置所需的KafkaStreamsConfiguration Bean。

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

可以使用专用属性使用多个其他属性；其他任意 Kafka 属性可以使用spring.kafka.streams.properties命名空间进行设置。有关更多信息，另请参阅其他 Kafka 属性。

要使用工厂 Bean，请将StreamsBuilder连接到您的@Bean中，如下例所示

Java
Kotlin

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())
	}

}

默认情况下，StreamBuilder对象管理的流会自动启动。您可以使用spring.kafka.streams.auto-startup属性自定义此行为。

其他 Kafka 属性

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

名称中不包含客户端类型（producer、consumer、admin或streams）的属性被视为通用属性，并应用于所有客户端。如果需要，可以为一个或多个客户端类型覆盖大多数这些通用属性。

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

只有 Kafka 支持的属性的一个子集可以通过KafkaProperties类直接使用。如果您希望使用未直接支持的其他属性配置各个客户端类型，请使用以下属性

属性
YAML

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.one Kafka 属性设置为first（适用于生产者、消费者、管理员和流）、prop.two管理员属性设置为second、prop.three消费者属性设置为third、prop.four生产者属性设置为fourth，以及prop.five流属性设置为fifth。

您还可以如下配置 Spring Kafka JsonDeserializer

属性
YAML

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将类型信息发送到标头中的默认行为

属性
YAML

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 代理测试项目。要使用此功能，请使用来自spring-kafka-test模块的@EmbeddedKafka注释测试类。有关更多信息，请参阅 Spring for Apache Kafka 的参考手册。

要使 Spring Boot 自动配置与上述嵌入式 Apache Kafka 代理一起使用，您需要将嵌入式代理地址的系统属性（由EmbeddedKafkaBroker填充）重新映射到 Apache Kafka 的 Spring Boot 配置属性中。有几种方法可以做到这一点

在测试类中提供一个系统属性，以将嵌入式代理地址映射到spring.kafka.bootstrap-servers中

Java
Kotlin

	static {
		System.setProperty(EmbeddedKafkaBroker.BROKER_LIST_PROPERTY, "spring.kafka.bootstrap-servers");
	}

	init {
		System.setProperty(EmbeddedKafkaBroker.BROKER_LIST_PROPERTY, "spring.kafka.bootstrap-servers")
	}

在@EmbeddedKafka注释上配置属性名称

Java
Kotlin

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 {

	// ...

}

在配置属性中使用占位符

属性
YAML

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

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