1. 程式人生 > >MyBatis(九):MyBatis型別處理器(TypeHandler)詳解

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

1. TypeHandler簡介 TypeHandler,顧名思義型別轉換器,就是將資料庫中的型別與Java中的型別進行相互轉換的處理器。 > MyBatis 在設定預處理語句(PreparedStatement)中的引數或從結果集(ResultSet)中取出一個值時, 都會用型別處理器將獲取到的值以合適的方式轉換成 Java 型別 2. 實現講解 經常自定義型別轉換器方式有兩種,實現 `TypeHandler` 介面, 或繼承抽象類 `BaseTypeHandle`,並且可以指定轉換後的欄位型別。 - 其實BaseTypeHandler也是繼承了TypeHandler介面,在實現的TypeHandler介面的方法中呼叫的是自身抽象方法,如下 ```java public abstract class BaseTypeHandler extends TypeReference implements TypeHandler { 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 // 執行之前,將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類 ```java public class MyTypeHandler extends BaseTypeHandler { /** * @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指定自定義的轉換器 ```xml
``` - 進行測試 ```java 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 orders = orderMapper.selectOneByFlag("1"); System.out.println(orders); } @After public void close(){ sqlSession.close(); } ``` ```java [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標籤 ```xml
``` 單個欄位轉換:指定jdbcType、javaType與typeHandler ```xml ``` 通常在專案中使用的是單個欄位進行轉換,經常自定義型別處理器還有日期處理、加密欄位處理、List處理,JSON