Spring Boot:自定义Jackson ObjectMapper

墨蓝 2023-01-13 05:41 214阅读 0赞

# 1.概述 #

当使用JSON格式时，Spring Boot将使用ObjectMapper实例来序列化响应并反序列化请求。

# 2.默认配置 #

默认情况下，Spring Boot配置将：

*  禁用 MapperFeature.DEFAULT\_VIEW\_INCLUSION
 *  禁用 DeserializationFeature.FAIL\_ON\_UNKNOWN\_PROPERTIES(默认情况下启用此功能（这意味着如果遇到未知属性，将抛出JsonMappingException)
 *  禁用 SerializationFeature.WRITE\_DATES\_AS\_TIMESTAMPS(默认情况下启用此功能，因此默认情况下日期/时间被序列化为时间戳。)

从一个简单的例子开始：

客户将向/coffee?name = Lavazza发送一个GET请求。  
控制器将返回一个新的Coffee对象  
Spring将使用ObjectMapper将POJO序列化为JSON

> 使用String和LocalDateTime对象举例说明自定义选项：

@Data
    public class Coffee { 
    
        private String name;
        private String brand;
        private LocalDateTime date;
    }

controller代码如下：

@GetMapping("/coffee")
        public Coffee getCoffee(
                @RequestParam(required = false) String brand,
                @RequestParam(required = false) String name) { 
            Coffee coffee = new Coffee();
            coffee.setBrand(brand);
            coffee.setDate(LocalDateTime.now());
            coffee.setName(name);
            return coffee;
        }

默认情况下，调用GET http://localhost:19999/coffee?brand=Lavazza时的响应为：

{ 
        "name": null,
        "brand": "Lavazza",
        "date": "2021-04-14T19:32:54.851"
    }

想排除空值，并采用自定义日期格式（yyyy-MM-dd HH:mm）。 最终将是：

{ 
      "brand": "Lavazza",
      "date": "2021-04-14"
    }

使用Spring Boot时，可以选择自定义默认的ObjectMapper或覆盖它。 下一部分中介绍这两个选项。

# 3.自定义默认的ObjectMapper #

接下来将看到,如何自定义Spring Boot使用的默认ObjectMapper。

## 3.1应用程序属性和自定义Jackson模块 ##

\*\*配置映射器的最简单方法是通过应用程序属性。\*\*配置的一般结构为：

spring.jackson.<category_name>.<feature_name>=true,false

例如，如果要禁用SerializationFeature.WRITE\_DATES\_AS\_TIMESTAMPS，将添加：

spring.jackson.serialization.write-dates-as-timestamps=false

除了上述功能类别，还可以配置属性包含：

spring.jackson.default-property-inclusion=always, non_null, non_absent, non_default, non_empty

配置环境变量是最简单的方法。 这种方法的缺点是无法自定义高级选项，例如为LocalDateTime自定义日期格式。 此时，将获得结果：

{ 
      "brand": "Lavazza",
       "date": "2021-04-14T19:32:54.851"
    }

为了实现目标，将使用自定义日期格式注册一个新的JavaTimeModule：

@Configuration
    public class CoffeeRegisterModuleConfig { 
    
        public static final String DATETIME_FORMAT = "yyyy-MM-dd HH:mm";
        public static LocalDateTimeSerializer LOCAL_DATETIME_SERIALIZER = new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DATETIME_FORMAT));
        @Bean
        public Module javaTimeModule() { 
            JavaTimeModule module = new JavaTimeModule();
            module.addSerializer(LOCAL_DATETIME_SERIALIZER);
            return module;
        }
    }

另外，配置属性文件application.properties将包含：

spring.jackson.default-property-inclusion=non_null

Spring Boot将自动注册任何类型为com.fasterxml.jackson.databind.Module的bean。 最终结果将是：

{ 
        "brand": "Lavazza",
        "date": "2021-04-14 19:55"
    }

## 3.2Jackson2ObjectMapperBuilderCustomizer ##

该功能接口的目的是允许我们创建配置Bean。 它们将应用于通过Jackson2ObjectMapperBuilder创建的默认ObjectMapper：

@Bean
        public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() { 
            return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL)
                    .serializers(LOCAL_DATETIME_SERIALIZER);
        }

配置bean是按特定顺序应用的，可以使用@Order注解进行控制。 如果要从不同的配置或模块配置ObjectMapper，则这种优雅的方法非常适合。

# 4.重写默认配置 #

如果想完全控制配置，则有几个选项将禁用自动配置并仅允许应用的自定义配置。

## 4.1. ObjectMapper ##

重写默认配置的最简单方法是定义一个ObjectMapper bean并将其标记为@Primary：

@Bean
    @Primary
    public ObjectMapper objectMapper() { 
        JavaTimeModule module = new JavaTimeModule();
        module.addSerializer(LOCAL_DATETIME_SERIALIZER);
        return new ObjectMapper()
          .setSerializationInclusion(JsonInclude.Include.NON_NULL)
          .registerModule(module);
    }

当想完全控制序列化过程并且不想允许外部配置时，应该使用这种方法。

## 4.2. Jackson2ObjectMapperBuilder ##

@Bean
    public Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder() { 
        return new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER)
          .serializationInclusion(JsonInclude.Include.NON_NULL);
    }

默认情况下，它将配置两个选项：

*  禁用 *MapperFeature.DEFAULT\_VIEW\_INCLUSION*
 *  禁用 *DeserializationFeature.FAIL\_ON\_UNKNOWN\_PROPERTIES*

根据Jackson2ObjectMapperBuilder文档，如果类路径中存在某些模块，它还将注册一些模块：

*  jackson-datatype-jdk8：支持其他Java 8类型，例如Optional
 *  jackson-datatype-jsr310：支持Java 8日期和时间API类型
 *  jackson-datatype-joda：支持Joda-Time类型
 *  jackson-module-kotlin：支持Kotlin类和数据类

这种方法的优点是Jackson2ObjectMapperBuilder提供了一种简单直观的方法来构建ObjectMapper。

## 4.3. MappingJackson2HttpMessageConverter ##

可以定义一个类型为MappingJackson2HttpMessageConverter的bean，Spring Boot会自动使用它：

@Bean
    public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() { 
        Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER)
          .serializationInclusion(JsonInclude.Include.NON_NULL);
        return new MappingJackson2HttpMessageConverter(builder.build());
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25pdWdhbmcwOTIw_size_16_color_FFFFFF_t_70]: /images/20221022/81b64912d8bf4e86896c062111113c4a.png