java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > SpringBoot JSON工具类

SpringBoot中JSON工具类JsonUtils的实践教学

作者:pan-common

Spring Boot 项目里,JSON 工具类是每个 Service 都要写的东西,JsonUtils的核心是一个统一接口覆盖三套 JSON 引擎,本文主要介绍了JsonUtils在SpringBoot项目中的具体应用,希望对大家有所帮助

Spring Boot 项目里,JSON 工具类是每个 Service 都要写的东西。选哪个 JSON 库一直是个头疼事:Fastjson2 快但有安全历史包袱,Jackson 稳但配置繁琐,Fastjson1 老项目在用但没人想维护。更麻烦的是,一旦业务代码绑死了具体库的 API,换库就得全局改。

JsonUtils 的做法是:统一接口加启动时自动检测 JSON 库,三引擎无缝切换。业务代码只调 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 转 Bean

import com.gitee.apanlh.util.dataformat.JsonUtils;
import com.gitee.apanlh.util.dataformat.TypeReference;

// JSON 字符串转 Bean
User user = JsonUtils.parseObject("{\"name\":\"Pan\",\"age\":28}", User.class);

// 带泛型的复杂类型,用 TypeReference 避免类型擦除
Map<String, List<Order>> map = JsonUtils.parseObject(json,
    new TypeReference<Map<String, List<Order>>>() {});

// JSON 数组转 List
List<User> users = JsonUtils.parseArray(jsonArray, User.class);

Bean 转 JSON

// 对象转 JSON 字符串
String json = JsonUtils.toJson(user);

// 对象转 JSON 字节数组(UTF-8)
byte[] bytes = JsonUtils.toJsonBytes(user);

解析为 Map

// 转为标准 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 数组转为 List<Map>
List<Map<String, Object>> listMap = JsonUtils.parseToListMap(json);

所有 parseTo* 方法返回的都是标准 Java 容器(HashMap、ArrayList),不会返回 JSONObject 或 JSONArray 等库专有类型。嵌套结构也会递归转换。

对象类型转换

// 把 Map、List 或其他对象转为指定类型
Map<String, Object> map = JsonUtils.parseToMap(json);
User user = JsonUtils.to(map, User.class);

三引擎自动检测

底层用 JsonProvider 接口抽象了三套实现,启动时自动选:

检测优先级:Fastjson2 > Jackson > Fastjson1

classpath 上有什么就用什么,业务代码永远只写 JsonUtils.parseObject(),底层引擎换了,调用方完全无感知。

三种引擎的默认安全配置:

Fastjson2 Provider

Jackson Provider

Fastjson1 Provider

统一日期解析

不同 JSON 库对 LocalDateTimeLocalDateDate 的解析规则各不相同。Fastjson 认 "2024-01-15 10:30:45",Jackson 默认只认 ISO 格式 "2024-01-15T10:30:45"

三套 Provider 内部都委托给了 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

字节数组直接解析

网络传输经常拿到 byte[],不用自己转 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;

// 应用启动时设置一次,后续所有调用都用这个 Provider
JsonUtils.setProvider(new FastJson2Provider());

建议在 @PostConstruct@Configuration 里设置。设置后覆盖自动检测结果。

不适合的场景

总结

JsonUtils 的核心是 一个统一接口覆盖三套 JSON 引擎,启动自动检测,换库零改动。parseToMap 返回标准 Java 容器而不是库专有类型,日期解析走统一路由避免各库行为不一致,每个 Provider 都有经过验证的安全默认值(Fastjson 关 AutoType、Jackson 忽略未知字段)。日常开发中基本不需要操心中间层的差异。

适合场景:Spring Boot Web 项目、需要统一 JSON 操作 API、未来可能换 JSON 库、希望各模块日期解析行为一致。

不适合场景:需要深度定制 ObjectMapper、需要 JWE/JSON Patch 等高级 JSON 特性。

以上就是SpringBoot中JSON工具类JsonUtils的实践教学的详细内容,更多关于SpringBoot JSON工具类的资料请关注脚本之家其它相关文章!

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