快捷導(dǎo)航

MyBatis寫入Json字段以及Json字段轉(zhuǎn)對(duì)象示例詳解

更新時(shí)間：2023年07月21日 11:32:53 作者：頭發(fā)怎么還有這么多

這篇文章主要給大家介紹了關(guān)于MyBatis寫入Json字段以及Json字段轉(zhuǎn)對(duì)象的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下

一、背景

最近在設(shè)計(jì)表結(jié)構(gòu)的時(shí)候，根據(jù)需求，將一個(gè)字段的類型設(shè)計(jì)為Json字段，而對(duì)于還沒有操作過數(shù)據(jù)庫Json字段的我就有點(diǎn)懵了，之前從未遇到這種情況，所以也是一步步研究一步步踩坑，最后終于是把Json字段讀取的坑都踩遍了，希望這篇文章可以幫助到大家，有問題留言

二、需求描述

本來打算貼表結(jié)構(gòu)圖的，奈何不知道為什么貼上來總是無法顯示，所以就直接貼實(shí)體類結(jié)構(gòu)吧需求是要直接將ParameterEntity的limiting屬性寫入json字段并且在做查詢的時(shí)候需要將json字段中的值直接映射到實(shí)體類上

@Data
@Builder
@ToString
public class ParameterEntity {
    private String device;
    private String recipe;
    private String parameter;
    private String name;
    private String type;
    private String valueType;
    // 這個(gè)字段就對(duì)應(yīng)表中的json字段 
    private ParameterLimiting limiting;
}

三、準(zhǔn)備環(huán)境

這里我使用的是pg數(shù)據(jù)庫，如下是pg庫的配置
特別注意?。?！
–jdbcUrl中的tringtype=unspecified一定要加，否則會(huì)報(bào)一個(gè)寫入類型不匹配的錯(cuò)誤，其他數(shù)據(jù)庫可能也需要指定tringtype，這里就暫時(shí)不做研究

  datasource:
    pgsql:
      jdbcUrl: jdbc:postgresql://ip:5432/ams?rewriteBatchedStatements=true&stringtype=unspecified
      username: 
      password: 
      driver-class-name: org.postgresql.Driver

四、Json字段數(shù)據(jù)的寫入

核心：字符串轉(zhuǎn)Json的控制類

1. 定義對(duì)象轉(zhuǎn)Json的控制類

// 這里對(duì)應(yīng)表中字段的類型
@MappedJdbcTypes(JdbcType.OTHER)
// 這里對(duì)應(yīng)實(shí)體類的類型
@MappedTypes(ParameterLimiting.class)
public class ParameterLimitingToJsonHandler extends BaseTypeHandler<ParameterLimiting> {
    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, ParameterLimiting parameterLimiting, JdbcType jdbcType) throws SQLException {
    	// 做寫入操作時(shí)將對(duì)象轉(zhuǎn)成json字符串
        preparedStatement.setObject(i, JSON.toJSONString(parameterLimiting));
    }
    @Override
    public ParameterLimiting getNullableResult(ResultSet resultSet, String s) throws SQLException {
        return null;
    }
    @Override
    public ParameterLimiting getNullableResult(ResultSet resultSet, int i) throws SQLException {
        return null;
    }
    @Override
    public ParameterLimiting getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        return null;
    }
}

2. 寫mapper文件

<insert id="addParameter" parameterType="com.inventec.dm.entity.po.ParameterEntity">
        INSERT INTO dap.parameter
        ("device", "recipe", "parameter", "name", "type", "valueType", "limiting")
        VALUES (#{device}, #{recipe}, #{parameter}, #{name}, #{type}, #{valueType},
        		<!--  這里需要指定 jdbcType 及 typeHandler 屬性，這里的 typeHandler 也就是我們剛寫的對(duì)象轉(zhuǎn)Json的控制類  -->
                #{limiting,jdbcType=OTHER,typeHandler=com.inventec.dm.config.ParameterLimitingToJsonHandler});
</insert>

到這里對(duì)象寫入json字段就告一段落了

五、Json字段轉(zhuǎn)對(duì)象

核心：實(shí)體類的有參構(gòu)造

1. mapper文件

<select id="getParametersByDeviceId" resultMap="parameterToParameterEntity">
        SELECT *
        FROM dap.parameter
        WHERE device = #{device};
</select>
<resultMap id="parameterToParameterEntity" type="com.inventec.dm.entity.po.ParameterEntity">
        <result property="device" column="device"/>
        <result property="recipe" column="recipe"/>
        <result property="parameter" column="parameter"/>
        <result property="name" column="name"/>
        <result property="type" column="type"/>
        <result property="valueType" column="valueType"/>
        <-- 這里需要指定jdbcType、javaType、typeHandler屬性，其中typeHandler還是上邊的轉(zhuǎn)換控制類 -->
        <result property="limiting" column="limiting"
                jdbcType="OTHER" javaType="com.inventec.dm.entity.parameter.ParameterLimiting"
                typeHandler="com.inventec.dm.config.ParameterLimitingToJsonHandler"/>
</resultMap>

2. 構(gòu)造函數(shù)

@Data
@Builder
@ToString
public class ParameterEntity {
    private String device;
    private String recipe;
    private String parameter;
    private String name;
    private String type;
    private String valueType;
    private ParameterLimiting limiting;
    // 這個(gè)實(shí)體類中不能有無參構(gòu)造，否則在映射json字段時(shí)不執(zhí)行有參構(gòu)造
    // 注意這里最后的一個(gè)參數(shù)是 Object limiting，而不是 ParameterLimiting limiting
    public ParameterEntity(String device, String recipe, String parameter, String name, String type, String valueType, Object limiting) {
        this.device = device;
        this.recipe = recipe;
        this.parameter = parameter;
        this.name = name;
        this.type = type;
        this.valueType = valueType;
        if (limiting != null) {
            this.limiting = JSON.parseObject(limiting.toString(), ParameterLimiting.class);
        }
    }
}

注意：

這個(gè)實(shí)體類中不能有無參構(gòu)造，否則在映射json字段時(shí)不執(zhí)行有參構(gòu)造，也就是說無法轉(zhuǎn)換對(duì)象！切記?。。?/li>
注意這里最后的一個(gè)參數(shù) Object limiting，定義為Object類型也是為了使其可以接收表中json字的值同時(shí)也符合有參構(gòu)造參數(shù)的類型（也就是說如果把Object改為String的話編譯會(huì)報(bào)錯(cuò)）

到這里Json字段的寫入和讀取就大工告成了