mybatis自定义类型处理器TypehHandler示例详解

更新时间：2018年09月11日 09:39:03 作者：xwlmdd

我们在写mapper映射器的配置文件时，不经意间已经用到类型转换，不过是mybatis帮我们完成的，下面这篇文章主要给大家介绍了关于mybatis自定义类型处理器TypehHandler的相关资料，需要的朋友可以参考下

前言

当大家使用mybatis作为持久层框架时，在存储和查询数据时，只需要在mapper.xml文件中配置好对应字段的JdbcType和JavaType，mybatis就可以帮我们转化对应的类型。这背后是有mybatis内置的类型转换器做转换（可见源码TypeHandlerRegistry）。但是有时候，我们会对某些字段做特殊处理，比如加密和解密、状态转换、类型转换等。这个时候我们需要自定义类型转换器。

类架构

从上面的图中可以看出MyBatis中整个类型处理器实现架构，TypeHandler接口定义了类型处理器，而TypeReference抽象类则定义了一个类型引用，用于引用一个泛型类型（此处很抽象，不好理解，详见后续解析），BaseTypeHandler则是类型处理器的基础，是所有类型处理器的公共模块，几乎所有的类型处理器都是通过直接继承BaseTypeHandler来实现的。

一、原理

使用场景：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

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

Log4j.properties配置及其使用
本文主要介绍了Log4j.properties配置及其使用，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-08-08
Struts2 ActionContext 中的数据详解
这篇文章主要介绍了Struts2 ActionContext 中的数据详解,需要的朋友可以参考下
2016-07-07
java 类加载与自定义类加载器详解
本文主要介绍了java 类加载与自定义类加载器。具有一定的参考价值，下面跟着小编一起来看下吧
2017-01-01
Java中多态性的实现方式
这篇文章主要介绍了Java中多态性的实现方式，什么是多态？通过简单的一道题目帮大家理解java多态性，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-09-09
Spring MVC 拦截器实现代码
本篇文章主要介绍了Spring MVC 拦截器的相关资料,具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
2017-02-02
JAVA 自定义线程池的最大线程数设置方法
这篇文章主要介绍了JAVA 自定义线程池的最大线程数设置方法，文中示例代码非常详细，供大家参考和学习，感兴趣的朋友可以了解下
2020-06-06
java 指定某个jdk版本方法
这篇文章主要介绍了java 指定某个jdk版本方法的相关资料,需要的朋友可以参考下
2017-05-05
SpringBoot启动并初始化执行sql脚本问题
这篇文章主要介绍了SpringBoot启动并初始化执行sql脚本问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-01-01
spring-boot整合ehcache实现缓存机制的方法
spring-boot是一个快速的集成框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。这篇文章主要介绍了spring-boot整合ehcache实现缓存机制,需要的朋友可以参考下
2018-01-01
Kafka Producer中的消息缓存模型图解详解
Kafka中消息是以Topic进行分类的,生产者生产消息,消费者消费消息,都是面向Topic的,下面这篇文章主要给大家介绍了关于Kafka Producer中消息缓存模型的相关资料,需要的朋友可以参考下
2022-04-04

mybatis自定义类型处理器TypehHandler示例详解

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具