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

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

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

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

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

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

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

一、默认配置

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

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

例子

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

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

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

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

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

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

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

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

二、自定义ObjectMapper

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

1.应用程序属性

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

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

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

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

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

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

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

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

2.自定义 Jackson 模块

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

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

3.Jackson2ObjectMapperBuilderCustomizer

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

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

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

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

三、覆盖默认配置

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

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

1.ObjectMapper

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

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

2.Jackson2ObjectMapperBuilder

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

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

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

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

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

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

3.MappingJackson2HttpMessageConverter

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

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

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

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

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

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

标签:
  • 热门焦点
  • 一加Ace2 Pro官宣:普及16G内存 引领24G

    一加官方今天继续为本月发布的新机一加Ace2 Pro带来预热,公布了内存方面的信息。“淘汰 8GB ,12GB 起步,16GB 普及,24GB 引领,还有呢?#一加Ace2Pro#,2023 年 8 月,敬请期待。”同时
  • 红魔电竞平板评测:大屏幕硬实力

    前言:三年的疫情因为要上网课的原因激活了平板市场,如今网课的时代已经过去,大家的生活都恢复到了正轨,这也就意味着,真正考验平板电脑生存的环境来了。也就是面对着这种残酷的
  • 小米平板5 Pro 12.4简评:多专多能 兼顾影音娱乐的大屏利器

    疫情带来了网课,网课盘活了安卓平板,安卓平板市场虽然中途停滞了几年,但好的一点就是停滞的这几年行业又有了新的发展方向,例如超窄边框、高刷新率、多摄镜头组合等,这就让安卓
  • 28个SpringBoot项目中常用注解,日常开发、求职面试不再懵圈

    前言在使用SpringBoot开发中或者在求职面试中都会使用到很多注解或者问到注解相关的知识。本文主要对一些常用的注解进行了总结,同时也会举出具体例子,供大家学习和参考。注解
  • 如何使用JavaScript创建一只图像放大镜?

    译者 | 布加迪审校 | 重楼如果您曾经浏览过购物网站,可能遇到过图像放大功能。它可以让您放大图像的特定区域,以便浏览。结合这个小小的重要功能可以大大改善您网站的用户体验
  • Python异步IO编程的进程/线程通信实现

    这篇文章再讲3种方式,同时讲4中进程间通信的方式一、 Python 中线程间通信的实现方式共享变量共享变量是多个线程可以共同访问的变量。在Python中,可以使用threading模块中的L
  • Temu起诉SHEIN,跨境电商战事升级

    来源 | 伯虎财经(bohuFN)作者 | 陈平安日前据外媒报道,拼多多旗下跨境电商平台Temu正对竞争对手SHEIN提起新诉讼,诉状称Shein&ldquo;利用市场支配力量强迫服装厂商与之签订独家
  • 消息称小米汽车开始筛选交付中心:需至少120个车位

    IT之家 7 月 7 日消息,日前,有微博简介为“汽车行业从业者、长三角一体化拥护者”的微博用户 @长三角行健者 发文表示,据经销商集团反馈,小米汽车目前
  • 首发天玑9200+ iQOO Neo8系列发布首销售价2299元起

    2023年5月23日晚,iQOO Neo8系列正式发布。其中,Neo系列首款Pro之作——iQOO Neo8 Pro强悍登场,限时售价3099元起;价位段最强性能手机iQOO Neo8同期上市
Top