1. Mybatis TypeHandler简介
Mybatis 在预处理语句中设置一个参数,或者从结果集中取出一个值,都会用注册了的typeHandel处理。
因为不同得数据库厂商的数据类型有所不同,我们也可以自定义typeHandel,来设置Java传入数据库中的数据类型 ,及从数据库中取数据到java的数据类型。
这里存在两个概念,JavaType及JdbcType,TypeHandler就是定义这两个类型之间的转换。
Mybatis已经系统定义了一些常见的typeHande,在Mybatis 的源码中 TypeHandlerRegistry中可以看到已经被注册的TypeHandler:
查看Mybatis已经注册的IntegerTypeHandler 源码,能看到IntegerTypeHandler 继承了BaseTypeHandler,而BaseTypeHandler实现了TypeHandler。
public class IntegerTypeHandler extends BaseTypeHandler<Integer> {
@Override
public void setNonNullParameter(PreparedStatement ps, int i, Integer parameter, JdbcType jdbcType)
throws SQLException {
ps.setInt(i, parameter);
}
@Override
public Integer getNullableResult(ResultSet rs, String columnName)
throws SQLException {
return rs.getInt(columnName);
}
@Override
public Integer getNullableResult(ResultSet rs, int columnIndex)
throws SQLException {
return rs.getInt(columnIndex);
}
@Override
public Integer getNullableResult(CallableStatement cs, int columnIndex)
throws SQLException {
return cs.getInt(columnIndex);
}
}
public interface TypeHandler<T> {
// 使用预编译设置参数
void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;
// 根据列名获取结果数据
T getResult(ResultSet rs, String columnName) throws SQLException;
// 根据列下标获取结果数据
T getResult(ResultSet rs, int columnIndex) throws SQLException;
// 根据存储结果获取结果数据
T getResult(CallableStatement cs, int columnIndex) throws SQLException;
}
2. 自定义TypeHandler
自定义typeHandler并使用,共有两个步骤
- 自定义TypeHandler,继承BaseTypeHandler或者实现TypeHandler
- 在mapper中配置所需要自定义TypeHandler的地方,如resultMap中指定参数。
步骤:
- 我们自定义TypeHandler的时候,继承BaseTypeHandler,实现TypeHandler定义的四个方法即可。如下
// 定义的是JdbcType类型
@MappedJdbcTypes({JdbcType.VARCHAR})
// 定义的时JavaType类型
@MappedTypes({Date.class})
public class MyDateTypeHandler extends BaseTypeHandler<Date> {
public void setNonNullParameter(PreparedStatement preparedStatement, int i, Date date, JdbcType jdbcType) throws SQLException {
preparedStatement.setString(i, String.valueOf(date.getTime()));
}
public Date getNullableResult(ResultSet resultSet, String s) throws SQLException {
return new Date(resultSet.getLong(s));
}
public Date getNullableResult(ResultSet resultSet, int i) throws SQLException {
return new Date(resultSet.getLong(i));
}
public Date getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
return callableStatement.getDate(i);
}
}
- 我们定义了MyDateTypeHandler,需要在mapper中配置:
- 查询时,查询时我们配置resultMap
- 插入、修改时,我们有三种配置方式
- javaType,jdbcType ,TypeHandler都指定
- 指定javaType,jdbcType
- 只指定typeHandler
<!--配置resultMap-->
<resultMap id="userResultMap" type="org.sang.bean.User">
<result typeHandler="org.sang.db.MyDateTypeHandler" column="regTime" javaType="java.util.Date"
jdbcType="VARCHAR"
property="regTime"/>
</resultMap>
<!--查询-->
<select id="getUser" resultMap="userResultMap">
select * from user4
</select>
<!--1. javaType,jdbcType ,TypeHandler都指定-->
<insert id="insertUser" parameterType="org.sang.bean.User">
INSERT INTO user4(username,password,regTime) VALUES (#{username},#{password},#{regTime,javaType=Date,jdbcType=VARCHAR,typeHandler=org.sang.db.MyDateTypeHandler})
</insert>
<!--2. 指定javaType,jdbcType-->
<insert id="insertUser2">
INSERT INTO user4(username,password,regTime) VALUES (#{username},#{password},#{regTime,javaType=Date,jdbcType=VARCHAR})
</insert>
<!--3. 只指定typeHandler-->
<insert id="insertUser3">
INSERT INTO user4(username,password,regTime) VALUES (#{username},#{password},#{regTime,typeHandler=org.sang.db.MyDateTypeHandler})
</insert>
除了在mapper文件中配置,我们也可以通过配置文件将typeHandler注册进去,但是这种方式只能结果读取时数据的转换
mybatis:
# 配置扫描包
typeHandlersPackage: com.hc.etf.config.typeHandel
3. 枚举类型TypeHandler
枚举类型的TypheHandler有自己的特殊规则,Mybatis已经注册了两个枚举类型的TypeHandler供我们使用:
- EnumTypeHandler :使用
枚举字符串名称
作为参数传递 - EnumOrdinalTypeHandler:使用
枚举下标
作为参数传递,坐标从0开始
实际情况中,我们使用枚举是希望使用自己定义的字段,所以通常会自己自定义TypeHandler。
下面我们先介绍以下已经被注册的两种TypeHandler,再自己自定义一个枚举类型的TypeHandler。
// 定义一个性别枚举
public enum Sex{
MALE(1,"男"),
FEMALE(2,"女");
private Integer id;
private String name;
// 这里省略构造函数,及set、get方法
}
// 定义一个用户类
public class User{
private Integer id;
private String name;
private Sex sex;
// 这里省略构造函数,及set、get方法
}
3.1. EnumTypeHandler
EnumTypeHandler是默认的枚举类型的处理器,默认情况下,MyBatis 会利用 EnumTypeHandler
来把 Enum
值转换成对应的名字。不过若jdbcType类型为数据类型时,会使用EnumOrdinalTypeHandler。
在mapper 中不进行typeHandler的配置,默认使用EnumTypeHandler处理,存储的是枚举名称。
3.2. EnumOrdinalTypeHandler
若想使用EnumOrdinalTypeHandler,且jdbcType不是数值类型,则需在mapper中配置,同上文配置方式。则存储的是枚举定义的下标(从0开始),取出也是根据下标进行准换。
例如Sex枚举类,MALE的下标是0,FEMALE下标是1
3.3. 自定义枚举类型TypeHandler
在mapper中配置自定义的typeHandler,这时插入数据时,存储的sex中的name,
例如MALE是男
,FEMALE是女
参考:
《深入浅出MyBatis技术原理与实战》