Java skill - @JsonAlias 和 @JsonProperty

她又在丛中笑

已于 2024-06-11 16:13:24 修改

阅读量889

点赞数

分类专栏： Java skill 文章标签： json java 开发语言

于 2023-02-13 10:29:03 首次发布

本文链接：https://blog.csdn.net/m0_63164811/article/details/129004637

版权

Java skill 专栏收录该内容

17 篇文章 0 订阅

订阅专栏

文章介绍了在Java对象序列化和反序列化过程中，@JsonProperty注解可能遇到的问题，如字段名不匹配和多别名需求，并提出使用@JsonAlias注解作为解决方案，允许字段接受多个别名并在序列化时不改变字段名。

摘要由CSDN通过智能技术生成

Java skill - @JsonAlias 和 @JsonProperty

Java skill系列目录：
@JsonAlias 和 @JsonProperty
- 使用 @JsonProperty 的麻烦场景：
- 使用 @JsonAlias 应对麻烦场景：

Java skill系列目录：

【Java skill - 统计耗时用StopWatch】
【Java skill - 快速创建List、Map集合】
【Java skill - @JsonAlias 和 @JsonProperty】

@JsonAlias 和 @JsonProperty

大家平常使用@JsonProperty来进行对象的序列化和反序列化，可以指定属性的字段名，非常方便，但也有麻烦的时候。

使用 @JsonProperty 的麻烦场景：

@Data
public class Test {
    @JsonProperty("xing_ming")
    private String xingMing;
}

java对象序列化的字段名要求是java属性名，json字符串反序列化的接收字段名要求是一个别名。

以上的Test实体类，在【json字符串反序列化】时，这个【xingMing】字段接收的值是在json字符串中字段名为【xing_ming】的值，但是将此java对象返回给前端需要进行序列化时，序列化后的【xingMing】字段名变为【xing_ming】。

json字符串反序列化的接收字段名可能来自多个别名。

以上的Test实体类，在【json字符串反序列化】时，这个【xingMing】字段接收的值是在json字符串中字段名为【xing_ming】，且只能为【xing_ming】的值，如果json字符串中没有【xing_ming】字段，那反序列化后的Java对象的【xingMing】属性为null。

使用 @JsonAlias 应对麻烦场景：

@Data
public class Test {
    @JsonAlias("xing_ming","XiaoMing","xiaoMing")
    private String xingMing;
}

java对象序列化后的字段名是java的属性名，json字符串反序列化的接收字段名可以是多个别名。

以上的Test实体类，在【json字符串反序列化】时，这个【xingMing】字段接收的值是在json字符串中字段名为【xing_ming】、【XiaoMing】、【xiaoMing】的值，解决了麻烦场景2。
以上的Test实体类，在【json字符串反序列化】时，这个【xingMing】字段接收的值是在json字符串中字段名为@JsonAlias注解配置的多个别名的值，在【java对象序列化】时，序列化后的【xingMing】字段名依然是属性名【xingMing】不变，解决了麻烦场景1。