mybatis自定義類型處理器TypehHandler示例詳解
前言
當(dāng)大家使用mybatis作為持久層框架時,在存儲和查詢數(shù)據(jù)時,只需要在mapper.xml文件中配置好對應(yīng)字段的JdbcType和JavaType,mybatis就可以幫我們轉(zhuǎn)化對應(yīng)的類型。這背后是有mybatis內(nèi)置的類型轉(zhuǎn)換器做轉(zhuǎn)換(可見源碼TypeHandlerRegistry)。但是有時候,我們會對某些字段做特殊處理,比如加密和解密、狀態(tài)轉(zhuǎn)換、類型轉(zhuǎn)換等。這個時候我們需要自定義類型轉(zhuǎn)換器。
類架構(gòu)
從上面的圖中可以看出MyBatis中整個類型處理器實現(xiàn)架構(gòu),TypeHandler接口定義了類型處理器,而TypeReference抽象類則定義了一個類型引用,用于引用一個泛型類型(此處很抽象,不好理解,詳見后續(xù)解析),BaseTypeHandler則是類型處理器的基礎(chǔ),是所有類型處理器的公共模塊,幾乎所有的類型處理器都是通過直接繼承BaseTypeHandler來實現(xiàn)的。
一、原理
使用場景:mybatis在預(yù)處理語句(PreparedStatement)中設(shè)置一個參數(shù)時,或者從結(jié)果集(ResultSet)中取出一個值時,都會用到TypeHandler。它的作用就是將java類型(javaType)轉(zhuǎn)化為jdbc類型(jdbcType),或者將jdbc類型(jdbcType)轉(zhuǎn)化為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è)置參數(shù),將T類型的數(shù)據(jù)存入數(shù)據(jù)庫。
getResult:通過列名或者下標(biāo)來獲取結(jié)果數(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è)務(wù)無感,使用相當(dāng)方便,也更加靈活。
參考 http://www.mybatis.org/mybatis-3/configuration.html#typeHandler
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關(guān)文章
Spring實現(xiàn)擁有者權(quán)限驗證的方法示例
這篇文章主要介紹了Spring實現(xiàn)擁有者權(quán)限驗證的方法示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03springboot用戶數(shù)據(jù)修改的詳細(xì)實現(xiàn)
用戶管理功能作為所有的系統(tǒng)是必不可少的一部分,下面這篇文章主要給大家介紹了關(guān)于springboot用戶數(shù)據(jù)修改的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-04-04Springboot如何統(tǒng)一處理Filter異常
這篇文章主要介紹了Springboot如何統(tǒng)一處理Filter異常問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-12-12springboot+quartz以持久化的方式實現(xiàn)定時任務(wù)的代碼
這篇文章主要介紹了springboot+quartz以持久化的方式實現(xiàn)定時任務(wù)的相關(guān)知識,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-07-07java中使用try-catch-finally一些值得注意的事(必看)
下面小編就為大家?guī)硪黄猨ava中使用try-catch-finally一些值得注意的事(必看)。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2016-08-08