[Mybatis] TypeHandler的简单应用及源码分析

TypeHandlers

无论是 MyBatis 在预处理语句(PreparedStatement)中设置一个参数时,还是从结果集中取出一个值时, 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。

下面是常见的一些对应类型:


对应类型示例
对应类型示例

以BigDecimalTypeHandler看一下,它主要完成了哪些工作。


BigDecimalTypeHandler
BigDecimalTypeHandler

这个类的第一个方法是对预处理语句(PreparedStatement)设置参数,之后的三个函数都是从ResultSet或者用于执行存储过程的CallableStatement语句中获取BigDecimal类型的数值,用于向BigDecimal类型的Java字段赋值。
BigDecimalTypeHandler继承的BaseTypeHandler是个泛型类,其他的TypeHandler也是通过继承这个抽象类,实现其中的抽象方法,实现类型转换的工作。


输入图片说明
输入图片说明

这个抽象类实现了TypeHandler接口,这个接口主要定义了类型转换的几种操作。


输入图片说明
输入图片说明

至于这个抽象类继承的TypeReference<T>,主要是提供了获取这个T具体是哪个类型。在判断使用使用哪个TypeHandler时有用,后文会看到。


输入图片说明
输入图片说明

如何使用

大致介绍了TypeHandler的作用,及其相关类,我们来看看如何使用它。
今天遇到的主要是从SqlServer中取数据,遇到很多列都是Numeric(10,2)类型,指的是字段是数字型,长度为10,小数为两位。Mybatis默认的BigDecimalTypeHandler取到后,都默认变成4位小数,不够的补了0。而上层的要求是,拿到的和数字相关的数据都要2位小数。

有两种做法,一种是在所有给上层赋值的时候,都人工对BigDeciam的数据做如下操作。

setScale(2, BigDecimal.ROUND_HALF_UP)

因为这是一个全局性的要求,所有相关的地方,都需要有这个代码,虽然可以写一个工具类,各个地方调用,但就对原本间接的代码造成了侵入。既然这样,为什么不试试TypeHandler。

我的做法是继承BigDecimalTypeHandler,覆盖原来的取值方法,对取到的数值做范围限定。


加上@MappedJdbcTypes注解是为了表明这个类是用于映射JdbcType的NUMERIC类型,这会覆盖默认的用于转换Java BegDecimal和Jdbc NUMERIC的BigDecimal,在后面源码中可略窥一二。

开发完这个转换类后,你需要在Mybatis的配置文件中声明这个TypeHandler,这样Mybatis才知道你自己声明了一个TypeHandler。

<typeHandlers>
    <typeHandler handler="com.codelab.learn.SubBigDecimalTypeHandler"/>
</typeHandlers>

这样TypeHandler就起作用了。下面是前后效果。


输入图片说明
输入图片说明

输入图片说明
输入图片说明

源码层面

首先Mybatis有一个默认的TypeHandler实现,这些TypeHandler是如何被Mybatis识别的呢。
答案是TypeHandlerRegistry。在Mybatis初始化配置的时候,TypeHandlerRegistry会把JdbcType和Java类型对应的映射关系注册进该类内部的Map中。


输入图片说明
输入图片说明

输入图片说明
输入图片说明

JDBC_TYPE_HANDLER_MAP中记录的是JdbcType和TypeHandler对应的关系。


12
12

TYPE_HANDLER_MAP中记录的是Java类型和对应的所有JdbcType以及其对应TypeHandler的映射关系关系。
13
13

UNKNOWN_TYPE_HANDLER是在执行BaseTypeHandler的抽象方法时,去先解析出来该用什么TypeHandler,目前还没用到,先不研究。
ALL_TYPE_HANDLERS_MAP中记录的是所有TypeHandler的Class和其实例之间的映射关系。

我们以系统默认注册的三个作为例子,看看整个执行的流程

1 register(String.class, new StringTypeHandler());
2 register(String.class, JdbcType.NCHAR, new NStringTypeHandler());
3 register(JdbcType.NCHAR, new NStringTypeHandler());

第一个是告诉 String类型的转换,要用StringTypeHandler。
直接进的这个函数,因为我们的TypeHandler上并没有打注解,因此直接进入箭头标记的逻辑。


输入图片说明
输入图片说明

然后继续注册,只不过jdbcType是null。


输入图片说明
输入图片说明

后续的代码比较简单,会先从Type_HANLER_MAP中看是否有已经存在的 Map<JdbcType, TypeHandler<?>> map,没有的话,新建,并且放入TYPE_HANDLER_MAP中,在Map<JdbcType, TypeHandler<?>> map放入此次的jdbcType和它对应的Handler。最后在ALL_TYPE_HANDLERS_MAP放入handler的类和实例。

第二个,传入了jdbcType是NCHAR,和第一个类似,但直接就进入了最后一步的注册环节,没有去判断传入什么样的jdbcType类型,因为已经指定了。


输入图片说明
输入图片说明

第三个是绑定了 jdbcType和Handler之间的对应关系。


输入图片说明
输入图片说明

OK,前面是系统默认注册进去的,那我们看一下我们在如何使用章节中添加进去的SubBigDecimalTypeHandler是如何被注册进去的呢。

Mybatis在应用中启动时,会根据XML文件初始化配置,负责解析XML生成配置类的就是XMLConfigBuilder,通过调用其中的parseConfiguration方法填充配置类。


输入图片说明
输入图片说明

箭头表示处,就是解析typehandlers节点,我们看看他具体做了些什么。


输入图片说明
输入图片说明

因为我们不是对整个package进行注册,所以进入else分支,因为只表明了一个最简单的Handler,所以要获取的字段都为null,由此我们也可以看出,在编写XML时,我们也是可以直接指定映射关系的,因为获取不到javaType和jdbcType,后面应该是会根据这个类再解析一波。跟注册相关的又回到了TypeHandlerRegistry这个类里面,职责还是很清晰的。

输入图片说明
输入图片说明

在这个方法里面,首先会获取有没有打MappedType这个注解,这个注解是表明这个类对应处理的JavaType是啥。我们这边没有找到,因此继续往下走。


输入图片说明
输入图片说明

从Mybatis3.1.0开始,会自动解析这个类对应的Java类型,还记得之前我们继承的BigDecimalTypeHandler中我们的基类BaseTypeHandler继承了TypeReference么?


输入图片说明
输入图片说明

这个类的构造函数会获取泛型中具体的类型是什么,细节代码可以私下看一下。
获取到了具体的Java类型,我们就继续往下传。

输入图片说明
输入图片说明

因为我们的subBigDecimalTypeHandler是打了MappedJdbcType注解的,因此之后的步骤和register(String.class, JdbcType.NCHAR, new NStringTypeHandler())是一致的,可以回看上文。

到这里,TypeHandler的注册部分已经完成了。


在之前的关于映射的文章中,我们提过,Mybatis完成映射后,会选择合适的TypeHandler处理器,完成对Java业务对象的赋值,我们首先找到入口在哪里。

输入图片说明
输入图片说明

完成赋值的就是在1,2处,我们这边用的是自动映射,因此进1看看,具体关于TypeHandler的处理,不会有太大的差异。
在之前的createAutomaticMappings,找到列名后,会找出对应的字段,首先会判断是否有对应的TypeHandler。

输入图片说明
输入图片说明

因为你知道了JDBC的类型,也通过反射知道了Java的类型。

输入图片说明
输入图片说明

这边就首先去TYPE_HANDLER_MAP中找已经存在的JDBC-TypeHandler的映射,如果有的话直接取,没有的话,就默认取null所对应的那个类型。
因为我们知道jdbc的类型是NUMERIC,而且之前注册的SubBigDecimalTypeHandler对应的JDBC类型是NUMERIC。

输入图片说明
输入图片说明

因此就取了更匹配的SubBigDecimalTypeHandler。
之后就是调用getResult方法,完成值的获取即可。


总结

本文主要介绍了

  1. 什么是TypeHandler。
  2. 如何使用TypeHandler。
  3. 从系统默认的以及自定义的TypeHandler的注册和获取的角度,从源码层面分析了整个过程。

希望得到您的点赞,打赏支持,谢谢。

输入图片说明
输入图片说明
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容