Apache Kafka 支持

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

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

  • 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 在类路径上并且通过 @EnableKafkaStreams 注解启用了 Kafka Streams，Spring Boot 就会自动配置所需的 KafkaStreamsConfiguration bean。

启用 Kafka Streams 意味着必须设置应用 ID 和 bootstrap servers。应用 ID 可以使用 spring.kafka.streams.application-id 进行配置，如果未设置则默认为 spring.application.name。bootstrap servers 可以全局设置，也可以仅针对 Streams 特别覆盖。

可以使用专用属性设置几个附加属性；其他任意 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())
	}

}

默认情况下，由 StreamsBuilder 对象管理的流会自动启动。您可以使用 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 类获得。如果您希望使用未直接支持的附加属性配置各个客户端类型，请使用以下属性

  • Properties

  • 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"

这将通用 Kafka 属性 prop.one 设置为 first（适用于生产者、消费者、admin 和 streams），admin 属性 prop.two 设置为 second，consumer 属性 prop.three 设置为 third，producer 属性 prop.four 设置为 fourth，streams 属性 prop.five 设置为 fifth。

您还可以按如下方式配置 Spring Kafka 的 JsonDeserializer

  • Properties

  • 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 在头部发送类型信息的默认行为

  • Properties

  • 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 填充）重新映射到 Spring Boot 中 Apache Kafka 的配置属性。有几种方法可以做到这一点

  • 在测试类中提供系统属性，将嵌入式代理地址映射到 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")
	}

  • 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 {

	// ...

}

  • 在配置属性中使用占位符

  • Properties

  • YAML

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