MyBatis(九):MyBatis類型處理器(TypeHandler)詳解

1. TypeHandler簡介

   TypeHandler，顧名思義類型轉換器，就是将資料庫中的類型與Java中的類型進行互相轉換的處理器。

   MyBatis 在設定預處理語句（PreparedStatement）中的參數或從結果集中取出一個值時， 都會用類型處理器将擷取到的值以合适的方式轉換成 Java 類型

2. 實作講解

   經常自定義類型轉換器方式有兩種，實作

   TypeHandler

   接口， 或繼承抽象類

   BaseTypeHandle

   ，并且可以指定轉換後的字段類型。
   • 其實BaseTypeHandler也是繼承了TypeHandler接口，在實作的TypeHandler接口的方法中調用的是自身抽象方法，如下

   public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> {
     
     public T getResult(ResultSet rs, String columnName) throws SQLException {
         Object result;
         try {
             result = this.getNullableResult(rs, columnName);
         } catch (Exception var5) {
             throw new ResultMapException("Error attempting to get column '" + columnName + "' from result set.  Cause: " + var5, var5);
         }
   
         return rs.wasNull() ? null : result;
     }
   
     public abstract T getNullableResult(ResultSet var1, String var2) throws SQLException;
   }
              

   • 抽象類BaseTypeHandler的抽象方法

   // 執行之前，将Java類型轉換為對應的jdbc類型，用于指派sql中參數
   public abstract void setNonNullParameter(PreparedStatement var1, int var2, T var3, JdbcType var4) throws SQLException;
   
   // 根據列名從resultSet中擷取，将JDBC類型轉換為Java類型
   public abstract T getNullableResult(ResultSet var1, String var2) throws SQLException;
   
   // 根據下标從resultSet中擷取，将JDBC類型轉換為Java類型
   public abstract T getNullableResult(ResultSet var1, int var2) throws SQLException;
   
   // 用于在執行完存儲過程後，将JDBC類型轉換為Java類型
   public abstract T getNullableResult(CallableStatement var1, int var2) throws SQLException;
              

3. 自定義類型處理器

   ​ 假設現在有一個支付辨別(0-否 1-是)字段，資料庫中我們存入的是tinyint 0/1，但是前端顯示卻是 是/否，使用TypeHandler就可以實作。具體步驟如下：

   • 建立MyTypeHandler，繼承BaseTypeHandler類

   public class MyTypeHandler extends BaseTypeHandler<String> {
   
       /**
        * @Description 執行之前，将Java類型轉換為對應的jdbc類型，用于指派sql中參數
        **/
       @Override
       public void setNonNullParameter(PreparedStatement preparedStatement, int i, String s, JdbcType jdbcType) throws SQLException {
           preparedStatement.setInt(i,Integer.valueOf(s));
       }
   
       /**
        * @Description 根據列名從resultSet中擷取，将JDBC類型轉換為Java類型
        **/
       @Override
       public String getNullableResult(ResultSet resultSet, String s) throws SQLException {
           return this.convert(resultSet.getInt(s));
       }
   
       /**
        * @Description 根據下标從resultSet中擷取，将JDBC類型轉換為Java類型
        **/
       @Override
       public String getNullableResult(ResultSet resultSet, int i) throws SQLException {
           return this.convert(resultSet.getInt(i));
       }
   
       /**
        * @Description 用于在執行完存儲過程後，将JDBC類型轉換為Java類型
        **/
       @Override
       public String getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
           return this.convert(callableStatement.getInt(i));
       }
   
       /**
        * @Description 對資料庫中0/1進行轉換
        **/
       private String convert(int flag){
           if (flag==1){
               return "是";
           }
           return "否";
       }
   }
              

   • 在Mapper中指定需要轉換的字段，jdbcType指資料庫中的類型，javaType指Java中的類型，typeHandler指定自定義的轉換器

   <result column="flag" property="flag" jdbcType="TINYINT" javaType="java.lang.String" typeHandler="com.rangers.MyTypeHandler"></result>    
              

   • 進行測試

   private SqlSession sqlSession ;
       private OrderMapper orderMapper;
   
       @Before
       public void init() throws IOException {
           InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
           SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
           sqlSession = sqlSessionFactory.openSession();
           orderMapper = sqlSession.getMapper(OrderMapper.class);
       }
   
     	// 測試讀取時轉換
       @org.junit.Test
       public void testResult(){
           Order order = orderMapper.selectOne(1);
           System.out.println(order);
       }
   
     	// 測試傳入時轉換
       @org.junit.Test
       public void testParameter(){
           // 假設前端傳入字元串0/1
           List<Order> orders = orderMapper.selectOneByFlag("1");
           System.out.println(orders);
       }
   
       @After
       public void close(){
           sqlSession.close();
       }
              

   [Order{id=2, time=Wed Mar 10 17:22:45 CST 2021, total=2.22, uid=1, flag=是}, Order{id=3, time=Wed Mar 10 17:22:57 CST 2021, total=3.33, uid=2, flag=是}]
              

4. 全局字段轉換與單個字段轉換

   全局轉換：在核心配置檔案中添加typeHandlers标簽

   <typeHandlers>
     <typeHandler handler="com.rangers.MyTypeHandle"/>
   </typeHandlers>
              

   單個字段轉換：指定jdbcType、javaType與typeHandler

   <result column="flag" property="flag" jdbcType="TINYINT" javaType="java.lang.String" typeHandler="com.rangers.MyTypeHandler"></result>
              

   通常在項目中使用的是單個字段進行轉換，經常自定義類型處理器還有日期處理、加密字段處理、List處理，JSON處理等