SpringBoot 中 Json 格式化配置

boyanx6个月前技术教程15

SpringBoot 针对 jackson 是自动化配置的,如果需要修改,也可以自定义配置。


0x01:通过 application.yml

配置属性说明:


spring.jackson.date-format
指定日期格式,比如 yyyy-MM-dd HH:mm:ss,或者具体的格式化类的全限定名。


spring.jackson.deserialization
是否开启 Jackson 的反序列化。

spring.jackson.generator 是否开启 json 的 generators。


spring.jackson.joda-date-time-format
指定 Joda date/time 的格式,比如 (yyyy-MM-dd HH:mm:ss)。如果没有配置的话,dateformat 会作为 backup。

spring.jackson.locale 指定 json 使用的 Locale。

spring.jackson.mapper 是否开启 Jackson 通用的特性。

spring.jackson.parser 是否开启 jackson 的 parser 特性。


spring.jackson.property-naming-strategy
指定 PropertyNamingStrategy(
CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES) 或者指定 PropertyNamingStrategy 子类的全限定类名。


spring.jackson.serialization
是否开启 jackson 的序列化。


spring.jackson.serialization-inclusion
指定序列化时属性的 inclusion 方式,具体查看 JsonInclude.Include 枚举。

spring.jackson.time-zone 指定日期格式化时区,比如 America/Los_Angeles 或者 GMT+10。

spring:
  jackson:
  #日期格式化
    date-format: yyyy-MM-dd HH:mm:ss
  serialization:
    #格式化输出 
     indent_output: true
     #忽略无法转换的对象
     fail_on_empty_beans: false
      #设置空如何序列化
     defaultPropertyInclusion: NON_EMPTY
  deserialization:
      #允许对象忽略json中不存在的属性
      fail_on_unknown_properties: false
  parser:
       #允许出现特殊字符和转义符
       allow_unquoted_control_chars: true
        #允许出现单引号
        allow_single_quotes: true


0x02 使用重新注入 ObjectMapper

在配置 bean 中使用下面的配置

@Bean
@Primary
@ConditionalOnMissingBean(ObjectMapper.class)
public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder)
{
ObjectMapper objectMapper = builder.createXmlMapper(false).build();

// 通过该方法对mapper对象进行设置,所有序列化的对象都将该规则进行序列化
// Include.Include.ALWAYS 默认
// Include.NON_DEFAULT 属性为默认值不序列化
// Include.NON_EMPTY 属性为 空("") 或者为 NULL 都不序列化,则返回的json是没有这个字段的。这样对移动端会更省流量
// Include.NON_NULL 属性为NULL 不序列化

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 允许出现特殊字符和转义符
objectMapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_CONTROL_CHARS, true);
// 允许出现单引号
objectMapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);
// 字段保留,将null值转为""
objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>()
{
@Override
public void serialize(Object o, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider)
throws IOException{
jsonGenerator.writeString("");
}
});
return objectMapper;
}


另外,如果没有进行全局配置。后台编写的接口向前端返回数据时,如果返回的是某个数据库对应的实体类,有可能出现日期类型数据不是 yyyy-MM-dd HH:mm:ss 格式。SpringBoot 提供了 @JsonFormat 注解就可以适用于这种情况。使用方式:加在实体类属上添加该注解

/**
* 创建时间
*/
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
@TableField(value = "create_date")
private Date createDate;

类似功能的注解还有 @DateTimeFormat。

相关文章

开发利器丨如何使用ELK设计微服务中的日志收集方案?

【摘要】 微服务各个组件的相关实践会涉及到工具,本文将会介绍微服务日常开发的一些利器,这些工具帮助我们构建更加健壮的微服务系统,并帮助排查解决微服务系统中的问题与性能瓶颈等。我们将重点介绍微服务架构中...

一起来做一个json格式化工具吧

说到json格式化你肯定很熟悉,毕竟压缩后的json数据基本不可读,为了方便查看,我们可以在编辑器中可以通过插件一键格式化,也可以通过一些在线工具来美化,当然,有时在开发中也会遇到json格式化的需求...

1024程序员节 花了三个小时调试 集合近50种常用小工具 开源项目

开篇1024是程序员节了,本来我说看个开源项目花半个小时调试之前看的 一个不错的开源项目,一个日常开发常常使用的工具集,结果花了我三个小时,开源作者的开源项目中缺少一些文件,我一个个在网上找的,好多坑...

js中关于json语法和json遍历问题

什么是 JSON?JSON 英文全称 JavaScript Object NotationJSON 是一种轻量级的数据交换格式。JSON是独立的语言 *JSON 易于理解。json对象使用js语法,但...

@JsonFormat 只会转日期?这4个高能用法太强大了

环境:SpringBoot3.4.21. 简介@JsonFormat 是 Jackson 框架中用于精准控制数据序列化与反序列化时输出格式的注解,广泛应用于日期、时间、数值等类型的格式转换。它通过声明...

Postman 接口测试实战教程:从入门到精通,全网最全项目详解

什么是接口?为什么需要接口?因为接口能使我们的实体或者软件内部数据能够被外部进行修改、查询。从而使得内部和外部实现数据交互,所以,需要用到接口。软件接口:右称:API(application prog...

发表评论    

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。