在SpringBootWeb项目中,当接收和返回JSON格式的数据时,SpringBoot默认使用一个ObjectMapper实例来序列化响应和反序列化请求。在本文中,我们将了解配置序列化和反序列化选项的最常用方法。默认配置SpringBoot的配置默认会禁用以下配置项。MapperFeature.DEFAULT_VIEW_INCLUSIONDeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIESSerializationFeature.WRITE_DATES_AS_TIMESTAMPS。例如,客户端将向我们的/coffee?name=Javazzz发送GET请求。控制器将返回一个新的Coffee对象。Spring将使用ObjectMapper将我们的POJO序列化为JSON。我们将通过使用String和LocalDateTime对象来演示自定义选项。公共类咖啡{私有字符串名称;私人字符串品牌;私有LocalDateTime日期;//getterandsetter}我们还将定义一个简单的REST控制器来演示序列化。@GetMapping("/coffee")publicCoffeegetCoffee(@RequestParam(required=false)Stringbrand,@RequestParam(required=false)Stringname){returnnewCoffee().setBrand(brand).setDate(FIXED_DATE).setName复制代码(name);}默认情况下,这将是调用GEThttp://lolcahost:8080/coffee?brand=javazzz时的响应。{"name":null,"brand":"javazzz","date":"2022-06-16T10:21:35.974"}我们要排除空值并有一个自定义的日期格式(dd-MM-yyyyHH:mm)。这是我们的响应结果。{"brand":"javazzz","date":"06-11-202210:34"}在使用SpringBoot时,我们可以选择自定义默认的ObjectMapper或覆盖它。我们将在下一章介绍这两种选择。自定义默认ObjectMapper在本节中,我们将看到如何自定义SpringBoot使用的默认ObjectMapper。1.应用程序属性和自定义Jackson模块配置映射器的最简单方法是通过应用程序属性。下面是配置的一般结构。spring.jackson..=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":"javazzz","date":"2022-06-16T10:35:34.593"}为了实现我们的目标,我们将使用自定义日期格式注册一个新的JavaTimeModule。@Configuration@PropertySource("classpath:coffee.properties")publicclassCoffeeRegisterModuleConfig{@BeanpublicModulejavaTimeModule(){JavaTimeModulemodule=newJavaTimeModule();module.addSerializer(LOCAL_DATETIME_SERIALIZER);返回模块;coffee.properties将包含以下内容。spring.jackson.default-property-inclusion=non_nullSpringBoot会自动注册com.fastxml.jackson.databind.Module类型的任何bean。下面是我们的最终结果。{"brand":"Javazzz","date":"16-06-202210:43"}2.Jackson2ObjectMapperBuilderCustomizer功能接口的目的是允许我们创建配置。它们将应用于通过Jackson2ObjectMapperBuilder创建的默认ObjectMapper。@BeanpublicJackson2ObjectMapperBuilderCustomizerjsonCustomizer(){returnbuilder->builder.serializationInclusion(JsonInclude.Include.NON_NULL).serializers(LOCAL_DATETIME_SERIALIZER);}配置按照特定顺序应用,我们可以使用@Order注解来控制。如果我们想从不同的配置或模块配置ObjectMapper,这种优雅的方法是合适的。覆盖默认配置如果我们想完全控制配置,有几个选项可以禁用自动配置,只允许应用我们的自定义配置。让我们仔细看看这些选项。1.ObjectMapper覆盖默认配置最简单的方法是定义一个ObjectMapperBean,并标记为@Primary。@Bean@PrimarypublicObjectMapperobjectMapper(){JavaTimeModule模块=newJavaTimeModule();module.addSerializer(LOCAL_DATETIME_SERIALIZER);returnnewObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL).register(module)当我们想要完全控制时我们应该在序列化进程时使用这种方法并且不想允许外部配置。2.Jackson2ObjectMapperBuilder的另一个干净的方法是定义一个Jackson2ObjectMapperBuilderbean。事实上,SpringBoot在构建ObjectMapper时默认使用这个构建器,并且会自动拾取定义的构建器。@BeanpublicJackson2ObjectMapperBuilderjackson2ObjectMapperBuilder(){returnnewJackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER).serializationInclusion(JsonInclude.Include.NON_NULL);}它会默认配置两个选项。禁用MapperFeature.DEFAULT_VIEW_INCLUSION禁用DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES。根据Jackson2ObjectMapperBuilder文档,如果类路径上有一些模块,它也会注册这些模块。jackson-datatype-jdk8:支持其他Java8类型,例如Optionaljackson-datatype-jsr310:支持Java8DateandTimeAPI类型jackson-datatype-joda:支持Joda-Time类型jackson-module-kotlin:支持Kotlin类和数据classes这种方法的优点是Jackson2ObjectMapperBuilder提供了一种简单直观的方法来构建ObjectMapper。3、MappingJackson2HttpMessageConverter的方法我们可以直接定义一个MappingJackson2HttpMessageConverter类型的bean,SpringBoot会自动使用它。@BeanpublicMappingJackson2HttpMessageConvertermappingJackson2HttpMessageConverter(){Jackson2ObjectMapperBuilderbuilder=newJackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER).serializationInclusion(JsonInclude.Include.NON_NULL);returnnewMappingJackson2HttpMessageConverter(builder.build());}测试配置为了测试我们的配置,我们将使用TestRestTemplate并将对象序列化为String。这样我们就可以验证我们的Coffee对象在序列化时没有空值,并且有自定义的日期格式。@TestpublicvoidwhenGetCoffee_thenSerializedWithDateAndNonNull(){StringformattedDate=DateTimeFormatter.ofPattern(CoffeeConstants.dateTimeFormat).format(FIXED_DATE);字符串品牌=“Javazza”;字符串url="/coffee?brand="+品牌;Stringresponse=ForstObjectrestTemplate.get(url,String.class);assertThat(response).isEqualTo("{\"brand\":\""+brand+"\",\"date\":\""+formattedDate+"\"}");}摘要在这篇文章中,我们研究了使用SpringBoot时配置JSON序列化选项的几种方法。我们看到两种不同的方法:配置默认选项或覆盖默认配置。