基于Jackson的JSON工具类封装JsonUtils

版权申明:本文为原创文章,转载请注明原文出处

原文链接:https://blog.it-follower.com/posts/3875279541.html

接口开发时经常用到JSON,本文介绍了如果优雅的封装一个工具类,完成java对象与json间的转化。

代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import java.io.IOException;
import java.text.SimpleDateFormat;
import lombok.extern.slf4j.Slf4j;

/**
* 基于Jackson的JSON转换工具类
*
* @author ye17186
* @version 2018/6/29 12:06
*/
@Slf4j
public class JsonUtils {

private static ObjectMapper om = new ObjectMapper();

static {

// 对象的所有字段全部列入,还是其他的选项,可以忽略null等
om.setSerializationInclusion(Include.ALWAYS);
// 设置Date类型的序列化及反序列化格式
om.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));

// 忽略空Bean转json的错误
om.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
// 忽略未知属性,防止json字符串中存在,java对象中不存在对应属性的情况出现错误
om.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

// 注册一个时间序列化及反序列化的处理模块,用于解决jdk8中localDateTime等的序列化问题
om.registerModule(new JavaTimeModule());
}

/**
* 对象 => json字符串
*
* @param obj 源对象
*/
public static <T> String toJson(T obj) {

String json = null;
if (obj != null) {
try {
json = om.writeValueAsString(obj);
} catch (JsonProcessingException e) {
log.warn(e.getMessage(), e);
throw new IllegalArgumentException(e.getMessage());
}
}
return json;
}

/**
* json字符串 => 对象
*
* @param json 源json串
* @param clazz 对象类
* @param <T> 泛型
*/
public static <T> T parse(String json, Class<T> clazz) {

return parse(json, clazz, null);
}

/**
* json字符串 => 对象
*
* @param json 源json串
* @param type 对象类型
* @param <T> 泛型
*/
public static <T> T parse(String json, TypeReference type) {

return parse(json, null, type);
}


/**
* json => 对象处理方法
* <br>
* 参数clazz和type必须一个为null,另一个不为null
* <br>
* 此方法不对外暴露,访问权限为private
*
* @param json 源json串
* @param clazz 对象类
* @param type 对象类型
* @param <T> 泛型
*/
private static <T> T parse(String json, Class<T> clazz, TypeReference type) {

T obj = null;
if (!StringUtils.isEmpty(json)) {
try {
if (clazz != null) {
obj = om.readValue(json, clazz);
} else {
obj = om.readValue(json, type);
}
} catch (IOException e) {
log.warn(e.getMessage(), e);
throw new IllegalArgumentException(e.getMessage());
}
}
return obj;
}
}

使用

1
2
3
4
5
JsonUtils.toJson(obj);
JsonUtils.parse(str, UserModel.class);
// 需要准确泛型的复杂对象可以用这个,这种方式与上面有细微差别,读者可以自行debug研究
JsonUtils.parse(json2, new TypeReference<UserModel<TestModel>>() {
});

实战代码可以参考我的开源项目https://github.com/ye17186/myhelper-spring-boot-starter

评论