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

2025-05-29 0 96

前言

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

类架构

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

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

一、原理

使用场景:mybatis在预处理语句(preparedstatement)中设置一个参数时,或者从结果集(resultset)中取出一个值时,都会用到typehandler。它的作用就是将java类型(javatype)转化为jdbc类型(jdbctype),或者将jdbc类型(jdbctype)转化为java类型(javatype)。

二、自定义类型处理器

实现typehandler接口或者继承basetypehandler

typehandler是一个接口,它定义了如下四个方法,实现类必须去实现,方法如下:

?

1

2

3

4

5

6

7

8
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接口

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64
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)

?

1

2

3

4
<!--自定义类型处理器-->

<typehandlers>

<typehandler handler="com.mdd.mybatis.typehandle.mytypehandle"></typehandler>

</typehandlers>

使用自定义处理器(mapper文件)

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33
<?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

总结

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

原文链接:http://www.cnblogs.com/xwlhyy1072552712/p/9615877.html

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

快网idc优惠网 建站教程 mybatis自定义类型处理器TypehHandler示例详解 https://www.kuaiidc.com/111202.html

相关文章

发表评论
暂无评论