2千字帶你看懂Mybatis TypeHandler的應用及源碼

TypeHandlers

無論是 MyBatis 在預處理語句（PreparedStatement）中設置一個參數時，還是從結果集中取出一個值時， 都會用類型處理器將獲取的值以合適的方式轉換成 Java 類型。

下面是常見的一些對應類型: 

以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對應的關係。  TYPE_HANDLER_MAP中記錄的是Java類型和對應的所有JdbcType以及其對應TypeHandler的映射關係關係。  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的註冊和獲取的角度，從源碼層面分析了整個過程。