Mybatis实战之TypeHandler高级进阶

桃扇骨 2022-07-12 12:10 198阅读 0赞

上篇文章分享了在项目实战中自定义Mybatis的TypeHandler来处理枚举类型。文章结尾也指出了美中不足之处，那就是每次都需要指定我们自定义的枚举TypeHandler。 随着项目枚举类型的增多，每次都要写一遍这个会令人很反感。那么，本次我们就来解决这一痛点。  
![pipixia_womenzou][]

### 思路分析 ###

1.  上篇文章讲到, mybatis有默认的处理枚举类型的TypeHandler，因此，我们要将我们自定义的枚举TypeHandler注册进入Mybatis。
2.  注册完我们自定义的TypeHandler后，还得告诉Mybatis只要一遇到我们指定的枚举类型（上篇的DisplayedEnum）就用自定义的枚举TypeHandler(上篇为EnumTypeHandler)进行转换。由于Mybatis在启动时就会通过TypeHandlerRegistry进行注册，即建立JdbcType, JavaType, TypeHandler三者之间的关系， 因此，这意味着在Mybatis启动时我们也需要通过TypeHandlerRegistry将我们的所有的枚举类型（JavaType）与自定义的枚举TypeHandler（EnumTypeHandler）建立联系。

为了方便大家理解， 贴上Mybatis中的TypeHandlerRegistry的相关部分源码:

![type_handler_registry.png][]

## 实战 ##

### SqlSessionFactoryBean ###

由于我们项目使用了Spring, 是用Spring集成的Mybatis(废话，大家都是这么干的)。Spring通过SqlSessionFactoryBean来初始化启动Mybatis。 因此，我们应该在它身上下手，然而，一切并不是那么顺利。

查看了一下SqlSessionFactoryBean的源码，发现SqlSessionFactoryBean并没有任何地方可以让我们切入， 进而来调用TypeHandlerRegistry进行注册我们的枚举。 更令人蛋疼的是其所有属性全是private， 这下不仅AOP切入不行，连通过继承偷懒都不行了。

![shousi_pipixia.jpg][]

作罢，咱只有老老实实的重写一遍SqlSessionFactoryBean的代码了（copy还不简单）。

### DefaultSqlSessionFactoryBean ###

代码量比较多，就只贴关键代码了。步骤如下：

1.  DefaultSqlSessionFactoryBean继承SqlSessionFactoryBean。
2.  将SqlSessionFactoryBean中的代码全部copy到DefaultSqlSessionFactoryBean。
3.  调用以下方法。

![config_enum_type_handler.png][]

切记， 以上代码要在这个代码之前执行：

![default_sql_session_xml_parse.png][]

因为, xmlMapperBuilder.parse()方法会开始解析我们所有的所有mapper.xml的配置文件了，这时候会把resultMap也解析了，这就会导致我们自定义的TypeHandler不生效。  
切记！ 切记

### 最后 ###

以上，代码算是完工了，记得在Spring的配置文件中， 将SqlSessionFactoryBean替换为我们的DefaultSqlSessionFactoryBean。 不然我们的活就是白干了。

接下来，就可以开始浪了， 之前我们需要这样写：

而现在，我们可以不写typeHandler了。

好啦，本次就写到这儿。

![pipixia_feitian][]

**我的博客：** javafan.cn

[pipixia_womenzou]: https://ohes7ddip.qnssl.com/pipixia_womenzou
[type_handler_registry.png]: https://ohes7ddip.qnssl.com/type_handler_registry.png
[shousi_pipixia.jpg]: https://ohes7ddip.qnssl.com/shousi_pipixia.jpg
[config_enum_type_handler.png]: https://ohes7ddip.qnssl.com/config_enum_type_handler.png
[default_sql_session_xml_parse.png]: https://ohes7ddip.qnssl.com/default_sql_session_xml_parse.png
[pipixia_feitian]: https://ohes7ddip.qnssl.com/pipixia_feitian