当前位置:首页 > 科技  > 软件

SpringBoot中如何优雅地个性化定制Jackson

来源: 责编: 时间:2023-12-20 17:46:56 326观看
导读哈喽,大家好,我是了不起。当使用 JSON 格式时,Spring Boot 将使用ObjectMapper实例来序列化响应和反序列化请求。在本教程中,我们将了解配置序列化和反序列化选项的最常用方法。一、默认配置默认情况下,Spring Boot 配置将

哈喽,大家好,我是了不起。JSx28资讯网——每日最新资讯28at.com

当使用 JSON 格式时,Spring Boot 将使用ObjectMapper实例来序列化响应和反序列化请求。JSx28资讯网——每日最新资讯28at.com

在本教程中,我们将了解配置序列化和反序列化选项的最常用方法。JSx28资讯网——每日最新资讯28at.com

JSx28资讯网——每日最新资讯28at.com

一、默认配置

默认情况下,Spring Boot 配置将禁用以下功能:JSx28资讯网——每日最新资讯28at.com

  • MapperFeature.DEFAULT_VIEW_INCLUSION
  • DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
  • SerializationFeature.WRITE_DATES_AS_TIMESTAMPS

例子

让我们从一个简单的例子开始:JSx28资讯网——每日最新资讯28at.com

  • 客户端将向我们的/boy?name=gotanks发送一个 GET 请求。
  • 控制器将返回一个新的Boy对象。
  • Spring 将使用 ObjectMapper 将我们的 POJO 序列化为 JSON。

我们将通过使用 String 和 LocalDateTime 对象来举例说明自定义选项:JSx28资讯网——每日最新资讯28at.com

@Datapublic class Boy {    private String name;    private Integer age;    private LocalDateTime birth;}

我们还将定义一个简单的 REST 控制器来演示序列化:JSx28资讯网——每日最新资讯28at.com

@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 时的响应:JSx28资讯网——每日最新资讯28at.com

{  "name": "gotanks",  "age": null,  "date": "2023-12-19T10:21:35.974"}

我们希望排除空值并使用自定义日期格式 yyyy-MM-dd HH:mm:ss。这是我们的最终回应:JSx28资讯网——每日最新资讯28at.com

{  "name": "gotanks",  "date": "2023-12-19 10:21:35"}

二、自定义ObjectMapper

下面,我们将了解如何自定义 Spring Boot 使用的默认ObjectMapper。JSx28资讯网——每日最新资讯28at.com

1.应用程序属性

配置映射器的最简单方法是通过 application.propertiesJSx28资讯网——每日最新资讯28at.com

这是配置的一般结构:JSx28资讯网——每日最新资讯28at.com

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

例如,我们将添加以下内容以禁用 SerializationFeature.WRITE_DATES_AS_TIMESTAMPS:JSx28资讯网——每日最新资讯28at.com

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

除了提到的特征类别,我们还可以配置属性包含:JSx28资讯网——每日最新资讯28at.com

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

配置环境变量是最简单的方法。这种方法的缺点是我们无法自定义高级选项,例如为LocalDateTime自定义日期格式。JSx28资讯网——每日最新资讯28at.com

2.自定义 Jackson 模块

为了实现我们的目标,我们将使用我们的自定义日期格式注册一个新的 JavaTimeModule :JSx28资讯网——每日最新资讯28at.com

@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 。这是我们的最终结果:JSx28资讯网——每日最新资讯28at.com

{  "name": "gotanks",  "age": null,  "date": "2023-12-19 10:21:35"}

3.Jackson2ObjectMapperBuilderCustomizer

这个函数接口的目的是允许我们创建配置bean。JSx28资讯网——每日最新资讯28at.com

它们将被应用到通过 Jackson2ObjectMapperBuilder 创建的默认 ObjectMapper:JSx28资讯网——每日最新资讯28at.com

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

配置bean以特定的顺序应用,我们可以使用 @Order 注解控制该顺序。如果我们想从不同的配置或模块配置ObjectMapper,那么这种优雅的方法非常适合。JSx28资讯网——每日最新资讯28at.com

三、覆盖默认配置

如果我们想完全控制配置,有几个选项可以禁用自动配置并只允许应用我们的自定义配置。JSx28资讯网——每日最新资讯28at.com

让我们仔细看看这些选项。JSx28资讯网——每日最新资讯28at.com

1.ObjectMapper

覆盖默认配置的最简单方法是定义一个ObjectMapper bean 并将其标记为 @Primary:JSx28资讯网——每日最新资讯28at.com

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

当我们想要完全控制序列化过程并且不想允许外部配置时,我们应该使用这种方法。JSx28资讯网——每日最新资讯28at.com

2.Jackson2ObjectMapperBuilder

另一种干净的方法是定义一个Jackson2ObjectMapperBuilder bean 。JSx28资讯网——每日最新资讯28at.com

Spring Boot 实际上在构建ObjectMapper时默认使用这个构建器,并且会自动选择定义的那个:JSx28资讯网——每日最新资讯28at.com

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

它会默认配置两个选项:JSx28资讯网——每日最新资讯28at.com

  • 禁用 MapperFeature.DEFAULT_VIEW_INCLUSION
  • 禁用 DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES

根据Jackson2ObjectMapperBuilder文档,如果它们存在于类路径中,它还将注册一些模块:JSx28资讯网——每日最新资讯28at.com

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

这种方法的优点是 Jackson2ObjectMapperBuilder 提供了一种简单直观的方式来构建 ObjectMapper。JSx28资讯网——每日最新资讯28at.com

3.MappingJackson2HttpMessageConverter

我们可以定义一个MappingJackson2HttpMessageConverter 类型的 bean ,Spring Boot 会自动使用它:JSx28资讯网——每日最新资讯28at.com

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

四、总结

在本文中,我们了解了在使用 SpringBoot 时配置 JSON 序列化选项的几种方法。JSx28资讯网——每日最新资讯28at.com

我们看到了两种不同的方法:配置默认选项或覆盖默认配置。JSx28资讯网——每日最新资讯28at.com

本文链接:http://www.28at.com/showinfo-26-50760-0.htmlSpringBoot中如何优雅地个性化定制Jackson

声明:本网页内容旨在传播知识,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。邮件:2376512515@qq.com

上一篇: 面试官:什么是虚拟线程?为什么要有虚拟线程?

下一篇: Linux从外到内剥开动态库,一个简单例子看懂Linux下的动态库开发原理

标签:
  • 热门焦点
  • Find N3入网:最高支持16+1TB

    OPPO将于近期登场的Find N3折叠屏目前已经正式入网,型号为PHN110。本次Find N3在外观方面相比前两代有很大的变化,不再是小号的横向折叠屏,而是跟别的厂商一样采用了较为常见的
  • 2023年Q2用户偏好榜:12+256G版本成新主流

    3月份的性能榜、性价比榜和好评榜之后,就要轮到2023年的第二季度偏好榜了,上半年的新机潮已经过去,最明显的肯定就是大内存和存储的机型了,另外部分中端机也取消了屏幕塑料支架
  • 28个SpringBoot项目中常用注解,日常开发、求职面试不再懵圈

    前言在使用SpringBoot开发中或者在求职面试中都会使用到很多注解或者问到注解相关的知识。本文主要对一些常用的注解进行了总结,同时也会举出具体例子,供大家学习和参考。注解
  • Rust中的高吞吐量流处理

    作者 | Noz编译 | 王瑞平本篇文章主要介绍了Rust中流处理的概念、方法和优化。作者不仅介绍了流处理的基本概念以及Rust中常用的流处理库,还使用这些库实现了一个流处理程序
  • JavaScript学习 -AES加密算法

    引言在当今数字化时代,前端应用程序扮演着重要角色,用户的敏感数据经常在前端进行加密和解密操作。然而,这样的操作在网络传输和存储中可能会受到恶意攻击的威胁。为了确保数据
  • 零售大模型“干中学”,攀爬数字化珠峰

    文/侯煜编辑/cc来源/华尔街科技眼对于绝大多数登山爱好者而言,攀爬珠穆朗玛峰可谓终极目标。攀登珠峰的商业路线有两条,一是尼泊尔境内的南坡路线,一是中国境内的北坡路线。相
  • 携众多高端产品亮相ChinaJoy,小米带来一场科技与人文的视听盛宴

    7月28日,全球数字娱乐领域最具知名度与影响力的年度盛会中国国际数码互动娱乐展览会(简称ChinaJoy)在上海新国际博览中心盛大开幕。作为全球领先的科
  • 机构称Q2国内智能手机销量同比下滑4% vivo份额重回第1

    7月29日消息,根据市场调查机构Counterpoint Research公布的最新报告,2023年第2季度中国智能手机销量同比下降4%,创新自2014年以来第2季度销量新低。报
  • 由于成本持续增加,笔记本产品价格预计将明显上涨

    根据知情人士透露,由于材料、物流等成本持续增加,笔记本产品价格预计将在2021年下半年有明显上涨。进入6月下旬以来,全球半导体芯片缺货情况加剧,显卡、处理器
Top