MyBatis写入Json字段及Json字段转对象

• 阅读本文章大概需要一分钟

一、背景

最近在设计表结构的时候，根据需求，将一个字段的类型设计为Json字段，而对于还没有操作过数据库Json字段的我就有点懵了，之前从未遇到这种情况，所以也是一步步研究一步步踩坑，最后终于是把Json字段读取的坑都踩遍了，希望这篇文章可以帮助到大家，有问题留言

二、需求描述

• 本来打算贴表结构图的，奈何不知道为什么贴上来总是无法显示，所以就直接贴实体类结构吧
• 需求是要直接将ParameterEntity的limiting属性写入json字段并且在做查询的时候需要将json字段中的值直接映射到实体类上

@Data
@Builder
@ToString
public class ParameterEntity {
    private String device;
    private String recipe;
    private String parameter;
    private String name;
    private String type;
    private String valueType;
    // 这个字段就对应表中的json字段 
    private ParameterLimiting limiting;
}

三、准备环境

• 这里我使用的是pg数据库，如下是pg库的配置
• 特别注意！！！
  –jdbcUrl中的tringtype=unspecified一定要加，否则会报一个写入类型不匹配的错误，其他数据库可能也需要指定tringtype，这里就暂时不做研究

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

四、Json字段数据的写入

核心：字符串转Json的控制类

1. 定义对象转Json的控制类

// 这里对应表中字段的类型
@MappedJdbcTypes(JdbcType.OTHER)
// 这里对应实体类的类型
@MappedTypes(ParameterLimiting.class)
public class ParameterLimitingToJsonHandler extends BaseTypeHandler<ParameterLimiting> {

    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, ParameterLimiting parameterLimiting, JdbcType jdbcType) throws SQLException {
    	// 做写入操作时将对象转成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 也就是我们刚写的对象转Json的控制类  -->
                #{limiting,jdbcType=OTHER,typeHandler=com.inventec.dm.config.ParameterLimitingToJsonHandler});
</insert>

到这里对象写入json字段就告一段落了

五、Json字段转对象

核心：实体类的有参构造

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还是上边的转换控制类 -->
        <result property="limiting" column="limiting"
                jdbcType="OTHER" javaType="com.inventec.dm.entity.parameter.ParameterLimiting"
                typeHandler="com.inventec.dm.config.ParameterLimitingToJsonHandler"/>
</resultMap>

2. 构造函数

@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;

    // 这个实体类中不能有无参构造，否则在映射json字段时不执行有参构造
    // 注意这里最后的一个参数是 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);
        }
    }
}

注意：

• 这个实体类中不能有无参构造，否则在映射json字段时不执行有参构造，也就是说无法转换对象！切记！！！
• 注意这里最后的一个参数 Object limiting，定义为Object类型也是为了使其可以接收表中json字的值同时也符合有参构造参数的类型（也就是说如果把Object改为String的话编译会报错）

到这里Json字段的写入和读取就大工告成了

六、最后

有什么问题及指教大家都可以在评论区讨论哦