如何在 Spring Boot 1.4 中自定义 Jackson

Question

我一直无法找到如何在 spring boot 1.4 中使用 Jackson2ObjectMapperBuilderCustomizer.java 来自定义 Jackson 的功能的示例。

在 boot 1.4 中自定义 Jackson 的文档 - https://docs.spring.io/spring-boot/docs/1.4.x/reference/htmlsingle/#howto-customize-the-jackson-objectmapper

我的配置有效，但我不确定这是否是使用 Jackson2ObjectMapperBuilderCustomizer.java

自定义对象映射器的正确方法

@Configuration
public class JacksonAutoConfiguration {

    @Autowired
    private Environment env;

    @Bean
    public Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder(
        List<Jackson2ObjectMapperBuilderCustomizer> customizers) {
        Jackson2ObjectMapperBuilder builder = configureObjectMapper();
        customize(builder, customizers);
        return builder;
    }

    private void customize(Jackson2ObjectMapperBuilder builder,
                           List<Jackson2ObjectMapperBuilderCustomizer> customizers) {
        for (Jackson2ObjectMapperBuilderCustomizer customizer : customizers) {
            customizer.customize(builder);
        }
    }

    private Jackson2ObjectMapperBuilder configureObjectMapper() {
        Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
        List<String> activeProfiles = asList(env.getActiveProfiles());
        if (activeProfiles.contains(SPRING_PROFILE_DEVELOPMENT)) {
            builder.featuresToEnable(SerializationFeature.INDENT_OUTPUT);
        }
        return builder;
    }
}

为了提供一些上下文，这个类位于我自己的 REST 服务 spring 启动项目中，它只是自动配置一些东西，比如 ControllerAdvice 和一些像上面这样的琐碎功能。

所以我的目标是扩展 Jackson 配置，而不是覆盖 boot 或其他包提供的任何配置。

Answer 1

要自定义 Spring Boot 已经预配置的 Jackson ObjectMapper，我能够做到这一点（这里的示例是添加自定义反序列化器）。

配置类：

@SpringBootConfiguration
public class Application {

    @Autowired
    private BigDecimalDeserializer bigDecimalDeserializer;

    ...

    @Bean
    public Jackson2ObjectMapperBuilderCustomizer addCustomBigDecimalDeserialization() {
        return new Jackson2ObjectMapperBuilderCustomizer() {

            @Override
            public void customize(Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder) {
                jacksonObjectMapperBuilder.deserializerByType(BigDecimal.class, bigDecimalDeserializer);
            }

        };
    }

    ...

}

还有我的自定义反序列化器，以展示 Spring 是如何拾取它的：

@Component
public class BigDecimalDeserializer extends StdDeserializer<BigDecimal> {

    public BigDecimalDeserializer() {
        super(BigDecimal.class);
    }

    @Override
    public BigDecimal deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        ...
    }

    ...

}

Answer 2

这取决于你想要做什么。

如果除了默认执行的自定义之外，您还想进行一些自定义，那么您应该创建自己的 Jackson2ObjectMapperBuilderCustomizer 实现并将其公开为 bean。您目前拥有的是一个更复杂的版本。与其注入定制器然后自己调用它们，不如创建自己的定制器 bean，Boot 会为您调用它。

如果您想完全控制并关闭所有 Boot 的自定义设置，请创建一个 Jackson2ObjectMapperBuilder 或 ObjectMapper bean 并根据需要进行配置。构建器方法是首选，因为此构建器还用于配置由其他组件（如 Spring Data REST）创建的 ObjectMapper。

查看您的代码并退后一步，您可以通过使用特定于配置文件的配置文件（例如 application-dev.properties）来启用 Jackson 输出的缩进，从而更简单地进行配置。您可以阅读更多关于 here 的信息。

Answer 3

只需创建一个ObjectMapper bean：

@Bean
ObjectMapper objectMapper() {
    return Jackson2ObjectMapperBuilder
            .json()
            .featuresToEnable(MapperFeature.DEFAULT_VIEW_INCLUSION)
            .build();
}