Springboot+Mybatis+MySql下，mysql使用json类型字段存取的处理

转载：Springboot+Mybatis+MySql下，mysql使用json类型字段存取的处理

背景：

1、mysql5.7开始支持json类型字段；
2、mybatis暂不支持json类型字段的处理，需要自己做处理

项目使用到了这个，网上查了一些资料，实践成功，做记录。
第一步：建表

CREATE TABLE rules_test(
id INT PRIMARY KEY AUTO_INCREMENT,
sys_name VARCHAR(16) NOT NULL unique,
rules JSON,
date TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

第二步：使用generator自动生成xml文件，entity（实体）文件，mapper文件

RulesTestMapper.xml
RulesTest.java
RulesTestMapper.java

第三步：建包com.xxx.xxx.handler，新建MySqlJsonHandler.java,内容如下:

package com.xxx.xxx.handler;

import com.alibaba.fastjson.JSONObject;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedJdbcTypes;
import org.apache.ibatis.type.MappedTypes;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
/**
 * @Project 
 * @Autor 
 * @Create 2019/7/16 1:32 PM
 * @Description
 */
@MappedTypes(JSONObject.class)
@MappedJdbcTypes(JdbcType.VARCHAR)
public class MySqlJsonHandler extends BaseTypeHandler<JSONObject>{
    /**
     * 设置非空参数
     * @param ps
     * @param i
     * @param parameter
     * @param jdbcType
     * @throws SQLException
     */
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, JSONObject parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i,String.valueOf(parameter.toJSONString()));
    }
    /**
     * 根据列名，获取可以为空的结果
     * @param rs
     * @param columnName
     * @return
     * @throws SQLException
     */
    @Override
    public JSONObject getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String sqlJson = rs.getString(columnName);
        if (null != sqlJson) {
            return JSONObject.parseObject(sqlJson);
        }
        return null;
    }
    /**
     * 根据列索引，获取可以为内控的接口
     * @param rs
     * @param columnIndex
     * @return
     * @throws SQLException
     */
    @Override
    public JSONObject getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String sqlJson = rs.getString(columnIndex);
        if (null != sqlJson) {
            return JSONObject.parseObject(sqlJson);
        }
        return null;
    }
    /**
     *
     * @param cs
     * @param columnIndex
     * @return
     * @throws SQLException
     */
    @Override
    public JSONObject getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String sqlJson = cs.getNString(columnIndex);
        if (null != sqlJson) {
            return JSONObject.parseObject(sqlJson);
        }
        return null;
    }
}

第四步：在application.yml中增加对应配置

mybatis:
  mapper-locations: classpath:mapper/*.xml   
  type-aliases-package: com.xxx.xxx.entity   
  type-handlers-package: com.xxx.xxx.handler  #增加此项配置

第五步：修改RulesTestMappler.xml中对应部分
第一个地方---->

<resultMap id="BaseResultMap" type="com.xxx.xxxx.entity.RulesTest" >
    <!--
      WARNING - @mbggenerated
      This element is automatically generated by MyBatis Generator, do not modify.
    -->
    <id column="id" property="id" jdbcType="INTEGER" />
    <result column="sys_name" property="sysName" jdbcType="VARCHAR" />
    <!--将json类型的rules字段修改为如下形式-->
    <result column="rules" property="rules" typeHandler="com.xxx.xxx.handler.MySqlJsonHandler" />
    <result column="date" property="date" jdbcType="TIMESTAMP" />
  </resultMap>

其他地方---->
PS：在xml中写sql语句时，需要将使用到rules的地方配置，以下以插入为例

<insert id="insertTest" parameterType="com.xxx.xxx.entity.RulesTest" >
    <!--
      WARNING - @mbggenerated
      This element is automatically generated by MyBatis Generator, do not modify.
    -->
    insert into rules_test (id, sys_name, rules,
    date)
    values (#{id,jdbcType=INTEGER}, #{sysName,jdbcType=VARCHAR}, #{rules,jdbcType=OTHER,typeHandler=com.xxx.xxx.handler.MySqlJsonHandler},
    #{date,jdbcType=TIMESTAMP})
  </insert>

第六步：修改RulesTest.java实体文件中，rules对应的属性修改为JSONObejct，以下仅摘取修改相关代码

import com.alibaba.fastjson.JSONObject;
//属性
private JSONObject rules;
//get方法
public JSONObject getRules() {
        return rules;
    }
//set方法
public void setRules(JSONObject rules) {
        this.rules = rules == null ? null : rules;
    }

至此，所有相关修改都已经修改完了，按照正常的步骤进行开发即可~

参考链接：
1、SpringBoot中MyBatis 处理 MySQL5.7 的json字段数据
2、MyBatis针对Mysql中json字段的类型处理