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

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

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

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

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

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

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

一、默认配置

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

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

例子

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

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

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

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

我们还将定义一个简单的 REST 控制器来演示序列化:CqL28资讯网——每日最新资讯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 时的响应:CqL28资讯网——每日最新资讯28at.com

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

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

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

二、自定义ObjectMapper

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

1.应用程序属性

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

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

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

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

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

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

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

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

2.自定义 Jackson 模块

为了实现我们的目标,我们将使用我们的自定义日期格式注册一个新的 JavaTimeModule :CqL28资讯网——每日最新资讯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 。这是我们的最终结果:CqL28资讯网——每日最新资讯28at.com

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

3.Jackson2ObjectMapperBuilderCustomizer

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

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

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

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

三、覆盖默认配置

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

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

1.ObjectMapper

覆盖默认配置的最简单方法是定义一个ObjectMapper bean 并将其标记为 @Primary:CqL28资讯网——每日最新资讯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);}

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

2.Jackson2ObjectMapperBuilder

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

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

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

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

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

根据Jackson2ObjectMapperBuilder文档,如果它们存在于类路径中,它还将注册一些模块:CqL28资讯网——每日最新资讯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。CqL28资讯网——每日最新资讯28at.com

3.MappingJackson2HttpMessageConverter

我们可以定义一个MappingJackson2HttpMessageConverter 类型的 bean ,Spring Boot 会自动使用它:CqL28资讯网——每日最新资讯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 序列化选项的几种方法。CqL28资讯网——每日最新资讯28at.com

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

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

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

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

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

标签:
  • 热门焦点
  • 官方承诺:K60至尊版将会首批升级MIUI 15

    全新的MIUI 15今天也有了消息,在官宣了K60至尊版将会搭载天玑9200+处理器和独显芯片X7的同时,Redmi给出了官方承诺,K60至尊重大更新首批升级,会首批推送MIUI 15。也就是说虽然
  • Mate60手机壳曝光 致敬自己的经典设计

    8月3日消息,今天下午博主数码闲聊站带来了华为Mate60的第三方手机壳图,可以让我们在真机发布之前看看这款华为全新旗舰的大致轮廓。从曝光的图片看,Mate 60背后摄像头面积依然
  • 6月安卓手机好评榜:魅族20 Pro蝉联冠军

    性能榜和性价比榜之后,我们来看最后的安卓手机好评榜,数据来源安兔兔评测,收集时间2023年6月1日至6月30日,仅限国内市场。第一名:魅族20 Pro好评率:95%5月份的时候魅族20 Pro就是
  • Raft算法:保障分布式系统共识的稳健之道

    1. 什么是Raft算法?Raft 是英文”Reliable、Replicated、Redundant、And Fault-Tolerant”(“可靠、可复制、可冗余、可容错”)的首字母缩写。Raft算法是一种用于在分布式系统
  • 2023 年的 Node.js 生态系统

    随着技术的不断演进和创新,Node.js 在 2023 年达到了一个新的高度。Node.js 拥有一个庞大的生态系统,可以帮助开发人员更快地实现复杂的应用。本文就来看看 Node.js 最新的生
  • CSS单标签实现转转logo

    转转品牌升级后更新了全新的Logo,今天我们用纯CSS来实现转转的新Logo,为了有一定的挑战性,这里我们只使用一个标签实现,将最大化的使用CSS能力完成Logo的绘制与动画效果。新logo
  • 让我们一起聊聊文件的操作

    文件【1】文件是什么?文件是保存数据的地方,是数据源的一种,比如大家经常使用的word文档、txt文件、excel文件、jpg文件...都是文件。文件最主要的作用就是保存数据,它既可以保
  • 如何通过Python线程池实现异步编程?

    线程池的概念和基本原理线程池是一种并发处理机制,它可以在程序启动时创建一组线程,并将它们置于等待任务的状态。当任务到达时,线程池中的某个线程会被唤醒并执行任务,执行完任
  • 英特尔Xe-HP项目终止,将专注Xe-HPC/HPG系列显卡

    据10 月 31 日消息报道,英特尔高级副总裁兼加速计算系统和图形事业部总经理 表示,Xe-HP“ Arctic Sound” 系列服务器 GPU 已经应用于 oneAPI devcloud 云服
Top