Mybatis类型转换介绍 TypeHandler

 

1.1     目录
1.2     建立TypeHandler

1.2.1    TypeHandler接口

1.2.2    BaseTypeHandler抽象类

1.3     注册TypeHandler

1.4     Mybatis自动获取TypeHandler

1.5     Mybatis中自动注册的TypeHandler

 

1.2     建立TypeHandler
我们知道java有java的数据类型，数据库有数据库的数据类型，那么我们在往数据库中插入数据的时候是如何把java类型当做数据库类型插入数据库，在从数据库读取数据的时候又是如何把数据库类型当做java类型来处理呢？这中间必然要经过一个类型转换。在Mybatis中我们可以定义一个叫做TypeHandler类型处理器的东西，通过它可以实现Java类型跟数据库类型的相互转换。下面将就如何建立自己的TypeHandler做一个简要介绍。

 

1.3     注册TypeHandler

       建立了自己的TypeHandler之后就需要把它注册到Mybatis的配置文件中，让Mybatis能够识别并使用它。注册TypeHandler主要有两种方式，一种是通过在Mybatis配置文件中定义typeHandlers元素的子元素typeHandler来注册；另一种是通过在Mybatis配置文件中定义typeHandlers元素的子元素package来注册。使用typeHandler子元素注册时一次只能注册一个TypeHandler，而使用package子元素注册时，Mybatis会把指定包里面的所有TypeHandler都注册为TypeHandler。使用typeHandler子元素注册时我们需要通过它的handler属性来指明当前要注册的TypeHandler的全名称，这个属性是必须要的。另外还有两个附加属性可以指定，一个是javaType，用以指定对应的java类型；另一个是jdbcType，用以指定对应的jdbc类型。使用package子元素注册时需要我们通过它的name属性来指定要扫描的包，如果这个时候我们也需要指定对应TypeHandler的javaType和jdbcType的话就需要我们在TypeHandler类上使用注解来定义了。Mybatis注册TypeHandler最基本的方式就是建立一个javaType、jdbcType和TypeHandler的对应关系。在使用typeHandler子元素进行注册的时候，有三种类型的注册方式：

1.如果我们指定了javaType和jdbcType，那么Mybatis会注册一个对应javaType和jdbcType的TypeHandler。

2.如果我们只指定了javaType属性，那么这个时候又分两种情况：

（1）如果我们通过注解的形式在TypeHandler类上用@MappedJdbcTypes指定了对应的jdbcType，那么Mybatis会一一注册指定的javaType、jdbcType和TypeHandler的组合，也包括使用这种形式指定了jdbcType为null的情况。现假设我们有如下这样一个StringArrayTypeHandler：

Java代码  

@MappedJdbcTypes({JdbcType.VARCHAR})
public class StringArrayTypeHandler implements TypeHandler<String[]> {
    //..中间的实现代码省略了
    //..
}

 

package cn.util;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import org.apache.log4j.Logger;

/**
 * 日期类型转换
 * @author
 *
 */
public class MyDateHandler implements TypeHandler<String> {

 private Logger log = Logger.getLogger(MyDateHandler.class);
 private static DateFormat df = new SimpleDateFormat("yyyyMMdd");

 public String getResult(CallableStatement cs, int i) throws SQLException {

  return tranferType(cs.getDate(i));
 }

 public String getResult(ResultSet rs, int i) throws SQLException {
  log.info("*** Java类型的参数转换 setParameter " + i);

  return tranferType(rs.getDate(i));
 }

 /**
  * 用于在Mybatis获取数据结果集时如何把数据库类型转换为对应的Java类型
  */
 public String getResult(ResultSet rs, String column) throws SQLException {
  log.info("*** Java类型的参数转换 setParameter " + column);

  return tranferType(rs.getDate(column));
 }

 /**
  * 用于定义在Mybatis设置参数时该如何把Java类型的参数转换为对应的数据库类型
  */
 public void setParameter(PreparedStatement ps, int i, String b,
   JdbcType type) throws SQLException {
  log.info("*** Java类型的参数转换 setParameter");
  Date d=null;
  try {
   d = df.parse(b);
  } catch (ParseException e) {
   e.printStackTrace();
  }
  
  java.sql.Date sdate = new java.sql.Date(d.getTime());
  ps.setDate(i, sdate);
 }

 private String tranferType(Date d) {
  System.out.println("*******");
  Date dte=new Date(d.getTime());
  return df.format(dte);
 }

}

<typeAliases>
  <typeAlias alias="myDateHandler" type="cn.util.MyDateHandler" />
 </typeAliases>

 

<resultMap id="userDomain" type="cn.domain.User">
  <id property="userId" column="USERID" ></id>
  <result property="userName" column="USERNAME"></result>
  <result property="birthday" column="BIRTHDAY"></result>
  <result property="salary" column="SALARY"></result>
  
<!--   <result property="birthdayStr" column="BIRTHDAY" typeHandler="cn.util.MyDateHandler"></result> -->
  <result property="birthdayStr" column="BIRTHDAY" typeHandler="myDateHandler"></result>
 </resultMap>

 

public class User implements Serializable{
 
 private String userId;
 private String userName;
 private Date   birthday;
 private double salary;
 
 private String birthdayStr; //日期类型转换成字符串

}