从源码层面剖析mybatis初始化和一条查询语句的执行原理

ゝ一纸荒年。 2024-03-26 11:28 66阅读 0赞

###  ###

TypeHandlers

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

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

![58c8a071980f99ec3b42b5b49a71387e.jpeg][]

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

![63e3113b6691371670f35e0ac7374718.jpeg][]

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

![f9bb64648b71ce0407eeb2cd38c9660f.jpeg][]

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

![a74c7dd4d8fd762ab0ca772bfac2ebf4.jpeg][]

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

###  ###

如何使用

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

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

setScale(2, BigDecimal.ROUND\_HALF\_UP)

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

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

![9cb014871fa25be0faabf60bf55a0c58.jpeg][]

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

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

</typeHandlers>

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

![35dbebe92795a19c77254dc7f44a63d5.jpeg][]

源码层面

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

![62196a9fad1469fc9dc790ebc24b6230.jpeg][]

![f77e800dd307dbbc1dc54b36757438f0.jpeg][]

JDBC\_TYPE\_HANDLER\_MAP中记录的是JdbcType和TypeHandler对应的关系。

![cfdeb24e12ddf264250b87e997dab6e1.jpeg][]

TYPE\_HANDLER\_MAP中记录的是Java类型和对应的所有JdbcType以及其对应TypeHandler的映射关系关系。

![cd30cbeed27f658d8d3776d40ad4ffa7.jpeg][]

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

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

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

![5e69138a4fad8aeda1c6b66dc97893c7.jpeg][]

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

![d1be679c7b3888e53f79cac6fbd64ecd.jpeg][]

后续的代码比较简单，会先从Type\_HANLER\_MAP中看是否有已经存在的 Map<JdbcType, TypeHandler<?>> map，没有的话，新建，并且放入TYPE\_HANDLER\_MAP中，在Map<JdbcType, TypeHandler<?>> map放入此次的jdbcType和它对应的Handler。最后在ALL\_TYPE\_HANDLERS\_MAP放入handler的类和实例。

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

![1a6f26a8c6e0b8598a275578a94aa53a.jpeg][]

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

![444cc95fe9874ebb72001a8d0093a033.jpeg][]

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

我特意整理了一下，里面的技术不是靠几句话就能讲清楚，所以干脆找朋友录制了一些视频，很多问题其实答案很简单，但是背后的思考和逻辑不简单，要做到知其然还要知其所以然。如果想学习Java工程化、高性能及分布式、深入浅出。性能调优、Spring，MyBatis，Netty源码分析的朋友可以加我新建的Java群：650385180，群里有阿里大牛直播讲解技术，以及Java大型互联网技术的视频免费分享给大家。

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

![7b9f0c79ec25df6d36189b60aee7273a.jpeg][]

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

![220ca0c542bbd59981f7f4c702d52a58.jpeg][]

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

![575decd8a53acb90721925cbb0417ca7.jpeg][]

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

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

![4e6b5bffb02f63259ca5481d1592b42d.jpeg][]

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

![e360dcd607b2fa8c9f995eda66cdf401.jpeg][]

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

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

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

![db3b0438297cc6c9208d861efb9ab1cf.jpeg][]

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

![94ebe8001a3500b7b09f55fe60460117.jpeg][]

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

![8444cc523e996db8bc86e404f1b4f66d.jpeg][]

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

![c817314a5f58e704de165142a67a5753.jpeg][]

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

### 总结 ###

本文主要介绍了：

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

[58c8a071980f99ec3b42b5b49a71387e.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b4d841dfeea541c3be1c86b5ed69e7d8.png
[63e3113b6691371670f35e0ac7374718.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/81296becbb7046c09c5182bbc081ddfc.png
[f9bb64648b71ce0407eeb2cd38c9660f.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/20357995c347464999af3c4bd16357f6.png
[a74c7dd4d8fd762ab0ca772bfac2ebf4.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/74ecb0427a0b4b99a6c7c33c34031459.png
[9cb014871fa25be0faabf60bf55a0c58.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/429867fbce8c453ca2d20bc2a5e00feb.png
[35dbebe92795a19c77254dc7f44a63d5.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/5b8b8c86604344b3bf7702f3b52706be.png
[62196a9fad1469fc9dc790ebc24b6230.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/37b30e9553c74533ac27d2a8c1fc5c7b.png
[f77e800dd307dbbc1dc54b36757438f0.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0665b0e5db2c4c0685b2351780c93989.png
[cfdeb24e12ddf264250b87e997dab6e1.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b32bf5de67bb4179b6413c8c92b4f8b0.png
[cd30cbeed27f658d8d3776d40ad4ffa7.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0af3a5520a1e499bb0f6b0f5eabde2cd.png
[5e69138a4fad8aeda1c6b66dc97893c7.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/995e75a6fab941e19fd6dd1323270cf4.png
[d1be679c7b3888e53f79cac6fbd64ecd.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/144e51acda09422d82907f5ccdd87499.png
[1a6f26a8c6e0b8598a275578a94aa53a.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/95304f91d62d4f6a8f8117a518095487.png
[444cc95fe9874ebb72001a8d0093a033.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e8d35829134a4cd3bdd2ce6d3ec7b375.png
[7b9f0c79ec25df6d36189b60aee7273a.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/29a1d0e33e8e4f28a28edf06efbdcaf6.png
[220ca0c542bbd59981f7f4c702d52a58.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/62145ddd380541039e0cde8483d0eae2.png
[575decd8a53acb90721925cbb0417ca7.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/5ee69aee70834c3ea3bee52b4556695e.png
[4e6b5bffb02f63259ca5481d1592b42d.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b41f7d33750f4c57bdd1bc83020aa8d7.png
[e360dcd607b2fa8c9f995eda66cdf401.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/4d8c3cd5de8f4b6e8316c4ceff6ca95f.png
[db3b0438297cc6c9208d861efb9ab1cf.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/2476958a701844cbaa4b50b9491ded88.png
[94ebe8001a3500b7b09f55fe60460117.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/cc79d074d85343aeba4802d2828d36d0.png
[8444cc523e996db8bc86e404f1b4f66d.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/8bc988448b1547a6a9f8dacf10964a79.png
[c817314a5f58e704de165142a67a5753.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/958041ae3b254b90866a837824152f45.png