Springboot统一配置Jackson(全局命名转换)

最新推荐文章于 2025-04-28 18:31:50 发布

guyue35

最新推荐文章于 2025-04-28 18:31:50 发布

阅读量1.2w

点赞数 2

CC 4.0 BY-SA版权

分类专栏： spring 文章标签： spring jackson 命名转换配置

本文链接：https://blog.csdn.net/guyue35/article/details/83059631

spring 专栏收录该内容

19 篇文章

订阅专栏

本文介绍如何在SpringBoot中全局配置Jackson，实现JSON序列化时的命名规则转换、空值过滤及未知字段忽略等功能，通过配置文件简化对象的序列化与反序列化过程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Springboot统一配置Jackson - Ryan.Miao - 博客园
https://www.cnblogs.com/woshimrf/p/springboot-jackson-global-config.html

Jackson命名转换 - liuguidongliuguidong的专栏 - CSDN博客
https://blog.csdn.net/liuguidongliuguidong/article/details/72968226

/////////////////////////////////

Jackson命名转换
jackson在java对象与json字段之间的转换，提供三种默认的转换规则,
即继承自PropertyNamingStrategyBase的类有三个

PascalCaseStrategy:首字母变为大写

LowerCaseWithUnderscoresStrategy:小写字母＋下划线，java对象属性名的大写字母会转换成小写字母+下划线的形式 (已经废弃, 用SnakeCaseStrategy代替)

LowerCaseStrategy:小写字母的形式

如果要定义自己的转换规则，可以继承PropertyNamingStrategyBase抽象类并重写方法translate;
如下

// 自定义转换规则MyCustomNamingConfig

public class MyCustomNamingConfig extends PropertyNamingStrategyBase{
    @Override
    public String translate(String propertyName) {
        return propertyName;
    }
}

然后在要转换成json的类上加@JsonNaming(MyCustomNamingConfig.class)

//  这里使用自定义转换规则MyCustomNamingConfig, 也可以使用Jackson内置规则PropertyNamingStrategy.SnakeCaseStrategy::class, PropertyNamingStrategy.PascalCaseStrategy::class等
@JsonNaming(MyCustomNamingConfig.class)  
@Data
class JackSonObj{
    private testId;
    private testName;
}

效果:

对于spring boot来说, 则该对象在作为响应时, 默认进行命名规则转换

////////////////////////////////////////////////////////////////////

//////////////////////////如果想全局配置Jackson的命名转换, 可以配置spring boot, 请看下文//////////////////////////////////////////

////////////////////////////////////////////////////////////////////

经常要为接口响应对象设置属性，序列化的时候是不是包含空值，反序列化的时候是否忽略不认识的字段。所以，必须要手动制定ObjectMapper或者在类上声明

@JsonInclude(Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)

虽然不算复杂，但既然统一了规则，那就来个统一设定吧。

在springboo1.5+以上的版本可以这么设置Jackson的一些属性配置, 可以关注property-naming-strategy命名风格配置

spring:
  jackson:
    serialization:
      WRITE_DATES_AS_TIMESTAMPS: false
    default-property-inclusion: non_null    # 转换对象时过滤掉null值
    property-naming-strategy: SNAKE_CASE  # 出参时所有属性自动转下划线风格

更多配置参见 org.springframework.boot.autoconfigure.jackson.JacksonProperties文件


@ConfigurationProperties(
    prefix = "spring.jackson"
)
public class JacksonProperties {
    private String dateFormat;
    private String jodaDateTimeFormat;
    private String propertyNamingStrategy;
    private Map<SerializationFeature, Boolean> serialization = new HashMap();
    private Map<DeserializationFeature, Boolean> deserialization = new HashMap();
    private Map<MapperFeature, Boolean> mapper = new HashMap();
    private Map<Feature, Boolean> parser = new HashMap();
    private Map<com.fasterxml.jackson.core.JsonGenerator.Feature, Boolean> generator = new HashMap();
    private Include defaultPropertyInclusion;
    private TimeZone timeZone = null;
    private Locale locale;
    
    //省略
}