MyBatis(3.2.3)类型处理器TypeHandlers的简单示例

MyBatis通过抽象JDBC来简化了数据持久化逻辑的实现。MyBatis在其内部使用JDBC，提供了更简洁的方式实现了数据库操作。当MyBatis将一个Java对象作为输入参数执行INSERT语句操作时，它会创建一个PreparedStatement对象，并且使用setXXX()方式对占位符设置相应的参数值。XXX可以是Int，String，Date等Java对象属性类型的任意一个，甚至是用户自定义的类型。MyBatis通过使用类型处理器（type handlers）来决定XXX时何种类型。MyBatis对于以下的类型使用内建的类型处理器：所有的基本数据类型、基本类型的包裹类型、byte[] 、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java 枚举类型等。对于用户自定义的类型，我们创建一个自定义的类型处理器。

1. 假设表teachers有一个tel字段，类型为VARCHAR(20)，而JavaBean Teacher有一个Tel类定义类型的tel属性。

DROP TABLE IF EXISTS teachers;
CREATE TABLE teachers
(
	tch_id INTEGER NOT NULL,
	tch_name VARCHAR(50) NOT NULL,
	birthday DATE,
	tel VARCHAR(20),
	PRIMARY KEY (tch_id)
) ;

package com.huey.mybatis.entity;

/**
 * 电话号码，由区号和号码组成
 * @author huey2672
 * @version 1.0
 * @created 2014-7-26
 */
public class Tel {

	private String cityCode;
	private String number;
	
	public String getCityCode() {
		return cityCode;
	}
	
	public void setCityCode(String cityCode) {
		this.cityCode = cityCode;
	}
	
	public String getNumber() {
		return number;
	}
	
	public void setNumber(String number) {
		this.number = number;
	}
	
	public Tel() {
		super();
	}

	public Tel(String cityCode, String number) {
		super();
		this.cityCode = cityCode;
		this.number = number;
	}
	
	/**
	 * 用完整的电话号码字符串构造
	 * @param fullNumber
	 */
	public Tel(String fullNumber) {
		if (fullNumber != null) {
			String[] parts = fullNumber.split("-");
			if (parts.length > 0) {
				cityCode = parts[0];
			}
			if (parts.length > 1) {
				number = parts[1];
			}
		}
	}
	
	public String getFullNumber() {
		return cityCode + "-" + number;		
	}
	
	@Override
	public String toString() {
		return getFullNumber();
	}
	
}

2. 在TeacherMapper.xml中

<insert id="addTeacher" parameterType="Teacher">
	insert into teachers(tch_id, tch_name, birthday, tel)
	values(#{id}, #{name}, #{birthday}, #{tel})
</insert>

tel参数需要传递给#{tel}，而tel对象是Tel类型。然而，MyBatis并不知道该怎样来处理这个类型的对象。为了让MyBatis明白怎样处理这个自定义的Java对象类型Tel，我们可以创建一个自定义的类型处理器TelTypeHandler：

package com.huey.mybatis.typehandlers;

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 com.huey.mybatis.entity.Tel;

/**
 * 类型处理器TelTypeHandlers，继承BaseTypeHandler<T>
 * 当mybatis进行JDBC操作时，将自定义类型Tel转换成数据库中相应的列属性
 * 当从SQL结果集构建 JavaBean时，也有类似的过程
 * @author huey2672
 * @version 1.0
 * @created 2014-7-26
 */
public class TelTypeHandler extends BaseTypeHandler<Tel> {

	@Override
	public Tel getNullableResult(ResultSet rs, String columnName)
			throws SQLException {
		// 使用rs.getString是tel字段是VARCHER类型
		return new Tel(rs.getString(columnName));
	}

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

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

	@Override
	public void setNonNullParameter(PreparedStatement ps, int i,
			Tel param, JdbcType jdbcType) throws SQLException {
		ps.setString(i, param.getFullNumber());
	}

}

3. 一旦我们实现了自定义的类型处理器，我们需要在配置文件mybatis-config.xml中注册它：

<!-- 注册自定义类型处理器 -->
<typeHandlers>
	<typeHandler handler="com.huey.mybatis.typehandlers.TelTypeHandler" />
</typeHandlers>