如今很多公司已经在使用 jackson 来进行转 json,这里总结了一些实战中常常遇到的问题:
1. 遇到 LocalDate or LocalDateTime 在序列化和反序列化时报错
2. 反序列化时想忽略 json 串的未知属性
3. 序列化时想忽略 null 的字段
4. 反序列化时遇到泛型
下面一个示例代码解决上面所有问题
Response<T>
/**
* @author CaiZhuliang
* @date 2023/5/27
*/
@Getter
@Setter
public class Response<T> {
private String code;
private String msg;
private T target;
}
/**
* @author CaiZhuliang
* @date 2023/5/27
*/
@Slf4j
public class JsonUtil {
private static final String EMPTY_JSON = "{}";
private static final ObjectMapper DEFAULT_MAPPER = new ObjectMapper();
static {
JavaTimeModule javaTimeModule = new JavaTimeModule();
// 注册 LocalDate 的序列化器
javaTimeModule.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ISO_LOCAL_DATE));
// 注册 LocalDateTime 的序列化器
javaTimeModule.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ISO_LOCAL_DATE_TIME));
// 注册 LocalDate 的反序列化器
javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ISO_LOCAL_DATE));
// 注册 LocalDateTime 的反序列化器
javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ISO_LOCAL_DATE_TIME));
DEFAULT_MAPPER.registerModule(javaTimeModule);
// 反序列化时忽略未知属性,也可以通过在POJO类上声明 @JsonIgnoreProperties(ignoreUnknown = true)
DEFAULT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 序列化时忽略 null 的字段
DEFAULT_MAPPER.setSerializationInclusion(JsonInclude.Include.NON_NULL);
}
/**
* 将 obj 转成 json 字符串
* @param obj 待转化的对象
* @return json 字符串
*/
public static String toJsonString(Object obj) {
if (null == obj) {
log.warn("obj to json - 转换对象为空");
return EMPTY_JSON;
}
try {
return DEFAULT_MAPPER.writeValueAsString(obj);
} catch (JsonProcessingException e) {
log.error("json字符串化失败,errorMsg : {}", e.getMessage(), e);
throw new RuntimeException("json字符串化失败");
}
}
/**
* 将 json 字符串转对象
* @param json json字符串
* @param clazz 目标对象的 class 信息
* @return clazz 的实例对象
* @param <T> 目标类型
*/
public static <T> T parseObj(String json, Class<T> clazz) {
if (StringUtils.isBlank(json)) {
return null;
}
try {
return DEFAULT_MAPPER.readValue(json, clazz);
} catch (JsonProcessingException e) {
log.error("json字符串转对象失败,errorMsg : {}", e.getMessage(), e);
throw new RuntimeException(e);
}
}
/**
* 当需要转的对象有泛型时可用该方法,比如 Response<T> List<T> Map<K, V> 等等
* @param json json字符串
* @param parametrized 目标对象,如 Response List Map 等等
* @param parameterClasses 目标对象引用的泛型,如果期望返回是 Map<K, V> 时,那么 parameterClasses 要传入 Class<K> 和 Class<V>
* @return 目标对象的实例对象
* @param <T> 目标类型
*/
public static <T> T parseObj(String json, Class<?> parametrized, Class<?>... parameterClasses) {
if (StringUtils.isBlank(json)) {
return null;
}
JavaType javaType = DEFAULT_MAPPER.getTypeFactory().constructParametricType(parametrized, parameterClasses);
try {
return DEFAULT_MAPPER.readValue(json, javaType);
} catch (JsonProcessingException e) {
log.error("json字符串转对象失败,errorMsg : {}", e.getMessage(), e);
throw new RuntimeException(e);
}
}
public static void main(String[] args) {
Person person = new Person();
person.setName("李四");
person.setAge(18);
person.setCreateTime(LocalDateTime.now());
String personJson = JsonUtil.toJsonString(person);
log.info("personJson = {}", personJson);
Person obj = JsonUtil.parseObj(personJson, Person.class);
log.info("obj = {}", JsonUtil.toJsonString(obj));
String json = "{\n" +
" \"code\": \"0\",\n" +
" \"msg\": \"success\",\n" +
" \"target\": {\n" +
" \"name\": \"张三\",\n" +
" \"createTime\": \"2024-03-09T00:00:00\"\n" +
" }\n" +
"}";
Response<?> response = JsonUtil.parseObj(json, Response.class, Person.class);
log.info("response = {}", JsonUtil.toJsonString(response));
}
}
注意:如果 createTime 传了 "2024-03-09 00:00:00",那么 Response<?> response = JsonUtil.parseObj(json, Response.class, Person.class);
将会报错,因为 DateTimeFormatter.ISO_LOCAL_DATE_TIME 对应的时间格式是 "2024-03-09T14:45:02"。如果想支持 "2024-03-09 00:00:00",那么就要改成 javaTimeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
。