jackson#ObjectMapper序列化和反序列化的实用小技巧

如今很多公司已经在使用 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")));

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,366评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,521评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,689评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,925评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,942评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,727评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,447评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,349评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,820评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,990评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,127评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,812评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,471评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,017评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,142评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,388评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,066评论 2 355

推荐阅读更多精彩内容