mybatis自定義類型處理器TypehHandler示例詳解

更新時間：2018年09月11日 09:39:03 作者：xwlmdd

我們在寫mapper映射器的配置文件時，不經意間已經用到類型轉換，不過是mybatis幫我們完成的，下面這篇文章主要給大家介紹了關于mybatis自定義類型處理器TypehHandler的相關資料，需要的朋友可以參考下

前言

當大家使用mybatis作為持久層框架時，在存儲和查詢數(shù)據(jù)時，只需要在mapper.xml文件中配置好對應字段的JdbcType和JavaType，mybatis就可以幫我們轉化對應的類型。這背后是有mybatis內置的類型轉換器做轉換（可見源碼TypeHandlerRegistry）。但是有時候，我們會對某些字段做特殊處理，比如加密和解密、狀態(tài)轉換、類型轉換等。這個時候我們需要自定義類型轉換器。

類架構

從上面的圖中可以看出MyBatis中整個類型處理器實現(xiàn)架構，TypeHandler接口定義了類型處理器，而TypeReference抽象類則定義了一個類型引用，用于引用一個泛型類型（此處很抽象，不好理解，詳見后續(xù)解析），BaseTypeHandler則是類型處理器的基礎，是所有類型處理器的公共模塊，幾乎所有的類型處理器都是通過直接繼承BaseTypeHandler來實現(xiàn)的。

一、原理

使用場景：mybatis在預處理語句（PreparedStatement）中設置一個參數(shù)時，或者從結果集（ResultSet）中取出一個值時，都會用到TypeHandler。它的作用就是將java類型（javaType）轉化為jdbc類型（jdbcType），或者將jdbc類型（jdbcType）轉化為java類型（javaType）。

二、自定義類型處理器

實現(xiàn)TypeHandler接口或者繼承BaseTypehandler

TypeHandler是一個接口，它定義了如下四個方法，實現(xiàn)類必須去實現(xiàn)，方法如下：

 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對象設置參數(shù)，將T類型的數(shù)據(jù)存入數(shù)據(jù)庫。

getResult：通過列名或者下標來獲取結果數(shù)據(jù)，也可以通過CallableStatement獲取數(shù)據(jù)。

三、案例（自定義敏感字段加解密處理器）

MyTypeHandler實現(xiàn)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層就可以解決，對上層業(yè)務無感，使用相當方便，也更加靈活。

參考 http://www.mybatis.org/mybatis-3/configuration.html#typeHandler

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

您可能感興趣的文章: