當大家使用mybatis作為持久層框架時,在存儲和查詢數據時,只需要在mapper.xml文件中配置好對應字段的JdbcType和JavaType,mybatis就可以幫我們轉化對應的類型。這背后是有mybatis內置的類型轉換器做轉換(可見源碼TypeHandlerRegistry)。但是有時候,我們會對某些字段做特殊處理,比如加密和解密、狀態轉換、類型轉換等。這個時候我們需要自定義類型轉換器。
一、原理
使用場景:mybatis在預處理語句(PreparedStatement)中設置一個參數時,或者從結果集(ResultSet)中取出一個值時,都會用到TypeHandler。它的作用就是將java類型(javaType)轉化為jdbc類型(jdbcType),或者將jdbc類型(jdbcType)轉化為java類型(javaType)。
二、自定義類型處理器
- 實現TypeHandler接口或者繼承BaseTypehandler
TypeHandler是一個接口,它定義了如下四個方法,實現類必須去實現,方法如下:
void setParameter(PreparedStatement var1, int var2, T var3,JdbcType var4) throws SQLException;
T getResult(ResultSet var1, String var2) throws SQLException;
T getResult(ResultSet var1, int var2) throws SQLException;
T getResult(CallableStatement var1, int var2) throws SQLException;
}
-
setParameter:通過preparedStatement對象設置參數,將T類型的數據存入數據庫。
-
getResult:通過列名或者下標來獲取結果數據,也可以通過CallableStatement獲取數據。
三、案例(自定義敏感字段加解密處理器)
- MyTypeHandler實現TypeHandler接口
package com.mdd.mybatis.typehandle;
import com.mdd.mybatis.util.DESUtil;
import org.apache.commons.lang3.StringUtils;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
public class MyTypeHandle implements TypeHandler<String> {
private static String KEY = "123456";
@Override
public void setParameter(PreparedStatement preparedStatement, int i, String s, JdbcType jdbcType) throws SQLException {
try {
String encrypt = DESUtil.encrypt(s, KEY);
preparedStatement.setString(i, encrypt);
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public String getResult(ResultSet resultSet, String s) throws SQLException {
String result = resultSet.getString(s);
if (StringUtils.isNotEmpty(result)) {
try {
return DESUtil.decrypt(result, KEY);
} catch (Exception e) {
e.printStackTrace();
}
}
return result;
}
@Override
public String getResult(ResultSet resultSet, int i) throws SQLException {
String result = resultSet.getString(i);
if (StringUtils.isNotEmpty(result)) {
try {
return DESUtil.decrypt(result, KEY);
} catch (Exception e) {
e.printStackTrace();
}
}
return result;
}
@Override
public String getResult(CallableStatement callableStatement, int i) throws SQLException {
String result = callableStatement.getString(i);
if (StringUtils.isNotEmpty(result)) {
try {
return DESUtil.decrypt(result, KEY);
} catch (Exception e) {
e.printStackTrace();
}
}
return result;
}
}
- 配置注冊自定義處理器(mybatis.cfg.xml)
<!--自定義類型處理器-->
<typeHandlers>
<typeHandler handler="com.mdd.mybatis.typehandle.MyTypeHandle"></typeHandler>
</typeHandlers>
- 使用自定義處理器(mapper文件)
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.mdd.mybatis.dao.UserDao" >
<resultMap id="BaseResultMap" type="com.mdd.mybatis.dao.vo.User">
<id column="user_id" property="userId" jdbcType="VARCHAR"/>
<result column="name" property="name" typeHandler="com.mdd.mybatis.typehandle.MyTypeHandle"/>
<result column="password" property="password" jdbcType="VARCHAR"/>
<result column="age" property="age" jdbcType="INTEGER"/>
</resultMap>
<sql id="Base_Column_List" >
user_id,name,password, age
</sql>
<insert id="saveUser">
INSERT INTO t_user(user_id,name, password, age) VALUES (
#{userId,jdbcType=VARCHAR},#{name,jdbcType=VARCHAR},
#{password,jdbcType=VARCHAR},#{age,jdbcType=INTEGER}
)
</insert>
<insert id="saveUserWithType">
INSERT INTO t_user(user_id,name, password, age) VALUES (
#{userId,jdbcType=VARCHAR},#{name,typeHandler=com.mdd.mybatis.typehandle.MyTypeHandle},
#{password,jdbcType=VARCHAR},#{age,jdbcType=INTEGER}
)
</insert>
<select id="queryUser" resultMap="BaseResultMap">
select * from t_user where user_id = #{userId,jdbcType=VARCHAR}
</select>
</mapper>
通過上面的配置,自定義的TypeHandler就會生效,敏感字段的加解密在dao層就可以解決,對上層業務無感,使用相當方便,也更加靈活。
參考 http://www.mybatis.org/mybatis-3/configuration.html#typeHandler