Java解決Jackson反序列化字段名不匹配問(wèn)題
在 Java 開(kāi)發(fā)XML中,我們經(jīng)常使用 Jackson 庫(kù)來(lái)處理 JSON 數(shù)據(jù)的序列化和反序列化。然而,在實(shí)際開(kāi)發(fā)中,由于 JSON 和 Java 對(duì)象的字段命名風(fēng)格不一致(如大小寫(xiě)、is 前綴等),經(jīng)常會(huì)出現(xiàn) UnrecognizedPropertyException 錯(cuò)誤。本文將結(jié)合一個(gè)實(shí)際案例,分析常見(jiàn)的字段名不匹配問(wèn)題,并提供多種解決方案,幫助開(kāi)發(fā)者高效應(yīng)對(duì)類(lèi)似問(wèn)題。
問(wèn)題背景
假設(shè)我們有一個(gè) JSON 數(shù)據(jù),結(jié)構(gòu)如下:
{
"id": null,
"msg": null,
"isSuccess": true,
"code": null,
"data": {
"Total": 1700,
"Rows": [...]
}
}對(duì)應(yīng)的 Java 類(lèi) ExamListResponseVo 定義如下:
@Data
public class ExamListResponseVo {
private Object id;
private String msg;
private boolean isSuccess; // 問(wèn)題1:Jackson 默認(rèn)會(huì)去掉 is 前綴
private Object code;
private ExamListData data;
@Data
public static class ExamListData {
private Integer total; // 問(wèn)題2:JSON 中是 "Total",大小寫(xiě)不匹配
private List<ExamRow> rows;
}
}當(dāng)我們使用 ObjectMapper 反序列化時(shí),可能會(huì)遇到以下兩個(gè)錯(cuò)誤:
error:Unrecognized field "isSuccess"
原因:isSuccess 在 JSON 中是 isSuccess,但 Jackson 默認(rèn)會(huì)去掉 is 前綴,嘗試匹配 success。
error:Unrecognized field "Total"
原因:JSON 中的 "Total" 是首字母大寫(xiě),而 Java 類(lèi)中是 total,大小寫(xiě)不匹配。
解決方案
1. 解決isSuccess問(wèn)題
方案 1:修改 Java 字段名(推薦)
private boolean success; // 改為 success,與 Jackson 默認(rèn)行為一致
方案 2:使用@JsonProperty注解
@JsonProperty("isSuccess") // 強(qiáng)制匹配 JSON 中的 isSuccess
private boolean isSuccess;方案 3:配置ObjectMapper禁用is前綴處理
ObjectMapper mapper = new ObjectMapper(); mapper.configure(MapperFeature.USE_STD_BEAN_NAMING, true); // 禁止自動(dòng)去掉 is 前綴
2. 解決Total大小寫(xiě)問(wèn)題
方案 1:修改 Java 字段名(推薦)
private Integer Total; // 與 JSON 完全一致
方案 2:使用@JsonProperty注解
@JsonProperty("Total")
private Integer total;方案 3:配置ObjectMapper忽略大小寫(xiě)
ObjectMapper mapper = new ObjectMapper(); mapper.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES, true);
方案 4:忽略未知字段(適用于不可控 JSON 結(jié)構(gòu))
@Data
@JsonIgnoreProperties(ignoreUnknown = true) // 忽略 JSON 中多余的字段
public static class ExamListData {
private Integer total;
private List<ExamRow> rows;
}最佳實(shí)踐
1. 保持 JSON 和 Java 字段名一致
如果 JSON 可控,建議統(tǒng)一命名風(fēng)格,如全部使用
snake_case或camelCase。
2. 優(yōu)先使用@JsonProperty注解
適用于需要保留原有 Java 字段名但 JSON 字段名不同的情況。
3. 全局配置ObjectMapper
如果項(xiàng)目中有大量大小寫(xiě)不一致的情況,可以全局配置:
ObjectMapper mapper = new ObjectMapper(); mapper.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES, true); mapper.configure(MapperFeature.USE_STD_BEAN_NAMING, true);
4. 使用@JsonIgnoreProperties避免未知字段報(bào)錯(cuò)
適用于第三方 API 返回的 JSON 結(jié)構(gòu)可能變化的情況。
完整代碼示例
修正后的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);
總結(jié)
| 問(wèn)題 | 解決方案 | 適用場(chǎng)景 |
|---|---|---|
| isSuccess 不匹配 | 修改字段名 / @JsonProperty | 布爾字段帶 is 前綴 |
| Total 大小寫(xiě)問(wèn)題 | 修改字段名 / @JsonProperty / 全局配置 | JSON 字段名大小寫(xiě)不一致 |
| 未知字段報(bào)錯(cuò) | @JsonIgnoreProperties | 第三方 API 返回不可控 JSON |
推薦做法:
- 盡量統(tǒng)一 JSON 和 Java 字段名(如 camelCase)。
- 必要時(shí)使用 @JsonProperty 顯式映射。
- 全局配置 ObjectMapper 適用于大型項(xiàng)目。
- 使用 @JsonIgnoreProperties 增強(qiáng)魯棒性。
通過(guò)本文的解決方案,你可以輕松應(yīng)對(duì) Jackson 反序列化時(shí)的字段名不匹配問(wèn)題,提高開(kāi)發(fā)效率!
到此這篇關(guān)于Java解決Jackson反序列化字段名不匹配問(wèn)題的文章就介紹到這了,更多相關(guān)Java Jackson反序列化字段名不匹配內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
深入理解Java中的volatile關(guān)鍵字(總結(jié)篇)
volatile這個(gè)關(guān)鍵字,不僅僅在Java語(yǔ)言中有,在很多語(yǔ)言中都有的,而且其用法和語(yǔ)義也都是不盡相同的。這篇文章主要介紹了Java中的volatile關(guān)鍵字,需要的朋友可以參考下2018-10-10
Spring Boot Rest控制器單元測(cè)試過(guò)程解析
這篇文章主要介紹了Spring Boot Rest控制器單元測(cè)試過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-03-03
解決@RequestBody使用不能class類(lèi)型匹配的問(wèn)題
這篇文章主要介紹了解決@RequestBody使用不能class類(lèi)型匹配的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-07-07
java實(shí)現(xiàn)酷狗音樂(lè)臨時(shí)緩存文件轉(zhuǎn)換為MP3文件的方法
這篇文章主要介紹了java實(shí)現(xiàn)酷狗音樂(lè)臨時(shí)緩存文件轉(zhuǎn)換為MP3文件的方法,涉及java針對(duì)文件操作的相關(guān)技巧,需要的朋友可以參考下2016-08-08
關(guān)于log4j漏洞修復(fù)解決方案及源碼編譯
Log4j?是Apache為Java提供的日志管理工具。他與System.out.println()的作用相似,用來(lái)跟蹤、調(diào)試、維護(hù)程序。這篇文章主要介紹了關(guān)于log4j漏洞修復(fù)解決方案及源碼編譯,需要的朋友可以參考下2021-12-12

