自定义mybatis TypeHandler

TypeHandler 说明

TypeHandler 是mybatis中重要的一个接口，定义了 java 类型的对象在和数据库交互的时候如果设置参数和从读取到的结果中获取值。

并且已经将常见的类型的处理器默认内置了，在插入和读取数据的时候会根据对应的数据类型找到对应的类型处理器。

mybatis自定义TypeHandler

对于一些非基本数据类型的字段，比如一个自定义类作为数据对象的一个属性，并且希望以特殊的格式映射到数据库中，在读取的时候能读取成java中的数据类型。用内置的typeHanlder 是一定不能满足需求的，
这就需要对typeHandler进行拓展。

最常见的例子就是将一个对象的某些数据以json序列化的方式存储在数据库中，读取出来的时候能够反序列化对应的java bean。

实体对象User

其中有2个自定义属性，都希望能够使用json的方式解析和转换。

public class User {

    private Long id;

    private String name;

    private Address address;

    private Info info;

}


public class Address {

    private String province;

    private String city;

    private Integer code;

    private Double longitude;

    private Double latitude;

}



public class Info {

    private String message;

}

自定义一个typeHandler 类，继承 BaseTypeHandler,并实现对应的4个方法。
主要是设置参数和获取结果值的方式的自定义实现。


public class JsonTypeHandler<T> extends BaseTypeHandler<T> {

    private ObjectMapper objectMapper = new ObjectMapper();

    private Class<T> clzType;

    public JsonTypeHandler(Class<T> type) {
        this.clzType = type;
    }

    public JsonTypeHandler() {
       
    }


    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, objectToJson(parameter));
    }

    @Override
    public T getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return jsonToObject(rs.getString(columnName));
    }

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

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

    private T jsonToObject(String strValue){
        if(StringUtils.isEmpty(strValue)){
            return null;
        }
        try {
            return objectMapper.readValue(strValue, clzType);
        } catch (JsonProcessingException e) {
            throw  new RuntimeException(e.getMessage());
        }
    }


    private String objectToJson(T param) {
        if (param == null) {
            return null;
        }
        try {
            return objectMapper.writeValueAsString(param);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
            throw new IllegalArgumentException(e.getMessage());
        }
    }
}

现在typeHandler 已经定义好了，下面要做的是怎么在插入数据和查询结果的时候能够使用自定义的typeHandler.

在编写mapper文件的时候，resultMap.result 可以指定对应的typeHandler,在输入参数的时候也可以指定typeHandler

<resultMap id="baseResultMap" type="com.demo.entity.User" >
       <id column="id" jdbcType="BIGINT" property="id" />
       <result column="name" jdbcType="VARCHAR" property="name" />
       <result column="address" jdbcType="VARCHAR" property="address" typeHandler="com.demo.conf.type_handlers.JsonTypeHandler"   />
       <result column="info" jdbcType="VARCHAR" property="info"   typeHandler="com.demo.conf.type_handlers.JsonTypeHandler" />
   </resultMap>


  <insert id="saveUser" useGeneratedKeys="true"  keyColumn="id" keyProperty="id">
       insert into `user`(`name`,address,info) values (#{name},#{address,typeHandler=com.demo.conf.type_handlers.JsonTypeHandler},#{info,typeHandler=com.demo.conf.type_handlers.JsonTypeHandler});
   </insert>

通过这种方式就完成了对应的类型和typeHanlder的一种 强制绑定。

编写测试代码


@Test
   public void save(){
       User user =new User();
       user.setName("33");
       Address address = new Address();
       address.setProvince("北京");
       address.setCity("北京");
       address.setCode(110000);
       address.setLongitude(115.25);
       address.setLatitude(39.26);

       Info info = new Info();
       info.setMessage(UUID.randomUUID().toString());

       user.setAddress(address);
       user.setInfo(info);
       int count = userMapper.saveUser(user);
       
       System.out.println(user.getId());

       List<User> users = userMapper.selectAll();
       System.out.println(users);
   }

数据库里已经成功插入json数据并且也能正常读取。

上面的那种方式虽然能够完成要求，但是需要在每个mapper.xml 文件中写死对应的handler，需要配置一个统一全局的配置。

1
2
3

@MappedTypes(value = {Address.class, Info.class})
@MappedJdbcTypes(value = {JdbcType.VARCHAR,JdbcType.VARCHAR})
public class JsonTypeHandler<T> extends BaseTypeHandler<T> {

这里用到2个注解:
@MappedTypes 表示那些数据类型应用此handler
@MappedJdbcTypes 表示对应的数据库类型


@Bean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
    factoryBean.setDataSource(dataSource);
    PathMatchingResourcePatternResolver pathMatchingResourcePatternResolver = new PathMatchingResourcePatternResolver();
    Resource[] resources = pathMatchingResourcePatternResolver.getResources("classpath:mappers/com/demo/mapper/*.xml");
    factoryBean.setMapperLocations(resources);
    factoryBean.setTypeHandlersPackage("com.demo.conf.type_handlers");
    return factoryBean.getObject();
}

删除对应的mapper.xml 文件中指定的typehandler

    <resultMap id="baseResultMap" type="com.demo.entity.User" >
        <id column="id" jdbcType="BIGINT" property="id" />
        <result column="name" jdbcType="VARCHAR" property="name" />
<!--        <result column="address" jdbcType="VARCHAR" property="address" typeHandler="com.demo.conf.type_handlers.JsonTypeHandler"   />-->
<!--        <result column="info" jdbcType="VARCHAR" property="info"   typeHandler="com.demo.conf.type_handlers.JsonTypeHandler" />  -->
      <result column="address" jdbcType="VARCHAR" property="address"    />
        <result column="info" jdbcType="VARCHAR" property="info"    />
    </resultMap>

    <insert id="saveUser" useGeneratedKeys="true"  keyColumn="id" keyProperty="id">
        insert into `user`(`name`,address,info) values (#{name},#{address},#{info});
    </insert>