在 MyBatis 里,如何将 JSON 型字段到 Java 类的映射

  • 一、简介
  • 二、源码
  • 三、QA

一、简介

我们在用MyBatis里,很多时间有这样一个需求:POJO里有个属性是非基本数据类型,在DB存储时我们想存的是json格式的字符串,从DB拿出来时想直接映射成目标类型,也即json格式的字符串字段与Java类的相互类型转换

当然,你可以为每个类写一个MyClassTypeHandler,但问题是要为每个类都写一个TypeHandler,过于繁琐。

有了泛型,一个通用的TypeHandler直接搞定。

二、源码

package com.adu.spring_test.mybatis.typehandler;
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.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig.Feature;
import org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion;
/**
 * mapper里json型字段到类的映射。
 * 用法一:
 * 入库:#{jsonDataField, typeHandler=com.adu.spring_test.mybatis.typehandler.JsonTypeHandler}
 * 出库:
 * <resultMap>
 * <result property="jsonDataField" column="json_data_field" javaType="com.xxx.MyClass" typeHandler="com.adu.spring_test.mybatis.typehandler.JsonTypeHandler"/>
 * </resultMap>
 *
 * 用法二:
 * 1)在mybatis-config.xml中指定handler:
 * <typeHandlers>
 * <typeHandler handler="com.adu.spring_test.mybatis.typehandler.JsonTypeHandler" javaType="com.xxx.MyClass"/>
 * </typeHandlers>
 * 2)在MyClassMapper.xml里直接select/update/insert。
 *
 *
 * @author yunjie.du
 * @date 2016/5/31 19:33
 */
public class JsonTypeHandler<T extends Object> extends BaseTypeHandler<T> {
 private static final ObjectMapper mapper = new ObjectMapper();
 private Class<T> clazz;
 public JsonTypeHandler(Class<T> clazz) {
 if (clazz == null) throw new IllegalArgumentException("Type argument cannot be null");
 this.clazz = clazz;
 }
 @Override
 public void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
 ps.setString(i, this.toJson(parameter));
 }
 @Override
 public T getNullableResult(ResultSet rs, String columnName) throws SQLException {
 return this.toObject(rs.getString(columnName), clazz);
 }
 @Override
 public T getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
 return this.toObject(rs.getString(columnIndex), clazz);
 }
 @Override
 public T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
 return this.toObject(cs.getString(columnIndex), clazz);
 }
 private String toJson(T object) {
 try {
 return mapper.writeValueAsString(object);
 } catch (Exception e) {
 throw new RuntimeException(e);
 }
 }
 private T toObject(String content, Class<?> clazz) {
 if (content != null && !content.isEmpty()) {
 try {
 return (T) mapper.readValue(content, clazz);
 } catch (Exception e) {
 throw new RuntimeException(e);
 }
 } else {
 return null;
 }
 }
 static {
 mapper.configure(Feature.WRITE_NULL_MAP_VALUES, false);
 mapper.setSerializationInclusion(Inclusion.NON_NULL);
 }
}

三、QA

3.1 Q:Cause: java.lang.RuntimeException: Unable to find a usable constructor for class

A:mybatis版本过低,类型不能识别,造成通用typeHandler的构造函数构造失败。之前用3.1.1时报过这个错,后来改成3.2.3就没问题了,现在用3.4.0也没问题。贴上现在的配置吧:

<!-- mybatis -->
<dependency>
 <groupId>org.mybatis</groupId>
 <artifactId>mybatis</artifactId>
 <version>3.4.0</version>
</dependency>
<dependency>
 <groupId>org.mybatis</groupId>
 <artifactId>mybatis-spring</artifactId>
 <version>1.3.0</version>
</dependency>

来源:http://sina.lt/gmJ3


:-D 搜索微信号(ID:芋道源码),可以获得各种 Java 源码解析、原理讲解、面试题、学习指南。

:-D 并且,回复【书籍】后,可以领取笔者推荐的各种 Java 从入门到架构的 100 本书籍。

:-D 并且,回复【技术群】后,可以加入专门讨论 Java、后端、架构的技术群。

在 MyBatis 里,如何将 JSON 型字段到 Java 类的映射

来吧,骚年~

相关推荐