序列化工具类JacksonUtils

java

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.type.CollectionType;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.text.SimpleDateFormat;
import java.util.List;
import java.util.Map;
import java.util.TimeZone;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public abstract class JsonUtils {

    private JsonUtils() {}

    private static final Logger LOG = LoggerFactory.getLogger(JsonUtils.class);

    private static final ObjectMapper MAPPER = new ObjectMapper();

    static {
        MAPPER.setTimeZone(TimeZone.getTimeZone("GMT+8"));
        MAPPER.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        MAPPER.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        MAPPER.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
        MAPPER.configure(SerializationFeature.INDENT_OUTPUT, false);
        MAPPER.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        MAPPER.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);
    }

    @FunctionalInterface
    private interface JsonAction<T> {
        T run() throws JsonProcessingException;
    }

    private static <T> T execute(JsonAction<T> action, String errorMsg) {
        try {
            return action.run();
        } catch (JsonProcessingException e) {
            LOG.error(errorMsg, e);
            throw new RuntimeException(errorMsg, e);
        }
    }

    /**
     * 将实体对象转换为json字符串
     *
     * @param entity 实体对象
     * @param <T>    泛型
     * @return json string
     */
    public static <T> String objToJson(T entity) {
        if (entity == null) {
            return null;
        }
        return execute(() -> MAPPER.writeValueAsString(entity), "序列化object to JSON失败. Object: " + entity);
    }

    /**
     * 将实体对象转换为json字符串
     *
     * @param entity 实体对象
     * @param pretty 是否转换为美观格式
     * @param <T>    泛型
     * @return json string
     */
    public static <T> String objToJson(T entity, boolean pretty) {
        if (entity == null) {
            return null;
        }
        if (!pretty) {
            return objToJson(entity);
        }
        return execute(
                () -> MAPPER.writerWithDefaultPrettyPrinter().writeValueAsString(entity),
                "美观序列化object to JSON失败. Object: " + entity);
    }

    /**
     * 将实体对象转换为字节数组
     *
     * @param entity 实体对象
     * @param <T>    泛型
     * @return json string
     */
    public static <T> byte[] objToJsonBytes(T entity) {
        return execute(() -> MAPPER.writeValueAsBytes(entity), "将实体对象转换为字节数组失败, Object:" + entity);
    }

    /**
     * 将实体类转换为JsonNode对象
     *
     * @param entity 实体对象
     * @param <T>    泛型
     * @return JsonNode
     */
    public static <T> JsonNode objToNode(T entity) {
        return MAPPER.valueToTree(entity);
    }

    /**
     * 将实体对象写入文件
     *
     * @param filepath 文件绝对路径
     * @param entity   实体对象
     * @param <T>      泛型
     * @return 写入成功：true，否则：false
     */
    public static <T> boolean writeToJsonFile(String filepath, T entity) {
        File file = new File(filepath);
        if (!file.exists()) {
            try {
                boolean success = file.createNewFile();
                if (!success) {
                    LOG.error("[writeToJsonFile]-创建文件失败！路径：{}", filepath);
                    return false;
                }
            } catch (IOException e) {
                LOG.error("[writeToJsonFile]-创建文件失败！路径：{}，失败原因：{}", filepath, e.getMessage());
                return false;
            }
        }
        return writeToJsonFile(new File(filepath), entity);
    }

    /**
     * 将实体对象写入指定文件
     *
     * @param file   文件
     * @param entity 实体对象
     * @param <T>    泛型
     * @return 写入成功：true，否则：false
     */
    public static <T> boolean writeToJsonFile(File file, T entity) {
        try {
            MAPPER.writeValue(file, entity);
            return true;
        } catch (IOException e) {
            LOG.error("[writeToJsonFile]-写入文件失败！路径：{}，失败原因：{}", file.getAbsolutePath(), e.getMessage());
        }
        return false;
    }

    /**
     * 将json字符串转换为实体类对象
     *
     * @param json json字符串
     * @param type 实体对象类型
     * @param <T>  泛型
     * @return 转换成功后的对象
     */
    public static <T> T jsonToObj(String json, Class<T> type) {
        return execute(() -> MAPPER.readValue(json, type), "将json字符串转换为实体类对象失败,json: " + json);
    }

    /**
     * 将json字符串转换为map
     *
     * @param json json字符串
     * @return Map
     */
    @SuppressWarnings("unchecked")
    public static Map<String, Object> jsonToMap(String json) {
        return execute(() -> (Map<String, Object>) MAPPER.readValue(json, Map.class), "将json字符串转换为map失败，json：" + json);
    }

    /**
     * 将json字符串转换为map
     *
     * @param json json字符串
     * @return Map
     */
    public static <K, V> Map<K, V> jsonTomap(String json, Class<K> keyType, Class<V> valueType) {
        JavaType mapLikeType = MAPPER.getTypeFactory().constructMapLikeType(Map.class, keyType, valueType);
        return execute(() -> MAPPER.readValue(json, mapLikeType), "将json字符串转换为map失败，json：" + json);
    }

    /**
     * 将 JSON 字符串转换为 Map<String, V>。
     * 这是最常用的 Map 转换形式，因为 JSON 对象的 key 总是字符串。
     *
     * @param json       JSON 字符串
     * @param valueClass Map 的 Value 的 Class 类型
     * @return 返回一个 Map<String, V>
     */
    public static <V> Map<String, V> jsonToMap(String json, Class<V> valueClass) {
        JavaType mapType = MAPPER.getTypeFactory().constructMapType(Map.class, String.class, valueClass);
        return execute(() -> MAPPER.readValue(json, mapType), "将json字符串转换为map失败，json：" + json);
    }

    /**
     * 泛化转换方式，此方式最为强大、灵活
     * <p>
     * example：
     * <p>
     *
     * @param json json字符串
     * @param type type
     * @param <T>  泛化
     * @return T
     */
    public static <T> T genericConvert(String json, TypeReference<T> type) {
        return execute(() -> MAPPER.readValue(json, type), "泛型转换失败，json：" + json);
    }

    /**
     * 将map转换为实体类对象
     *
     * @param map  map
     * @param type 实体对象类型
     * @param <T>  泛型
     * @return 实体对象
     */
    public static <T> T mapToObj(Map<?, ?> map, Class<T> type) {
        return MAPPER.convertValue(map, type);
    }

    /**
     * 将文件内容转为实体类对象
     *
     * @param file 文件
     * @param type 实体类类型
     * @param <T>  泛型
     * @return 实体类对象
     * @throws IOException IOException
     */
    public static <T> T fileToObj(File file, Class<T> type) throws IOException {
        return MAPPER.readValue(file, type);
    }

    /**
     * 将url指向的资源转换为实体类对象
     *
     * @param url  url
     * @param type 实体类对象类型
     * @param <T>  泛型
     * @return 实体类对象
     * @throws IOException IOException
     */
    public static <T> T urlResourceToObj(URL url, Class<T> type) throws IOException {
        return MAPPER.readValue(url, type);
    }

    /**
     * 将json字符串转换为实体类List
     *
     * @param json json字符串
     * @param type 实体对象类型
     * @param <T>  泛型
     * @return list集合
     */
    public static <T> List<T> jsonTolist(String json, Class<T> type) {
        CollectionType collectionType = MAPPER.getTypeFactory().constructCollectionType(List.class, type);
        return execute(() -> MAPPER.readValue(json, collectionType), "将json字符串转换为实体类List失败，json：" + json);
    }

    /**
     * 将json字符串转换为JsonNode对象
     *
     * @param json json字符串
     * @return JsonNode对象
     */
    public static JsonNode jsonToNode(String json) {
        return execute(() -> MAPPER.readTree(json), "将json字符串转换为JsonNode对象失败，json：" + json);
    }

    /**
     * 检查字符串是否是json格式
     *
     * @param str 待检查字符串
     * @return 是：true，否：false
     */
    public static boolean isJsonString(String str) {
        try {
            MAPPER.readTree(str);
            return true;
        } catch (Exception e) {
            if (LOG.isDebugEnabled()) {
                LOG.debug("[isJsonString]-检查字符串是否是json格式...{}", e.getMessage());
            }
            return false;
        }
    }

    /**
     * 打印json到控制台
     *
     * @param obj    需要打印的对象
     * @param pretty 是否打印美观格式
     * @param <T>    泛型
     */
    public static <T> void printJson(T obj, boolean pretty) {
        System.out.println(objToJson(obj, pretty));
    }
}

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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300

序列化工具类JacksonUtils ​

序列化工具类JacksonUtils