java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > Java Jackson反序列化字段名不匹配

Java解决Jackson反序列化字段名不匹配问题

作者:go 码头整点薯条

这篇文章主要介绍了Java中使用Jackson库处理JSON数据时常见的字段名不匹配问题,并提供了多种解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

在 Java 开发XML中,我们经常使用 Jackson 库来处理 JSON 数据的序列化和反序列化。然而,在实际开发中,由于 JSON 和 Java 对象的字段命名风格不一致(如大小写、is 前缀等),经常会出现 UnrecognizedPropertyException 错误。本文将结合一个实际案例,分析常见的字段名不匹配问题,并提供多种解决方案,帮助开发者高效应对类似问题。

问题背景

假设我们有一个 JSON 数据,结构如下:

{
    "id": null,
    "msg": null,
    "isSuccess": true,
    "code": null,
    "data": {
        "Total": 1700,
        "Rows": [...]
    }
}

对应的 Java 类 ExamListResponseVo 定义如下:

@Data
public class ExamListResponseVo {
    private Object id;
    private String msg;
    private boolean isSuccess; // 问题1:Jackson 默认会去掉 is 前缀
    private Object code;
    private ExamListData data;

    @Data
    public static class ExamListData {
        private Integer total; // 问题2:JSON 中是 "Total",大小写不匹配
        private List<ExamRow> rows;
    }
}

当我们使用 ObjectMapper 反序列化时,可能会遇到以下两个错误:

error:Unrecognized field "isSuccess"

原因:isSuccess 在 JSON 中是 isSuccess,但 Jackson 默认会去掉 is 前缀,尝试匹配 success。

error:Unrecognized field "Total"

原因:JSON 中的 "Total" 是首字母大写,而 Java 类中是 total,大小写不匹配。

解决方案

1. 解决isSuccess问题

方案 1:修改 Java 字段名(推荐)

private boolean success; // 改为 success,与 Jackson 默认行为一致

方案 2:使用@JsonProperty注解

@JsonProperty("isSuccess") // 强制匹配 JSON 中的 isSuccess
private boolean isSuccess;

方案 3:配置ObjectMapper禁用is前缀处理

ObjectMapper mapper = new ObjectMapper();
mapper.configure(MapperFeature.USE_STD_BEAN_NAMING, true); // 禁止自动去掉 is 前缀

2. 解决Total大小写问题

方案 1:修改 Java 字段名(推荐)

private Integer Total; // 与 JSON 完全一致

方案 2:使用@JsonProperty注解

@JsonProperty("Total")
private Integer total;

方案 3:配置ObjectMapper忽略大小写

ObjectMapper mapper = new ObjectMapper();
mapper.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES, true);

方案 4:忽略未知字段(适用于不可控 JSON 结构)

@Data
@JsonIgnoreProperties(ignoreUnknown = true) // 忽略 JSON 中多余的字段
public static class ExamListData {
    private Integer total;
    private List<ExamRow> rows;
}

最佳实践

1. 保持 JSON 和 Java 字段名一致

2. 优先使用@JsonProperty注解

3. 全局配置ObjectMapper

4. 使用@JsonIgnoreProperties避免未知字段报错

完整代码示例

修正后的ExamListResponseVo

@Data
@JsonIgnoreProperties(ignoreUnknown = true) // 可选:忽略未知字段
public class ExamListResponseVo {
    private Object id;
    private String msg;
    @JsonProperty("isSuccess") // 显式指定 JSON 字段名
    private boolean isSuccess;
    private Object code;
    private ExamListData data;

    @Data
    public static class ExamListData {
        @JsonProperty("Total") // 显式指定 JSON 字段名
        private Integer total;
        private List<ExamRow> rows;
    }
}

反序列化代码

ObjectMapper mapper = new ObjectMapper();
// 可选:全局配置
// mapper.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES, true);

String responseBody = "..."; // JSON 字符串
ExamListResponseVo result = mapper.readValue(responseBody, ExamListResponseVo.class);

总结

问题解决方案适用场景
isSuccess 不匹配修改字段名 / @JsonProperty布尔字段带 is 前缀
Total 大小写问题修改字段名 / @JsonProperty / 全局配置JSON 字段名大小写不一致
未知字段报错@JsonIgnoreProperties第三方 API 返回不可控 JSON

推荐做法:

通过本文的解决方案,你可以轻松应对 Jackson 反序列化时的字段名不匹配问题,提高开发效率!

到此这篇关于Java解决Jackson反序列化字段名不匹配问题的文章就介绍到这了,更多相关Java Jackson反序列化字段名不匹配内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文