哈喽,大家好,我是了不起。
当使用 JSON 格式时,Spring Boot 将使用ObjectMapper实例来序列化响应和反序列化请求。
在本教程中,我们将了解配置序列化和反序列化选项的最常用方法。
默认情况下,Spring Boot 配置将禁用以下功能:
让我们从一个简单的例子开始:
我们将通过使用 String 和 LocalDateTime 对象来举例说明自定义选项:
@Datapublic class Boy { private String name; private Integer age; private LocalDateTime birth;}
我们还将定义一个简单的 REST 控制器来演示序列化:
@GetMapping("/boy")public Boy getBoy( @RequestParam(required = false) Integer age, @RequestParam(required = false) String name) { return new Boy() .setAge(age) .setDate(LocalDateTime.now()) .setName(name);}
默认情况下,这将是调用 GET http://localhost:8080/boy?name=gotanks 时的响应:
{ "name": "gotanks", "age": null, "date": "2023-12-19T10:21:35.974"}
我们希望排除空值并使用自定义日期格式 yyyy-MM-dd HH:mm:ss。这是我们的最终回应:
{ "name": "gotanks", "date": "2023-12-19 10:21:35"}
下面,我们将了解如何自定义 Spring Boot 使用的默认ObjectMapper。
配置映射器的最简单方法是通过 application.properties
这是配置的一般结构:
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自定义日期格式。
为了实现我们的目标,我们将使用我们的自定义日期格式注册一个新的 JavaTimeModule :
@Configurationpublic class JacksonConfig { @Bean public Module javaTimeModule() { JavaTimeModule module = new JavaTimeModule(); module.addSerializer(LOCAL_DATETIME_SERIALIZER); return module; }}
SpringBoot 将自动注册com.fasterxml.jackson.databind.Module类型的任何 bean 。这是我们的最终结果:
{ "name": "gotanks", "age": null, "date": "2023-12-19 10:21:35"}
这个函数接口的目的是允许我们创建配置bean。
它们将被应用到通过 Jackson2ObjectMapperBuilder 创建的默认 ObjectMapper:
@Beanpublic Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() { return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL) .serializers(LOCAL_DATETIME_SERIALIZER);}
配置bean以特定的顺序应用,我们可以使用 @Order 注解控制该顺序。如果我们想从不同的配置或模块配置ObjectMapper,那么这种优雅的方法非常适合。
如果我们想完全控制配置,有几个选项可以禁用自动配置并只允许应用我们的自定义配置。
让我们仔细看看这些选项。
覆盖默认配置的最简单方法是定义一个ObjectMapper bean 并将其标记为 @Primary:
@Bean@Primarypublic ObjectMapper objectMapper() { JavaTimeModule module = new JavaTimeModule(); module.addSerializer(LOCAL_DATETIME_SERIALIZER); return new ObjectMapper() .setSerializationInclusion(JsonInclude.Include.NON_NULL) .registerModule(module);}
当我们想要完全控制序列化过程并且不想允许外部配置时,我们应该使用这种方法。
另一种干净的方法是定义一个Jackson2ObjectMapperBuilder bean 。
Spring Boot 实际上在构建ObjectMapper时默认使用这个构建器,并且会自动选择定义的那个:
@Beanpublic Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder() { return new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER) .serializationInclusion(JsonInclude.Include.NON_NULL);}
它会默认配置两个选项:
根据Jackson2ObjectMapperBuilder文档,如果它们存在于类路径中,它还将注册一些模块:
这种方法的优点是 Jackson2ObjectMapperBuilder 提供了一种简单直观的方式来构建 ObjectMapper。
我们可以定义一个MappingJackson2HttpMessageConverter 类型的 bean ,Spring Boot 会自动使用它:
@Beanpublic MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() { Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER) .serializationInclusion(JsonInclude.Include.NON_NULL); return new MappingJackson2HttpMessageConverter(builder.build());}
在本文中,我们了解了在使用 SpringBoot 时配置 JSON 序列化选项的几种方法。
我们看到了两种不同的方法:配置默认选项或覆盖默认配置。
本文链接:http://www.28at.com/showinfo-26-50760-0.htmlSpringBoot中如何优雅地个性化定制Jackson
声明:本网页内容旨在传播知识,不代表本站观点,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。