消息头

0.11.0.0 客户端引入了对消息头部的支持。从 2.0 版本开始，Spring for Apache Kafka 现在支持将这些头部映射到 spring-messaging MessageHeaders 以及从 spring-messaging MessageHeaders 映射到这些头部。

以前的版本将 ConsumerRecord 和 ProducerRecord 映射到 spring-messaging Message<?>，其中值属性映射到 payload 和其他属性（topic、partition 等）映射到头部。这种情况仍然存在，但现在可以映射额外的（任意）头部。

Apache Kafka 头部有一个简单的 API，如下面的接口定义所示

public interface Header {

    String key();

    byte[] value();

}

KafkaHeaderMapper 策略用于在 Kafka Headers 和 MessageHeaders 之间映射头部条目。它的接口定义如下

public interface KafkaHeaderMapper {

    void fromHeaders(MessageHeaders headers, Headers target);

    void toHeaders(Headers source, Map<String, Object> target);

}

SimpleKafkaHeaderMapper 将原始头部映射为 byte[]，并提供配置选项以将其转换为 String 值。

DefaultKafkaHeaderMapper 将键映射到 MessageHeaders 头部名称，并且为了支持出站消息的丰富头部类型，将执行 JSON 转换。一个“特殊”头部（键为 spring_json_header_types）包含一个 <key>:<type> 的 JSON 映射。此头部在入站侧使用，以提供对每个头部值的适当转换，使其恢复到原始类型。

在入站方向，所有 Kafka Header 实例都会被映射到 MessageHeaders。在出站方向，默认情况下，所有 MessageHeaders 都会被映射，除了 id、timestamp 和映射到 ConsumerRecord 属性的头部。

您可以通过向映射器提供模式来指定哪些头部要映射到出站消息。以下列表显示了一些示例映射。

public DefaultKafkaHeaderMapper() { (1)
    ...
}

public DefaultKafkaHeaderMapper(ObjectMapper objectMapper) { (2)
    ...
}

public DefaultKafkaHeaderMapper(String... patterns) { (3)
    ...
}

public DefaultKafkaHeaderMapper(ObjectMapper objectMapper, String... patterns) { (4)
    ...
}

1	使用默认的 Jackson `ObjectMapper` 并映射大多数头部，如示例之前所述。
2	使用提供的 Jackson `ObjectMapper` 并映射大多数头部，如示例之前所述。
3	使用默认的 Jackson `ObjectMapper` 并根据提供的模式映射头部。
4	使用提供的 Jackson `ObjectMapper` 并根据提供的模式映射头部。

模式相当简单，可以包含前导通配符 (*)、尾随通配符或两者 (例如，*.cat.*)。您可以使用前导 ! 来否定模式。第一个匹配头部名称的模式（无论是正模式还是负模式）都会获胜。

当您提供自己的模式时，我们建议包含 !id 和 !timestamp，因为这些头部在入站方向是只读的。

默认情况下，映射器只反序列化 java.lang 和 java.util 中的类。您可以通过使用 addTrustedPackages 方法添加受信任的包来信任其他（或所有）包。如果您从不受信任的来源接收消息，您可能希望只添加您信任的那些包。要信任所有包，您可以使用 mapper.addTrustedPackages("*")。

以原始形式映射 String 头部值在与不知道映射器 JSON 格式的系统通信时很有用。

从版本 2.2.5 开始，您可以指定某些字符串值头部不应使用 JSON 映射，而是映射到/从原始 byte[]。AbstractKafkaHeaderMapper 有新的属性；mapAllStringsOut 当设置为 true 时，所有字符串值头部将使用 charset 属性（默认 UTF-8）转换为 byte[]。此外，还有一个属性 rawMappedHeaders，它是一个 header name : boolean 的映射；如果映射包含一个头部名称，并且头部包含一个 String 值，它将使用字符集作为原始 byte[] 映射。此映射还用于使用字符集将传入的原始 byte[] 头部映射到 String，当且仅当映射值中的布尔值为 true 时。如果布尔值为 false，或者头部名称不在映射中且没有 true 值，则传入的头部将简单地映射为原始未映射的头部。

以下测试用例说明了这种机制。

@Test
public void testSpecificStringConvert() {
    DefaultKafkaHeaderMapper mapper = new DefaultKafkaHeaderMapper();
    Map<String, Boolean> rawMappedHeaders = new HashMap<>();
    rawMappedHeaders.put("thisOnesAString", true);
    rawMappedHeaders.put("thisOnesBytes", false);
    mapper.setRawMappedHeaders(rawMappedHeaders);
    Map<String, Object> headersMap = new HashMap<>();
    headersMap.put("thisOnesAString", "thing1");
    headersMap.put("thisOnesBytes", "thing2");
    headersMap.put("alwaysRaw", "thing3".getBytes());
    MessageHeaders headers = new MessageHeaders(headersMap);
    Headers target = new RecordHeaders();
    mapper.fromHeaders(headers, target);
    assertThat(target).containsExactlyInAnyOrder(
            new RecordHeader("thisOnesAString", "thing1".getBytes()),
            new RecordHeader("thisOnesBytes", "thing2".getBytes()),
            new RecordHeader("alwaysRaw", "thing3".getBytes()));
    headersMap.clear();
    mapper.toHeaders(target, headersMap);
    assertThat(headersMap).contains(
            entry("thisOnesAString", "thing1"),
            entry("thisOnesBytes", "thing2".getBytes()),
            entry("alwaysRaw", "thing3".getBytes()));
}

默认情况下，两个头映射器都会映射所有传入的头。从 2.8.8 版本开始，模式也可以应用于传入映射。要创建用于传入映射的映射器，请使用相应映射器上的静态方法之一。

public static DefaultKafkaHeaderMapper forInboundOnlyWithMatchers(String... patterns) {
}

public static DefaultKafkaHeaderMapper forInboundOnlyWithMatchers(ObjectMapper objectMapper, String... patterns) {
}

public static SimpleKafkaHeaderMapper forInboundOnlyWithMatchers(String... patterns) {
}

例如

DefaultKafkaHeaderMapper inboundMapper = DefaultKafkaHeaderMapper.forInboundOnlyWithMatchers("!abc*", "*");

这将排除所有以 abc 开头的头，并包含所有其他头。

默认情况下，只要 Jackson 在类路径上，MessagingMessageConverter 和 BatchMessagingMessageConverter 就会使用 DefaultKafkaHeaderMapper。

使用批处理转换器，转换后的头将在 KafkaHeaders.BATCH_CONVERTED_HEADERS 中以 List<Map<String, Object>> 的形式提供，其中列表中某个位置的映射对应于有效负载中的数据位置。

如果没有转换器（要么是因为 Jackson 不存在，要么是因为它被显式设置为 null），则来自消费者记录的头将在 KafkaHeaders.NATIVE_HEADERS 头中以未转换的形式提供。此头是一个 Headers 对象（或在批处理转换器的情况下为 List<Headers>），其中列表中的位置对应于有效负载中的数据位置。

某些类型不适合 JSON 序列化，对于这些类型，可能更喜欢简单的 toString() 序列化。DefaultKafkaHeaderMapper 具有一个名为 addToStringClasses() 的方法，该方法允许您提供应该以这种方式处理的类的名称以进行出站映射。在传入映射期间，它们被映射为 String。默认情况下，只有 org.springframework.util.MimeType 和 org.springframework.http.MediaType 以这种方式映射。

从 2.3 版本开始，简化了对字符串值头的处理。默认情况下，此类头不再进行 JSON 编码（即，它们没有添加封闭的 "..."）。类型仍然添加到 JSON_TYPES 头中，以便接收系统可以从 byte[] 转换回字符串。映射器可以处理（解码）由旧版本生成的标题（它检查是否有前导 "）；这样，使用 2.3 的应用程序就可以使用来自旧版本的记录。

为了与早期版本兼容，如果使用 2.3 版本生成的记录可能被使用早期版本的应用程序使用，请将 encodeStrings 设置为 true。当所有应用程序都使用 2.3 或更高版本时，您可以将该属性保留为其默认值 false。

@Bean
MessagingMessageConverter converter() {
    MessagingMessageConverter converter = new MessagingMessageConverter();
    DefaultKafkaHeaderMapper mapper = new DefaultKafkaHeaderMapper();
    mapper.setEncodeStrings(true);
    converter.setHeaderMapper(mapper);
    return converter;
}

如果使用 Spring Boot，它会自动将此转换器 bean 配置到自动配置的 KafkaTemplate 中；否则，您应该将此转换器添加到模板中。