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

总结

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

(0)

相关推荐

  • MyBatis使用自定义TypeHandler转换类型的实现方法

    MyBatis虽然有很好的SQL执行性能,但毕竟不是完整的ORM框架,不同的数据库之间SQL执行还是有差异. 笔者最近在升级 Oracle 驱动至 ojdbc 7 ,就发现了处理DATE类型存在问题.还好MyBatis提供了使用自定义TypeHandler转换类型的功能. 本文介绍如下使用 TypeHandler 实现日期类型的转换. 问题背景 项目中有如下的字段,是采用的DATE类型: birthday = #{birthday, jdbcType=DATE}, 在更新 Oracle 驱动之前

  • ASP.NET Core应用错误处理之ExceptionHandlerMiddleware中间件呈现“定制化错误页面”

    前言 DeveloperExceptionPageMiddleware中间件利用呈现出来的错误页面实现抛出异常和当前请求的详细信息以辅助开发人员更好地进行纠错诊断工作,而ExceptionHandlerMiddleware中间件则是面向最终用户的,我们可以利用它来显示一个友好的定制化的错误页面.按照惯例,我们还是先来看看ExceptionHandlerMiddleware的类型定义. public class ExceptionHandlerMiddleware { public Excepti

  • 花样使用Handler与源码分析

    前几天在跟公司大佬讨论一个问题时,看到他使用Handler的一种方式,旁边的同事在说:以前不是这么用的啊.这个问题引发了我的好奇,虽然当时翻清楚道理了,但是还是想给大家分享一下. Handler在之前也说到过他的使用以及源码分析,而且相信大家都知道如何使用它,最常见的使用方法恐怕就是下面这种了: Handler handler = new Handler(){ @Override public void handleMessage(Message msg) { super.handleMessa

  • Spring MVC学习教程之RequestMappingHandlerAdapter详解

    前言 RequestMappingHandlerAdapter实现了HandlerAdapter接口,顾名思义,表示handler的adapter,这里的handler指的是Spring处理具体请求的某个Controller的方法,也就是说HandlerAdapter指的是将当前请求适配到某个Handler的处理器.RequestMappingHandlerAdapter是HandlerAdapter的一个具体实现,主要用于将某个请求适配给@RequestMapping类型的Handler处理.

  • Spring MVC学习教程之RequestMappingHandlerMapping匹配

    前言 对于RequestMappingHandlerMapping,使用Spring的同学基本都不会陌生,该类的作用有两个: 通过request查找对应的HandlerMethod,即当前request具体是由Controller中的哪个方法进行处理: 查找当前系统中的Interceptor,将其与HandlerMethod封装为一个HandlerExecutionChain. 本文主要讲解RequestMappingHandlerMapping是如何获取HandlerMethod和Interc

  • .Net WebApi消息拦截器之MessageHandler的示例

    消息拦截器是一个类,接收 HTTP request并返回 HTTP response,Message handler 继承自抽象类 HttpMessageHandler 可以自定义 MessageHandler,消息拦截器的作用如: 读取或更改请求头 request headers 添加 response headers 在到达 controller 之前,进行参数验证 自定义 Message Handlers 自定义 MessageHandler 需要继承 System.Net.Http.De

  • 深入Android HandlerThread 使用及其源码完全解析

    关联篇:深入Android的消息机制源码详解-Handler,MessageQueue与Looper关系 关联篇:Handler内存泄漏及其解决方案 本篇我们将来给大家介绍HandlerThread这个类,以前我们在使用线程执行一个耗时任务时总会new一个Thread的线程去跑,当任务执行完后,线程就会自动被销毁掉,如果又由新的任务,我们又得新建线程.....我们假设这样的一个情景,我们通过listview去加载图文列表,当我们往下滑动时,这时需要不断去请求网络资源,也就是需要不断开线程去加载

  • springmvc中RequestMappingHandlerAdapter与HttpMessageConverter的装配讲解

    一.DispatcherServlet 默认装配 RequestMappingHandlerAdapter ,而 RequestMappingHandlerAdapter 默认装配如下 HttpMessageConverter HttpMessageConverter: 2)加入jackson jar 包后,RequestMappingHandlerAdapter 装配的HttpMessageConverter 如下: 二. HttpMessageConverter 1)HttpMessageC

  • Python中logging.NullHandler 的使用教程

    在使用 peewee 框架时,默认是不会出现日志消息的. from peewee import Model, CharField, DateTimeField, IntegerField from peewee_mssql import MssqlDatabase db = MssqlDatabase(database='test', host='.', user='sa', password='sa') class BaseModel(Model): class Meta: database

  • 深入Android Handler,MessageQueue与Looper关系

    关联篇:HandlerThread 使用及其源码完全解析 关联篇:Handler内存泄漏详解及其解决方案 一说到Android的消息机制,自然就会联想到Handler,我们知道Handler是Android消息机制的上层接口,因此我们在开发过程中也只需要和Handler交互即可,很多人认为Handler的作用就是更新UI,这也确实没错,但除了更新UI,Handler其实还有很多其他用途,比如我们需要在子线程进行耗时的I/O操作,可能是读取某些文件或者去访问网络等,当耗时操作完成后我们可能需要在U

随机推荐