mybatis自定义typeHandler对postgresql等支持json类型数据

我们在使用PostgreSQL等数据库时会使用到json数据类型，PostgreSQL支持json和jsonb两种格式，而mybatis默认是不支持json数据类型的（在MyBatis的org.apache.ibatis.type包下面没有提供json相关的typeHandler，所以无法正确处理json），MyBatis处理json数据类型需要自定义typeHandler，具体如下：

JsonTypeHandler.java：

package com.demo.mybatis.handler;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.postgresql.util.PGobject;

import com.alibaba.fastjson.JSON;

public class JsonTypeHandler<T extends Object> extends BaseTypeHandler<T> {
	private Class<T> clazz;
	public JsonTypeHandler(Class<T> clazz) {
        this.clazz = clazz;
    }
	private static final PGobject jsonObject = new PGobject();
	
    public JsonTypeHandler() {
     }
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
        jsonObject.setType("json");
        jsonObject.setValue(JSON.toJSONString(parameter));
        ps.setObject(i, jsonObject);
    }
    @Override
	public T getNullableResult(ResultSet rs, String columnName) throws SQLException {
		// TODO Auto-generated method stub
		return JSON.parseObject(rs.getString(columnName), clazz);
	}

    @Override
    public T getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return JSON.parseObject(rs.getString(columnIndex), clazz);
    }

    @Override
    public T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return JSON.parseObject(cs.getString(columnIndex), clazz);
    }
	
}

此JsonTypeHandler依赖：fastjson

注：PGobject 为PostgreSQL数据库驱动包中的一个类，如果提示找不到PGobject，请将postgresql的pom.xml中的<scope>runtime</scope>注释，或者scope设置为默认compile，如下：

<dependency>
     <groupId>org.postgresql</groupId>
     <artifactId>postgresql</artifactId>
     <!-- <scope>runtime</scope> -->
</dependency>

这里假设有test表：

CREATE TABLE public.test(
    id inetger not null,
    img_url_list json NULL,
    PRIMARY KEY (id)
);

实体类为：

package com.demo.entity;

import com.alibaba.fastjson.JSONArray;

public class Test {
	
	// 对应字段为：id
	private int id;
	
	// 对应字段为：img_url_list
	private JSONArray imgUrlList;
	
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public JSONArray getImgUrlList() {
		return imgUrlList;
	}
	public void setImgUrlList(JSONArray imgUrlList) {
		this.imgUrlList = imgUrlList;
	}
	
}

MyBatis的mapper文件为：

<?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="com.demo.entity.Test">
    <!-- select 有别名的情况： -->
   <resultMap id="listMap" type="com.demo.entity.Test">
     <!-- 这里省略普通字段，普通字段可以不用写，会自动映射 -->
     <!--column为字段名或者别名，如果select 字段有别名则为别名，property为Java实体类属性名 -->
    <result property="imgUrlList" javaType="com.alibaba.fastjson.JSONArray" column="imgUrlList" typeHandler="com.demo.mybatis.handler.JsonTypeHandler"/>
  </resultMap>
  <!-- 查询列表， -->
  <select id="select_list" resultMap="listMap">
  select id,img_url_list as "imgUrlList" from test
  </select>
  
  
   <!-- select 没有别名的情况： -->  
  <resultMap id="entityMap" type="com.demo.entity.Test">
     <!-- 这里省略普通字段，普通字段可以不用写，会自动映射 -->
     <!--column为字段名或者别名，如果select 字段有别名则为别名，property为Java实体类属性名 -->
    <result property="imgUrlList" javaType="com.alibaba.fastjson.JSONArray" column="img_url_list" typeHandler="com.demo.mybatis.handler.JsonTypeHandler"/>
  </resultMap>
  <!-- 查询一条数据， -->
  <select id="select_list2" resultMap="entityMap">
  select id,img_url_list from test
  </select>

  <insert id="insert" parameterType="Test">
  insert into test (id,img_url_list)
  values (#{id},#{imgUrlList ,typeHandler=com.demo.mybatis.handler.JsonTypeHandler})
  </insert>
    
  <update id="update" parameterType="Test">
  update test set img_url_list=#{imgUrlList ,typeHandler=com.demo.mybatis.handler.JsonTypeHandler} 
  where id=#{id}
  </update>

</mapper>

至此，成功解决了pgsql在MyBatis中json数据类型的问题。这个问题苦恼已久，终于得时间解决，特记之，以供参考。