测试应用程序

spring-kafka-test jar 包含一些有用的实用程序,以帮助测试您的应用程序。

嵌入式 Kafka 代理

提供了两种实现

  • EmbeddedKafkaZKBroker - 启动嵌入式 Zookeeper 实例的旧版实现(在使用 EmbeddedKafka 时仍然是默认实现)。

  • EmbeddedKafkaKraftBroker - 在组合控制器和代理模式中使用 Kraft 代替 Zookeeper(自 3.1 起)。

有几种技术可以配置代理,如下面各节中所述。

KafkaTestUtils

org.springframework.kafka.test.utils.KafkaTestUtils 提供了许多静态帮助器方法来使用记录、检索各种记录偏移量等。请参阅其 Javadocs 以获取完整详细信息。

JUnit

org.springframework.kafka.test.utils.KafkaTestUtils 还提供了一些静态方法来设置生产者和使用者属性。以下列表显示了这些方法签名

/**
 * Set up test properties for an {@code <Integer, String>} consumer.
 * @param group the group id.
 * @param autoCommit the auto commit.
 * @param embeddedKafka a {@link EmbeddedKafkaBroker} instance.
 * @return the properties.
 */
public static Map<String, Object> consumerProps(String group, String autoCommit,
                                       EmbeddedKafkaBroker embeddedKafka) { ... }

/**
 * Set up test properties for an {@code <Integer, String>} producer.
 * @param embeddedKafka a {@link EmbeddedKafkaBroker} instance.
 * @return the properties.
 */
public static Map<String, Object> producerProps(EmbeddedKafkaBroker embeddedKafka) { ... }

从 2.5 版开始,consumerProps 方法将 ConsumerConfig.AUTO_OFFSET_RESET_CONFIG 设置为 earliest。这是因为在大多数情况下,您希望使用者使用测试用例中发送的任何消息。ConsumerConfig 默认值为 latest,这意味着在使用者启动之前测试已发送的消息将不会收到这些记录。要恢复到以前的设置,请在调用该方法后将属性设置为 latest

在使用嵌入式代理时,通常最佳做法是为每个测试使用不同的主题,以防止串扰。如果由于某种原因无法做到这一点,请注意,consumeFromEmbeddedTopics 方法的默认行为是在分配后将分配的分区寻找到开头。由于它无法访问使用者属性,因此您必须使用带有 seekToEnd 布尔参数的重载方法来寻找到结尾,而不是开头。

提供了用于 EmbeddedKafkaZKBroker 的 JUnit 4 @Rule 包装器,以创建嵌入式 Kafka 和嵌入式 Zookeeper 服务器。(有关将 @EmbeddedKafka 与 JUnit 5 一起使用的信息,请参阅 @EmbeddedKafka Annotation)。以下列表显示了这些方法的签名

/**
 * Create embedded Kafka brokers.
 * @param count the number of brokers.
 * @param controlledShutdown passed into TestUtils.createBrokerConfig.
 * @param topics the topics to create (2 partitions per).
 */
public EmbeddedKafkaRule(int count, boolean controlledShutdown, String... topics) { ... }

/**
 *
 * Create embedded Kafka brokers.
 * @param count the number of brokers.
 * @param controlledShutdown passed into TestUtils.createBrokerConfig.
 * @param partitions partitions per topic.
 * @param topics the topics to create.
 */
public EmbeddedKafkaRule(int count, boolean controlledShutdown, int partitions, String... topics) { ... }
JUnit4 不支持 EmbeddedKafkaKraftBroker

EmbeddedKafkaBroker 类有一个实用方法,可让你使用它创建的所有主题。以下示例展示了如何使用它

Map<String, Object> consumerProps = KafkaTestUtils.consumerProps("testT", "false", embeddedKafka);
DefaultKafkaConsumerFactory<Integer, String> cf = new DefaultKafkaConsumerFactory<>(consumerProps);
Consumer<Integer, String> consumer = cf.createConsumer();
embeddedKafka.consumeFromAllEmbeddedTopics(consumer);

KafkaTestUtils 有一些实用方法,可从使用者获取结果。以下清单展示了这些方法签名

/**
 * Poll the consumer, expecting a single record for the specified topic.
 * @param consumer the consumer.
 * @param topic the topic.
 * @return the record.
 * @throws org.junit.ComparisonFailure if exactly one record is not received.
 */
public static <K, V> ConsumerRecord<K, V> getSingleRecord(Consumer<K, V> consumer, String topic) { ... }

/**
 * Poll the consumer for records.
 * @param consumer the consumer.
 * @return the records.
 */
public static <K, V> ConsumerRecords<K, V> getRecords(Consumer<K, V> consumer) { ... }

以下示例展示了如何使用 KafkaTestUtils

...
template.sendDefault(0, 2, "bar");
ConsumerRecord<Integer, String> received = KafkaTestUtils.getSingleRecord(consumer, "topic");
...

当嵌入式 Kafka 和嵌入式 Zookeeper 服务器由 EmbeddedKafkaBroker 启动时,一个名为 spring.embedded.kafka.brokers 的系统属性被设置为 Kafka 代理的地址,一个名为 spring.embedded.zookeeper.connect 的系统属性被设置为 Zookeeper 的地址。为此属性提供了方便的常量(EmbeddedKafkaBroker.SPRING_EMBEDDED_KAFKA_BROKERSEmbeddedKafkaBroker.SPRING_EMBEDDED_ZOOKEEPER_CONNECT)。

除了默认的 spring.embedded.kafka.brokers 系统属性,Kafka 代理的地址可以公开给任意且方便的属性。为此,可以在启动嵌入式 Kafka 之前设置一个 spring.embedded.kafka.brokers.propertyEmbeddedKafkaBroker.BROKER_LIST_PROPERTY)系统属性。例如,对于 Spring Boot,spring.kafka.bootstrap-servers 配置属性预期被设置为自动配置的 Kafka 客户端。因此,在随机端口上运行带有嵌入式 Kafka 的测试之前,我们可以将 spring.embedded.kafka.brokers.property=spring.kafka.bootstrap-servers 设置为系统属性 - EmbeddedKafkaBroker 将使用它来公开其代理地址。现在这是此属性的默认值(从版本 3.0.10 开始)。

使用 EmbeddedKafkaBroker.brokerProperties(Map<String, String>),你可以为 Kafka 服务器提供其他属性。有关可能的代理属性的更多信息,请参阅 Kafka 配置

配置主题

以下示例配置创建了名为 cathat 的主题,具有五个分区,一个名为 thing1 的主题,具有 10 个分区,一个名为 thing2 的主题,具有 15 个分区

public class MyTests {

    @ClassRule
    private static EmbeddedKafkaRule embeddedKafka = new EmbeddedKafkaRule(1, false, 5, "cat", "hat");

    @Test
    public void test() {
        embeddedKafkaRule.getEmbeddedKafka()
              .addTopics(new NewTopic("thing1", 10, (short) 1), new NewTopic("thing2", 15, (short) 1));
        ...
    }

}

默认情况下,当出现问题(例如添加已存在的主题)时,addTopics 将抛出一个异常。版本 2.6 添加了该方法的一个新版本,该版本返回一个 Map<String, Exception>;键是主题名称,值为 null 表示成功,或 Exception 表示失败。

在多个测试类中使用相同的代理

你可以使用类似以下内容的多个测试类来使用相同的代理

public final class EmbeddedKafkaHolder {

    private static EmbeddedKafkaBroker embeddedKafka = new EmbeddedKafkaZKBroker(1, false)
            .brokerListProperty("spring.kafka.bootstrap-servers");

    private static boolean started;

    public static EmbeddedKafkaBroker getEmbeddedKafka() {
        if (!started) {
            try {
                embeddedKafka.afterPropertiesSet();
            }
            catch (Exception e) {
                throw new KafkaException("Embedded broker failed to start", e);
            }
            started = true;
        }
        return embeddedKafka;
    }

    private EmbeddedKafkaHolder() {
        super();
    }

}

这假定了一个 Spring Boot 环境,并且嵌入式代理替换了引导服务器属性。

然后,在每个测试类中,你可以使用类似于以下内容

static {
    EmbeddedKafkaHolder.getEmbeddedKafka().addTopics("topic1", "topic2");
}

private static final EmbeddedKafkaBroker broker = EmbeddedKafkaHolder.getEmbeddedKafka();

如果你没有使用 Spring Boot,你可以使用 broker.getBrokersAsString() 获取引导服务器。

前面的示例没有提供在所有测试完成时关闭代理的机制。如果说你在 Gradle 守护进程中运行测试,这可能是个问题。你不应该在这种情况下使用此技术,或者你应该使用一些东西在测试完成后对 EmbeddedKafkaBroker 调用 destroy()

从版本 3.0 开始,该框架为 JUnit Platform 公开了 GlobalEmbeddedKafkaTestExecutionListener;它默认处于禁用状态。这需要 JUnit Platform 1.8 或更高版本。此侦听器的目的是为整个测试计划启动一个全局 EmbeddedKafkaBroker,并在计划结束时停止它。要启用此侦听器,因此为项目中的所有测试提供一个全局嵌入式 Kafka 集群,必须通过系统属性或 JUnit Platform 配置将 spring.kafka.global.embedded.enabled 属性设置为 true。此外,可以提供以下属性

  • spring.kafka.embedded.count - 要管理的 Kafka 代理的数量;

  • spring.kafka.embedded.ports - 每个 Kafka 代理启动的端口(逗号分隔值),如果首选随机端口,则为 0;值的数目必须等于上面提到的 count

  • spring.kafka.embedded.topics - 在启动的 Kafka 集群中创建的主题(逗号分隔值);

  • spring.kafka.embedded.partitions - 为创建的主题预配的分区数;

  • spring.kafka.embedded.broker.properties.location - 用于其他 Kafka 代理配置属性的文件的位置;此属性的值必须遵循 Spring 资源抽象模式;

  • spring.kafka.embedded.kraft - 默认值为 false,当为 true 时,使用 EmbeddedKafkaKraftBroker 而不是 EmbeddedKafkaZKBroker

从本质上讲,这些属性模拟了一些 @EmbeddedKafka 属性。

请参阅 JUnit 5 用户指南 中有关配置属性以及如何提供它们的更多信息。例如,可以在测试类路径中的 junit-platform.properties 文件中添加 spring.embedded.kafka.brokers.property=my.bootstrap-servers 条目。从版本 3.0.10 开始,代理会自动将此设置为 spring.kafka.bootstrap-servers,默认情况下,用于测试 Spring Boot 应用程序。

建议不要在单个测试套件中组合全局嵌入式 Kafka 和每个测试类。它们都共享相同的系统属性,因此很可能会导致意外的行为。
spring-kafka-testjunit-jupiter-apijunit-platform-launcher(后者支持全局嵌入式代理)具有传递依赖项。如果你希望使用嵌入式代理并且没有使用 JUnit,你可能希望排除这些依赖项。

@EmbeddedKafka 注解

我们通常建议你将规则用作 @ClassRule,以避免在测试之间启动和停止代理(并为每个测试使用不同的主题)。从版本 2.0 开始,如果你使用 Spring 的测试应用程序上下文缓存,你还可以声明一个 EmbeddedKafkaBroker bean,以便可以在多个测试类中使用一个代理。为了方便起见,我们提供了一个名为 @EmbeddedKafka 的测试类级别注解来注册 EmbeddedKafkaBroker bean。以下示例显示了如何使用它

@RunWith(SpringRunner.class)
@DirtiesContext
@EmbeddedKafka(partitions = 1,
         topics = {
                 KafkaStreamsTests.STREAMING_TOPIC1,
                 KafkaStreamsTests.STREAMING_TOPIC2 })
public class KafkaStreamsTests {

    @Autowired
    private EmbeddedKafkaBroker embeddedKafka;

    @Test
    public void someTest() {
        Map<String, Object> consumerProps = KafkaTestUtils.consumerProps("testGroup", "true", this.embeddedKafka);
        consumerProps.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
        ConsumerFactory<Integer, String> cf = new DefaultKafkaConsumerFactory<>(consumerProps);
        Consumer<Integer, String> consumer = cf.createConsumer();
        this.embeddedKafka.consumeFromAnEmbeddedTopic(consumer, KafkaStreamsTests.STREAMING_TOPIC2);
        ConsumerRecords<Integer, String> replies = KafkaTestUtils.getRecords(consumer);
        assertThat(replies.count()).isGreaterThanOrEqualTo(1);
    }

    @Configuration
    @EnableKafkaStreams
    public static class KafkaStreamsConfiguration {

        @Value("${" + EmbeddedKafkaBroker.SPRING_EMBEDDED_KAFKA_BROKERS + "}")
        private String brokerAddresses;

        @Bean(name = KafkaStreamsDefaultConfiguration.DEFAULT_STREAMS_CONFIG_BEAN_NAME)
        public KafkaStreamsConfiguration kStreamsConfigs() {
            Map<String, Object> props = new HashMap<>();
            props.put(StreamsConfig.APPLICATION_ID_CONFIG, "testStreams");
            props.put(StreamsConfig.BOOTSTRAP_SERVERS_CONFIG, this.brokerAddresses);
            return new KafkaStreamsConfiguration(props);
        }

    }

}

从 2.2.4 版本开始,您还可以使用 @EmbeddedKafka 注解来指定 Kafka 端口属性。

从 3.2 版本开始,将 kraft 属性设置为 true 以使用 EmbeddedKafkaKraftBroker 而不是 EmbeddedKafkaZKBroker

以下示例设置 @EmbeddedKafkatopicsbrokerPropertiesbrokerPropertiesLocation 属性支持属性占位符解析

@TestPropertySource(locations = "classpath:/test.properties")
@EmbeddedKafka(topics = { "any-topic", "${kafka.topics.another-topic}" },
        brokerProperties = { "log.dir=${kafka.broker.logs-dir}",
                            "listeners=PLAINTEXT://127.0.0.1:${kafka.broker.port}",
                            "auto.create.topics.enable=${kafka.broker.topics-enable:true}" },
        brokerPropertiesLocation = "classpath:/broker.properties")

在前面的示例中,属性占位符 ${kafka.topics.another-topic}${kafka.broker.logs-dir}${kafka.broker.port} 从 Spring Environment 解析。此外,代理属性从 brokerPropertiesLocation 指定的 broker.properties 类路径资源加载。属性占位符针对 brokerPropertiesLocation URL 和资源中找到的任何属性占位符解析。brokerProperties 定义的属性会覆盖在 brokerPropertiesLocation 中找到的属性。

您可以在 JUnit 4 或 JUnit 5 中使用 @EmbeddedKafka 注解。

JUnit5 中的 @EmbeddedKafka 注解

从 2.3 版本开始,有两种方法可以在 JUnit5 中使用 @EmbeddedKafka 注解。与 @SpringJunitConfig 注解一起使用时,嵌入式代理将添加到测试应用程序上下文中。您可以在类或方法级别将代理自动连接到您的测试中,以获取代理地址列表。

使用 Spring 测试上下文时,EmbdeddedKafkaCondition 会创建一个代理;该条件包含一个参数解析器,以便您可以在测试方法中访问代理。

@EmbeddedKafka
public class EmbeddedKafkaConditionTests {

    @Test
    public void test(EmbeddedKafkaBroker broker) {
        String brokerList = broker.getBrokersAsString();
        ...
    }

}

将创建独立代理(在 Spring 的 TestContext 之外),除非用 @EmbeddedKafka 注解的类也用 ExtendWith(SpringExtension.class) 注解(或元注解)。@SpringJunitConfig@SpringBootTest 是元注解,当这两个注解同时存在时,将使用基于上下文的代理。

当有可用的 Spring 测试应用程序上下文时,主题和代理属性可以包含属性占位符,只要在某个地方定义了属性,这些占位符就会得到解析。如果没有可用的 Spring 上下文,这些占位符将不会得到解析。

@SpringBootTest 注解中的嵌入式代理

Spring Initializr 现在会自动将 spring-kafka-test 依赖项以测试范围添加到项目配置中。

如果您的应用程序在 spring-cloud-stream 中使用 Kafka 绑定器,并且您想为测试使用嵌入式代理,则必须移除 spring-cloud-stream-test-support 依赖项,因为它会用测试绑定器替换测试用例的真实绑定器。如果您希望某些测试使用测试绑定器,而某些测试使用嵌入式代理,则使用真实绑定器的测试需要通过在测试类中排除绑定器自动配置来禁用测试绑定器。以下示例显示了如何执行此操作

@RunWith(SpringRunner.class)
@SpringBootTest(properties = "spring.autoconfigure.exclude="
    + "org.springframework.cloud.stream.test.binder.TestSupportBinderAutoConfiguration")
public class MyApplicationTests {
    ...
}

在 Spring Boot 应用程序测试中使用嵌入式代理有多种方法。

它们包括

JUnit4 类规则

以下示例演示如何使用 JUnit4 类规则创建嵌入式代理

@RunWith(SpringRunner.class)
@SpringBootTest
public class MyApplicationTests {

    @ClassRule
    public static EmbeddedKafkaRule broker = new EmbeddedKafkaRule(1, false, "someTopic")
            .brokerListProperty("spring.kafka.bootstrap-servers");

    @Autowired
    private KafkaTemplate<String, String> template;

    @Test
    public void test() {
        ...
    }

}

请注意,由于这是一个 Spring Boot 应用程序,因此我们覆盖代理列表属性以设置 Spring Boot 的属性。

使用 @SpringJunitConfig@EmbeddedKafka

@SpringJUnitConfig 中使用 @EmbeddedKafka 时,建议在测试类中使用 @DirtiesContext。这是为了防止在测试套件中运行多个测试后在 JVM 关闭期间发生的潜在竞争条件。例如,如果不使用 @DirtiesContext,则 EmbeddedKafkaBroker 可能会更早关闭,而应用程序上下文仍需要其中的资源。由于每个 EmbeddedKafka 测试运行都会创建自己的临时目录,因此当发生此竞争条件时,它将生成错误日志消息,指出它尝试删除或清理的文件不再可用。添加 @DirtiesContext 将确保在每次测试后清理应用程序上下文,并且不会被缓存,从而使其不易受到此类潜在资源竞争条件的影响。

@EmbeddedKafka 注解或 EmbeddedKafkaBroker Bean

以下示例演示如何使用 @EmbeddedKafka 注解创建嵌入式代理

@RunWith(SpringRunner.class)
@EmbeddedKafka(topics = "someTopic",
        bootstrapServersProperty = "spring.kafka.bootstrap-servers") // this is now the default
public class MyApplicationTests {

    @Autowired
    private KafkaTemplate<String, String> template;

    @Test
    public void test() {
        ...
    }

}
从版本 3.0.10 开始,bootstrapServersProperty 默认自动设置为 spring.kafka.bootstrap-servers

Hamcrest 匹配器

org.springframework.kafka.test.hamcrest.KafkaMatchers 提供以下匹配器

/**
 * @param key the key
 * @param <K> the type.
 * @return a Matcher that matches the key in a consumer record.
 */
public static <K> Matcher<ConsumerRecord<K, ?>> hasKey(K key) { ... }

/**
 * @param value the value.
 * @param <V> the type.
 * @return a Matcher that matches the value in a consumer record.
 */
public static <V> Matcher<ConsumerRecord<?, V>> hasValue(V value) { ... }

/**
 * @param partition the partition.
 * @return a Matcher that matches the partition in a consumer record.
 */
public static Matcher<ConsumerRecord<?, ?>> hasPartition(int partition) { ... }

/**
 * Matcher testing the timestamp of a {@link ConsumerRecord} assuming the topic has been set with
 * {@link org.apache.kafka.common.record.TimestampType#CREATE_TIME CreateTime}.
 *
 * @param ts timestamp of the consumer record.
 * @return a Matcher that matches the timestamp in a consumer record.
 */
public static Matcher<ConsumerRecord<?, ?>> hasTimestamp(long ts) {
  return hasTimestamp(TimestampType.CREATE_TIME, ts);
}

/**
 * Matcher testing the timestamp of a {@link ConsumerRecord}
 * @param type timestamp type of the record
 * @param ts timestamp of the consumer record.
 * @return a Matcher that matches the timestamp in a consumer record.
 */
public static Matcher<ConsumerRecord<?, ?>> hasTimestamp(TimestampType type, long ts) {
  return new ConsumerRecordTimestampMatcher(type, ts);
}

AssertJ 条件

您可以使用以下 AssertJ 条件

/**
 * @param key the key
 * @param <K> the type.
 * @return a Condition that matches the key in a consumer record.
 */
public static <K> Condition<ConsumerRecord<K, ?>> key(K key) { ... }

/**
 * @param value the value.
 * @param <V> the type.
 * @return a Condition that matches the value in a consumer record.
 */
public static <V> Condition<ConsumerRecord<?, V>> value(V value) { ... }

/**
 * @param key the key.
 * @param value the value.
 * @param <K> the key type.
 * @param <V> the value type.
 * @return a Condition that matches the key in a consumer record.
 * @since 2.2.12
 */
public static <K, V> Condition<ConsumerRecord<K, V>> keyValue(K key, V value) { ... }

/**
 * @param partition the partition.
 * @return a Condition that matches the partition in a consumer record.
 */
public static Condition<ConsumerRecord<?, ?>> partition(int partition) { ... }

/**
 * @param value the timestamp.
 * @return a Condition that matches the timestamp value in a consumer record.
 */
public static Condition<ConsumerRecord<?, ?>> timestamp(long value) {
  return new ConsumerRecordTimestampCondition(TimestampType.CREATE_TIME, value);
}

/**
 * @param type the type of timestamp
 * @param value the timestamp.
 * @return a Condition that matches the timestamp value in a consumer record.
 */
public static Condition<ConsumerRecord<?, ?>> timestamp(TimestampType type, long value) {
  return new ConsumerRecordTimestampCondition(type, value);
}

示例

以下示例汇集了本章中涵盖的大部分主题

public class KafkaTemplateTests {

    private static final String TEMPLATE_TOPIC = "templateTopic";

    @ClassRule
    public static EmbeddedKafkaRule embeddedKafka = new EmbeddedKafkaRule(1, true, TEMPLATE_TOPIC);

    @Test
    public void testTemplate() throws Exception {
        Map<String, Object> consumerProps = KafkaTestUtils.consumerProps("testT", "false",
            embeddedKafka.getEmbeddedKafka());
        DefaultKafkaConsumerFactory<Integer, String> cf =
                            new DefaultKafkaConsumerFactory<>(consumerProps);
        ContainerProperties containerProperties = new ContainerProperties(TEMPLATE_TOPIC);
        KafkaMessageListenerContainer<Integer, String> container =
                            new KafkaMessageListenerContainer<>(cf, containerProperties);
        final BlockingQueue<ConsumerRecord<Integer, String>> records = new LinkedBlockingQueue<>();
        container.setupMessageListener(new MessageListener<Integer, String>() {

            @Override
            public void onMessage(ConsumerRecord<Integer, String> record) {
                System.out.println(record);
                records.add(record);
            }

        });
        container.setBeanName("templateTests");
        container.start();
        ContainerTestUtils.waitForAssignment(container,
                            embeddedKafka.getEmbeddedKafka().getPartitionsPerTopic());
        Map<String, Object> producerProps =
                            KafkaTestUtils.producerProps(embeddedKafka.getEmbeddedKafka());
        ProducerFactory<Integer, String> pf =
                            new DefaultKafkaProducerFactory<>(producerProps);
        KafkaTemplate<Integer, String> template = new KafkaTemplate<>(pf);
        template.setDefaultTopic(TEMPLATE_TOPIC);
        template.sendDefault("foo");
        assertThat(records.poll(10, TimeUnit.SECONDS), hasValue("foo"));
        template.sendDefault(0, 2, "bar");
        ConsumerRecord<Integer, String> received = records.poll(10, TimeUnit.SECONDS);
        assertThat(received, hasKey(2));
        assertThat(received, hasPartition(0));
        assertThat(received, hasValue("bar"));
        template.send(TEMPLATE_TOPIC, 0, 2, "baz");
        received = records.poll(10, TimeUnit.SECONDS);
        assertThat(received, hasKey(2));
        assertThat(received, hasPartition(0));
        assertThat(received, hasValue("baz"));
    }

}

前面的示例使用 Hamcrest 匹配器。使用 AssertJ,最后部分看起来像以下代码

assertThat(records.poll(10, TimeUnit.SECONDS)).has(value("foo"));
template.sendDefault(0, 2, "bar");
ConsumerRecord<Integer, String> received = records.poll(10, TimeUnit.SECONDS);
// using individual assertions
assertThat(received).has(key(2));
assertThat(received).has(value("bar"));
assertThat(received).has(partition(0));
template.send(TEMPLATE_TOPIC, 0, 2, "baz");
received = records.poll(10, TimeUnit.SECONDS);
// using allOf()
assertThat(received).has(allOf(keyValue(2, "baz"), partition(0)));

模拟消费者和生产者

kafka-clients 库提供 MockConsumerMockProducer 类用于测试目的。

如果您希望在一些测试中分别使用这些类和监听器容器或 KafkaTemplate,从 3.0.7 版本开始,框架现在提供 MockConsumerFactoryMockProducerFactory 实现。

这些工厂可用于监听器容器和模板中,而不是需要正在运行(或嵌入)的代理的默认工厂。

以下是返回单个消费者的简单实现示例

@Bean
ConsumerFactory<String, String> consumerFactory() {
    MockConsumer<String, String> consumer = new MockConsumer<>(OffsetResetStrategy.EARLIEST);
    TopicPartition topicPartition0 = new TopicPartition("topic", 0);
    List<TopicPartition> topicPartitions = Collections.singletonList(topicPartition0);
    Map<TopicPartition, Long> beginningOffsets = topicPartitions.stream().collect(Collectors
            .toMap(Function.identity(), tp -> 0L));
    consumer.updateBeginningOffsets(beginningOffsets);
    consumer.schedulePollTask(() -> {
        consumer.addRecord(
                new ConsumerRecord<>("topic", 0, 0L, 0L, TimestampType.NO_TIMESTAMP_TYPE, 0, 0, null, "test1",
                        new RecordHeaders(), Optional.empty()));
        consumer.addRecord(
                new ConsumerRecord<>("topic", 0, 1L, 0L, TimestampType.NO_TIMESTAMP_TYPE, 0, 0, null, "test2",
                        new RecordHeaders(), Optional.empty()));
    });
    return new MockConsumerFactory(() -> consumer);
}

如果您希望使用并发进行测试,则工厂构造函数中的 Supplier lambda 需要每次都创建一个新实例。

使用 MockProducerFactory 时,有两个构造函数;一个用于创建简单工厂,另一个用于创建支持事务的工厂。

以下是示例

@Bean
ProducerFactory<String, String> nonTransFactory() {
    return new MockProducerFactory<>(() ->
            new MockProducer<>(true, new StringSerializer(), new StringSerializer()));
}

@Bean
ProducerFactory<String, String> transFactory() {
    MockProducer<String, String> mockProducer =
            new MockProducer<>(true, new StringSerializer(), new StringSerializer());
    mockProducer.initTransactions();
    return new MockProducerFactory<String, String>((tx, id) -> mockProducer, "defaultTxId");
}

请注意,在第二种情况下,lambda 是 BiFunction<Boolean, String>,其中第一个参数为 true,如果调用者需要事务性生产者;可选的第二个参数包含事务 ID。这可以是默认值(如构造函数中提供的),或者可以被 KafkaTransactionManager(或用于本地事务的 KafkaTemplate)覆盖,如果已配置。如果希望基于此值使用不同的 MockProducer,则提供事务 ID。

如果您在多线程环境中使用生产者,则 BiFunction 应返回多个生产者(可能使用 ThreadLocal 线程绑定)。

事务性 MockProducer 必须通过调用 initTransaction() 初始化事务。

使用 MockProducer 时,如果您不想在每次发送后关闭生产者,则可以提供一个自定义 MockProducer 实现,该实现覆盖不调用超类中 close 方法的 close 方法。这在测试中很方便,当在不关闭相同生产者的前提下验证多次发布时。

以下是示例

@Bean
MockProducer<String, String> mockProducer() {
    return new MockProducer<>(false, new StringSerializer(), new StringSerializer()) {
        @Override
        public void close() {

        }
    };
}

@Bean
ProducerFactory<String, String> mockProducerFactory(MockProducer<String, String> mockProducer) {
    return new MockProducerFactory<>(() -> mockProducer);
}