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

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

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

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

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

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

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

一、默认配置

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

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

例子

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

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

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

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

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

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

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

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

二、自定义ObjectMapper

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

1.应用程序属性

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

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

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

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

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

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

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

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

2.自定义 Jackson 模块

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

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

3.Jackson2ObjectMapperBuilderCustomizer

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

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

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

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

三、覆盖默认配置

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

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

1.ObjectMapper

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

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

2.Jackson2ObjectMapperBuilder

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

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

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

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

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

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

3.MappingJackson2HttpMessageConverter

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

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

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

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

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

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

标签:
  • 热门焦点
  • K60至尊版狂暴引擎2.0加持:超177万跑分斩获性能第一

    Redmi的后性能时代战略发布会今天下午如期举办,在本次发布会上,Redmi公布了多项关于和联发科的深度合作,以及新机K60 Ultra在软件和硬件方面的特性,例如:“K60 至尊版,双芯旗舰
  • 小米降噪蓝牙耳机Necklace分享:听一首歌 读懂一个故事

    在今天下午的小米Civi 2新品发布会上,小米还带来了一款新的降噪蓝牙耳机Necklace,我们也在发布结束的第一时间给大家带来这款耳机的简单分享。现在大家能见到最多的蓝牙耳机
  • 十个可以手动编写的 JavaScript 数组 API

    JavaScript 中有很多API,使用得当,会很方便,省力不少。 你知道它的原理吗? 今天这篇文章,我们将对它们进行一次小总结。现在开始吧。1.forEach()forEach()用于遍历数组接收一参
  • 线程通讯的三种方法!通俗易懂

    线程通信是指多个线程之间通过某种机制进行协调和交互,例如,线程等待和通知机制就是线程通讯的主要手段之一。 在 Java 中,线程等待和通知的实现手段有以下几种方式:Object 类下
  • 一篇聊聊Go错误封装机制

    %w 是用于错误包装(Error Wrapping)的格式化动词。它是用于 fmt.Errorf 和 fmt.Sprintf 函数中的一个特殊格式化动词,用于将一个错误(或其他可打印的值)包装在一个新的错误中。使
  • JavaScript学习 -AES加密算法

    引言在当今数字化时代,前端应用程序扮演着重要角色,用户的敏感数据经常在前端进行加密和解密操作。然而,这样的操作在网络传输和存储中可能会受到恶意攻击的威胁。为了确保数据
  • 签约井川里予、何丹彤,单视频点赞近千万,MCN黑马永恒文希快速崛起!

    来源:视听观察永恒文希传媒作为一家MCN公司,说起它的名字来,可能大家会觉得有点儿陌生,但是说出来下面一串的名字之后,或许大家就会感到震惊,原来这么多网红,都签约这家公司了。根
  • AI芯片初创公司Tenstorrent获三星和现代1亿美元投资

    Tenstorrent是一家由芯片行业资深人士Jim Keller领导的加拿大初创公司,专注于开发人工智能芯片,该公司周三表示,已经从现代汽车集团和三星投资基金等
  • 机构称Q2全球智能手机出货量同比下滑11% 苹果份额依旧第2

    7月20日消息,据外媒报道,研究机构的报告显示,由于需求下滑,今年二季度全球智能手机的出货量,同比下滑了11%,三星、苹果等主要厂商的销量,较去年同期均有下
Top