首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >SpringBoot 中 Json 格式化配置

SpringBoot 中 Json 格式化配置

作者头像
BUG弄潮儿
发布2021-10-08 16:55:17
发布2021-10-08 16:55:17
3.8K0
举报
文章被收录于专栏:JAVA乐园JAVA乐园

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。

代码语言:javascript
复制
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 中使用下面的配置

代码语言:javascript
复制
@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 注解就可以适用于这种情况。使用方式:加在实体类属上添加该注解

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

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

喜欢,在看

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-09-20,如有侵权请联系 cloudcommunity@tencent.com 删除
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档