跳到主要内容
版本:2.0.7

自定义 Object Mapper

Doubao 中英对照 Custom Object Mapper

Pulsar 在对 JSON 消息进行反序列化/序列化时使用内部 shaded 的 Jackson ObjectMapper。如果你希望改为提供自己的 Jackson 2 object mapper 实例,可以注册一个 SchemaResolverCustomizer 并按如下方式在 DefaultSchemaResolver 上设置你的 mapper:

@Bean
SchemaResolverCustomizer<DefaultSchemaResolver> schemaResolverCustomizer() {
return (DefaultSchemaResolver schemaResolver) -> {
var myObjectMapper = obtainMyObjectMapper();
schemaResolver.setObjectMapper(myObjectMapper);
};
}
important

上述示例中的 object mapper 应为 com.fasterxml.jackson.databind.ObjectMapper 的实例,而不是 shaded 的 org.apache.pulsar.shade.com.fasterxml.jackson.databind.ObjectMapper。

这样一来,你的 object mapper 就会用于对所有经过 schema 解析过程的 JSON 消息进行反序列化/序列化(即在生产/消费消息时未直接传入 schema 的情况)。

在底层,解析器会创建一个特殊的 JSON schema,该 schema 利用自定义 mapper,并作为所有已解析 JSON 消息的 schema。

如果你需要直接传入 schema 实例,可以使用 JSONSchemaUtil 来创建遵循自定义 mapper 的 schema。以下示例展示了在使用 PulsarTemplate 中接受 schema 参数的变体发送消息时如何这样做:

void sendMessage(PulsarTemplate<MyPojo> template, MyPojo toSend) {
var myObjectMapper = obtainMyObjectMapper();
var schema = JSONSchemaUtil.schemaForTypeWithObjectMapper(MyPojo.class, myObjectMapper);
template.send(toSend, schema);
}
警告

Pulsar 以特定方式配置其默认 object mapper。除非你有特别理由不这样做,强烈建议你使用与以下相同的选项来配置你的 mapper:

myObjectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
myObjectMapper.configure(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL, false);
myObjectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
备注

框架后续版本可能会改为提供一个作用于默认 mapper 的定制器,而不再要求单独的实例。

Jackson 2 / Jackson 3​

在 Spring Boot 4 中,Jackson 的默认版本为 3,并通过 spring-boot-starter-json 模块自动配置。然而,Spring for Apache Pulsar 期望使用 Jackson 2 自定义 mapper。

如果你在 Spring Boot 4 应用程序中使用 Jackson 3,并希望使用自定义 mapper,则需要将 Jackson 2 添加到 classpath。别担心,Spring Boot 4 允许 Jackson 2 和 3 在一个应用程序中共存。

备注

框架后续版本可能支持使用 Jackson 2 或 Jackson 3 自定义 mapper。