MyBatis里字段到枚舉類型的轉換/映射


一、簡介

  我們在用MyBatis里,很多時間有這樣一個需求:bean里有個屬性是枚舉,在DB存儲時我們想存的枚舉的代號,從DB拿出來時想直接映射成目標枚舉類型,也即代號字段與Java枚舉類的相互類型轉換

  當然,你可以為每個枚舉寫一個MyEnumTypeHandler,但問題是要為每個類都寫一個TypeHandler,過於繁瑣。

  有了泛型,一個通用的TypeHandler直接搞定。

二、源碼

源碼詳見:spring-mybatis-test

2.1 EnumTypeHandler類

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package  com.adu.spring_test.mybatis.typehandler;
 
import  java.sql.CallableStatement;
import  java.sql.PreparedStatement;
import  java.sql.ResultSet;
import  java.sql.SQLException;
 
import  com.adu.spring_test.mybatis.util.CodeEnumUtil;
import  org.apache.ibatis.type.BaseTypeHandler;
import  org.apache.ibatis.type.JdbcType;
 
import  com.adu.spring_test.mybatis.enums.CodeBaseEnum;
 
/**
  * mapper里字段到枚舉類的映射。
  * 用法一:
  * 入庫:#{enumDataField, typeHandler=com.adu.spring_test.mybatis.typehandler.EnumTypeHandler}
  * 出庫:
  * <resultMap>
  * <result property="enumDataField" column="enum_data_field" javaType="com.xxx.MyEnum" typeHandler="com.adu.spring_test.mybatis.typehandler.EnumTypeHandler"/>
  * </resultMap>
  *
  * 用法二:
  * 1)在mybatis-config.xml中指定handler:
  *      <typeHandlers>
  *              <typeHandler handler="com.adu.spring_test.mybatis.typehandler.EnumTypeHandler" javaType="com.xxx.MyEnum"/>
  *      </typeHandlers>
  * 2)在MyClassMapper.xml里直接select/update/insert。
  */
public  class  EnumTypeHandler<E  extends  Enum<?> & CodeBaseEnum>  extends  BaseTypeHandler<CodeBaseEnum> {
     private  Class<E> clazz;
 
     public  EnumTypeHandler(Class<E> enumType) {
         if  (enumType ==  null )
             throw  new  IllegalArgumentException( "Type argument cannot be null" );
 
         this .clazz = enumType;
     }
 
     @Override
     public  void  setNonNullParameter(PreparedStatement ps,  int  i, CodeBaseEnum parameter, JdbcType jdbcType)
             throws  SQLException {
         ps.setInt(i, parameter.code());
     }
 
     @Override
     public  E getNullableResult(ResultSet rs, String columnName)  throws  SQLException {
         return  CodeEnumUtil.codeOf(clazz, rs.getInt(columnName));
     }
 
     @Override
     public  E getNullableResult(ResultSet rs,  int  columnIndex)  throws  SQLException {
         return  CodeEnumUtil.codeOf(clazz, rs.getInt(columnIndex));
     }
 
     @Override
     public  E getNullableResult(CallableStatement cs,  int  columnIndex)  throws  SQLException {
         return  CodeEnumUtil.codeOf(clazz, cs.getInt(columnIndex));
     }
}

  

 

2.2 CodeBaseEnum類

1
2
3
4
5
package  com.adu.spring_test.mybatis.enums;
 
public  interface  CodeBaseEnum {
     int  code();
}

  

2.3 CodeEnumUtil類

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package  com.adu.spring_test.mybatis.util;
 
import  com.adu.spring_test.mybatis.enums.CodeBaseEnum;
 
public  class  CodeEnumUtil {
     /**
      * @param enumClass
      * @param code
      * @param <E>
      * @return
      */
     public  static  <E  extends  Enum<?> & CodeBaseEnum> E codeOf(Class<E> enumClass,  int  code) {
         E[] enumConstants = enumClass.getEnumConstants();
         for  (E e : enumConstants) {
             if  (e.code() == code)
                 return  e;
         }
         return  null ;
     }
}
原作者: 水岩
         
本博客中未標明轉載的文章歸作者 水岩和博客園共有,歡迎轉載,但未經作者同意必須保留此段聲明,且在文章頁面明顯位置給出原文連接,否則保留追究法律責任的權利。






免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM