SpringBoot中JSON工具類JsonUtils的實踐教學
Spring Boot 項目里,JSON 工具類是每個 Service 都要寫的東西。選哪個 JSON 庫一直是個頭疼事:Fastjson2 快但有安全歷史包袱,Jackson 穩(wěn)但配置繁瑣,F(xiàn)astjson1 老項目在用但沒人想維護。更麻煩的是,一旦業(yè)務(wù)代碼綁死了具體庫的 API,換庫就得全局改。
JsonUtils 的做法是:統(tǒng)一接口加啟動時自動檢測 JSON 庫,三引擎無縫切換。業(yè)務(wù)代碼只調(diào) JsonUtils.parseObject(),底層用哪個庫,看 classpath 上有什么。
引入依賴,直接開始用
Spring Boot 2.x 項目:
<dependency> <groupId>com.gitee.apanlh</groupId> <artifactId>apanlh-common</artifactId> <version>2.0.6</version> </dependency>
Spring Boot 3.x 項目:
<dependency> <groupId>com.gitee.apanlh</groupId> <artifactId>apanlh-common</artifactId> <version>3.0.6</version> </dependency>
JDK 8+ 可用。JSON 庫(Fastjson2、Jackson、Fastjson1)均為可選依賴,項目里有哪個就用哪個,引了就能用。
最簡單的用法:3 分鐘上手
JSON 轉(zhuǎn) Bean
import com.gitee.apanlh.util.dataformat.JsonUtils;
import com.gitee.apanlh.util.dataformat.TypeReference;
// JSON 字符串轉(zhuǎn) Bean
User user = JsonUtils.parseObject("{\"name\":\"Pan\",\"age\":28}", User.class);
// 帶泛型的復(fù)雜類型,用 TypeReference 避免類型擦除
Map<String, List<Order>> map = JsonUtils.parseObject(json,
new TypeReference<Map<String, List<Order>>>() {});
// JSON 數(shù)組轉(zhuǎn) List
List<User> users = JsonUtils.parseArray(jsonArray, User.class);
Bean 轉(zhuǎn) JSON
// 對象轉(zhuǎn) JSON 字符串 String json = JsonUtils.toJson(user); // 對象轉(zhuǎn) JSON 字節(jié)數(shù)組(UTF-8) byte[] bytes = JsonUtils.toJsonBytes(user);
解析為 Map
// 轉(zhuǎn)為標準 HashMap,不是 JSONObject Map<String, Object> map = JsonUtils.parseToMap(json); // 保持插入順序的 LinkedHashMap Map<String, Object> linked = JsonUtils.parseToLinkedMap(json); // 按鍵自然排序的 TreeMap Map<String, Object> sorted = JsonUtils.parseToSortedMap(json); // JSON 數(shù)組轉(zhuǎn)為 List<Map> List<Map<String, Object>> listMap = JsonUtils.parseToListMap(json);
所有 parseTo* 方法返回的都是標準 Java 容器(HashMap、ArrayList),不會返回 JSONObject 或 JSONArray 等庫專有類型。嵌套結(jié)構(gòu)也會遞歸轉(zhuǎn)換。
對象類型轉(zhuǎn)換
// 把 Map、List 或其他對象轉(zhuǎn)為指定類型 Map<String, Object> map = JsonUtils.parseToMap(json); User user = JsonUtils.to(map, User.class);
三引擎自動檢測
底層用 JsonProvider 接口抽象了三套實現(xiàn),啟動時自動選:
檢測優(yōu)先級:Fastjson2 > Jackson > Fastjson1
classpath 上有什么就用什么,業(yè)務(wù)代碼永遠只寫 JsonUtils.parseObject(),底層引擎換了,調(diào)用方完全無感知。
三種引擎的默認安全配置:
Fastjson2 Provider
- 啟用
UseNativeObject特性,解析結(jié)果直接使用原生 Java 對象 - 所有 JSONObject/JSONArray 遞歸轉(zhuǎn)為標準 Map/List
Jackson Provider
- 注冊
JavaTimeModule,日期序列化輸出可讀字符串yyyy-MM-dd HH:mm:ss.SSS,不是時間戳 FAIL_ON_UNKNOWN_PROPERTIES = false,默認忽略未知字段USE_BIG_DECIMAL_FOR_FLOATS = true,統(tǒng)一浮點數(shù)為 BigDecimal,避免精度丟失
Fastjson1 Provider
AutoTypeSupport = false,關(guān)閉自動類型識別,防止反序列化漏洞- 關(guān)閉循環(huán)引用檢測
DisableCircularReferenceDetect - 日期序列化使用全局格式
WriteDateUseDateFormat
統(tǒng)一日期解析
不同 JSON 庫對 LocalDateTime、LocalDate、Date 的解析規(guī)則各不相同。Fastjson 認 "2024-01-15 10:30:45",Jackson 默認只認 ISO 格式 "2024-01-15T10:30:45"。
三套 Provider 內(nèi)部都委托給了 DateParserUtils,所以不管用哪個 JSON 庫,日期解析行為完全一致:
// 三種庫都能正確解析這些日期字符串
String json = "{\"createTime\":\"2024年1月15日\"}";
User user = JsonUtils.parseObject(json, User.class);
// user.createTime → 2024-01-15T00:00:00
實用功能
JSON 格式校驗
JsonUtils.hasJson("{\"name\":\"test\"}"); // true
JsonUtils.hasJson("not json"); // false
JsonUtils.hasJsonArray("[1,2,3]"); // true
JsonUtils.hasJsonArray("{\"a\":1}"); // false
JsonUtils.hasJsonObject("{\"a\":1}"); // true
JsonUtils.hasJsonObject("[1,2,3]"); // false
字節(jié)數(shù)組直接解析
網(wǎng)絡(luò)傳輸經(jīng)常拿到 byte[],不用自己轉(zhuǎn) String:
byte[] jsonBytes = ...; List<User> users = JsonUtils.parseArray(jsonBytes, User.class);
JSON 行格式輸出
日志記錄、行式 JSON 文件生成場景:
List<User> users = Arrays.asList(new User("A"), new User("B"));
// 每行一個 JSON 對象
String lines = JsonUtils.toJsonLines(users);
// {"name":"A"}
// {"name":"B"}
// 自定義分隔符
String delimited = JsonUtils.toJsonDelimited(users, ";");
// {"name":"A"};
// {"name":"B"}
手動指定 Provider
自動檢測滿足絕大部分場景,但如果想強制用某個庫:
import com.gitee.apanlh.util.dataformat.JsonUtils; import com.gitee.apanlh.util.dataformat.FastJson2Provider; // 應(yīng)用啟動時設(shè)置一次,后續(xù)所有調(diào)用都用這個 Provider JsonUtils.setProvider(new FastJson2Provider());
建議在 @PostConstruct 或 @Configuration 里設(shè)置。設(shè)置后覆蓋自動檢測結(jié)果。
不適合的場景
- 需要精細控制
ObjectMapper/ParserConfig的:可以繼承對應(yīng) Provider 重寫getMapper()/getParserConfig(),但深度定制場景直接用自己的 ObjectMapper 可能更合適 - 不支持 JWE(JSON 加密)
- 不提供 JSON Patch / JSON Pointer
總結(jié)
JsonUtils 的核心是 一個統(tǒng)一接口覆蓋三套 JSON 引擎,啟動自動檢測,換庫零改動。parseToMap 返回標準 Java 容器而不是庫專有類型,日期解析走統(tǒng)一路由避免各庫行為不一致,每個 Provider 都有經(jīng)過驗證的安全默認值(Fastjson 關(guān) AutoType、Jackson 忽略未知字段)。日常開發(fā)中基本不需要操心中間層的差異。
適合場景:Spring Boot Web 項目、需要統(tǒng)一 JSON 操作 API、未來可能換 JSON 庫、希望各模塊日期解析行為一致。
不適合場景:需要深度定制 ObjectMapper、需要 JWE/JSON Patch 等高級 JSON 特性。
以上就是SpringBoot中JSON工具類JsonUtils的實踐教學的詳細內(nèi)容,更多關(guān)于SpringBoot JSON工具類的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
SpringCloud學習筆記之SpringCloud搭建父工程的過程圖解
SpringCloud是分布式微服務(wù)架構(gòu)的一站式解決方案,十多種微服務(wù)架構(gòu)落地技術(shù)的集合體,俗稱微服務(wù)全家桶,這篇文章主要介紹了SpringCloud學習筆記(一)搭建父工程,需要的朋友可以參考下2021-10-10
提交gRPC-spring-boot-starter項目bug修復(fù)的pr說明
這篇文章主要介紹了這篇文章主要為大家介紹了gRPC-spring-boot-starter項目提交bug修復(fù)的pr的原因說明,有需要的朋友可以借鑒參考下,希望能夠有所幫助2022-02-02
java -D參數(shù)設(shè)置系統(tǒng)屬性無效問題及解決
這篇文章主要介紹了java -D參數(shù)設(shè)置系統(tǒng)屬性無效問題及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-12-12

