提供一种在 xml 中指定使用 XxxTypeHandler 映射 Java 对象(含泛型)的方式

背景

Java 项目,使用 Mybatis Plus,在 xml 中使用了 JSON_ARRAY/JSON_ARRAYAGG 函数,想直接映射成 Java 实体,势必想到要用 JacksonTypeHandler,但是有一个问题,就是对于复杂类型(含泛型),就没法在 xml 中通过 javaType 的方式告知 JacksonTypeHandler 了,遂导致解析失败。

解决

MyJacksonTypeHandler.java

public class MyJacksonTypeHandler extends JacksonTypeHandler {

    private final Class<?> type;

    public MyJacksonTypeHandler(Class<?> type) {
        super(type);
        this.type = type;
    }

    protected Object parse(String json) {
        try {
            if (MyTypeReference.class.isAssignableFrom(type)) {
                MyTypeReference typeReference = (MyTypeReference) type.getConstructor().newInstance();
                return getObjectMapper().readValue(json, typeReference.getType());
            }

            return getObjectMapper().readValue(json, this.type);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

}

MyTypeReference.java

public interface MyTypeReference {

    TypeReference<?> getType();

}

TestJsonList.java

@Data
public class TestJsonList {

    private Integer id;

    private List<Dog> jsonInfo;

    @Data
    public static class Dog {
        private String name;
    }

    public static class DogListTypeReference implements MyTypeReference {
        @Override
        public TypeReference<?> getType() {
            return new TypeReference<List<Dog>>(){};
        }
    }

}

TestJsonMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="xxx.mapper.TestJsonMapper">
    <resultMap id="testJsonResultMap" type="xxx.model.TestJson">
        <result property="jsonInfo" column="json_info" jdbcType="LONGVARCHAR"
                javaType="xxx.model.TestJson$Dog"
                typeHandler="com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler"/>
    </resultMap>

    <resultMap id="testJsonListResultMap" type="xxx.model.TestJsonList">
        <result property="jsonInfo" column="json_info" jdbcType="LONGVARCHAR"
                javaType="xxx.model.TestJsonList$DogListTypeReference"
                typeHandler="xxx.handler.MyJacksonTypeHandler"/>
    </resultMap>

    <select id="testJson" resultMap="testJsonResultMap">
        select 1 as id, '{"name": "dahuang"}' as json_info
    </select>

    <select id="testJsonList" resultMap="testJsonListResultMap">
        select 1 as id, '[{"name": "dahuang"}]' as json_info
    </select>
</mapper>

后续

实际测试过程中,发现使用了 LEFT JOIN 后,得到的 json 的所有 value 都会 null,解析后就得到一个所有成员都为 null 的对象,需要过滤下:

MyJacksonTypeHandler.java

public class MyJacksonTypeHandler extends JacksonTypeHandler {

    private final Class<?> type;

    public MyJacksonTypeHandler(Class<?> type) {
        super(type);
        this.type = type;
    }

    @Override
    protected Object parse(String json) {
        try {
            // 如果指定了 MyTypeReference 类型,需要特殊处理
            if (MyTypeReference.class.isAssignableFrom(type)) {
                MyTypeReference typeReference = (MyTypeReference) type.getConstructor().newInstance();
                Object result = getObjectMapper().readValue(json, typeReference.getType());
                // 由于使用了 LEFT JOIN,右表可能为空,导致这里的 json 所有 value 都为 null,单独处理下
                if (isAllFieldNull(result)) {
                    return null;
                } else {
                    removeNullItem(result);
                    return result;
                }
            }

            // 否则,使用默认的处理方式就行
            return getObjectMapper().readValue(json, type);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * 去除 List 中对象成员均为 null 的项
     */
    private void removeNullItem(Object object) {
        Class<?> clazz = object.getClass();
        if (List.class.isAssignableFrom(clazz)) {
            ((List<?>) object).removeIf(this::isAllFieldNull);
        }
    }

    /**
     * 判断对象是否所有成员都为 null
     */
    private boolean isAllFieldNull(Object object) {
        Class<?> clazz = object.getClass();
        for (Field field : clazz.getDeclaredFields()) {
            field.setAccessible(true);
            try {
                if (field.get(object) != null) {
                    return false;
                }
            } catch (IllegalAccessException e) {
                throw new RuntimeException(e);
            }
        }

        return true;
    }

}

补充

如果不在 XxxMapper.xml 中书写 sql,可以直接在 Java 类上指定 JacksonTypeHandler 即可,也能处理复杂类型(含泛型)

TestJson.java

@Data
@TableName(value = "test_json", autoResultMap = true)
public class TestJson {

    private Integer id;

    @TableField(typeHandler = JacksonTypeHandler.class)
    private Dog jsonInfo;

    @TableField(typeHandler = JacksonTypeHandler.class)
    private List<Dog> jsonInfoList;

    @Data
    public static class Dog {
        private String name;
    }

}

TestController.java

// 不使用 XxxMapper.xml 中的方法
TestJson testJson = testJsonMapper.selectOne(null);

因为在 XxxMapper.xml 中书写 sql,只能通过 resultMap 的方式指定 javaType 和 typeHandler(@TableField 注解指定的 typeHandler 不会被使用),但是却无法将泛型信息传递给指定的 typeHandler。

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

推荐阅读更多精彩内容