From: https://segmentfault.com/a/1190000010755321

問題

在編碼過程中，經常會遇到用某個數值來表示某種狀態、類型或者階段的情況，比如有這樣一個枚舉：

public enum ComputerState {OPEN(10), //開啟CLOSE(11), //關閉OFF_LINE(12), //離線FAULT(200), //故障UNKNOWN(255); //未知private int code;ComputerState(int code) { this.code = code; } }

通常我們希望將表示狀態的數值存入數據庫，即ComputerState.OPEN存入數據庫取值為10。

探索

首先，我們先看看MyBatis是否能夠滿足我們的需求。
MyBatis內置了兩個枚舉轉換器分別是：org.apache.ibatis.type.EnumTypeHandler和org.apache.ibatis.type.EnumOrdinalTypeHandler。

EnumTypeHandler

這是默認的枚舉轉換器，該轉換器將枚舉實例轉換為實例名稱的字符串，即將ComputerState.OPEN轉換OPEN。

EnumOrdinalTypeHandler

顧名思義這個轉換器將枚舉實例的ordinal屬性作為取值，即ComputerState.OPEN轉換為0,ComputerState.CLOSE轉換為1。
使用它的方式是在MyBatis配置文件中定義：

<typeHandlers><typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="com.example.entity.enums.ComputerState"/> </typeHandlers>

以上的兩種轉換器都不能滿足我們的需求，所以看起來要自己編寫一個轉換器了。

方案

MyBatis提供了org.apache.ibatis.type.BaseTypeHandler類用于我們自己擴展類型轉換器，上面的EnumTypeHandler和EnumOrdinalTypeHandler也都實現了這個接口。

1. 定義接口

我們需要一個接口來確定某部分枚舉類的行為。如下：

public interface BaseCodeEnum {int getCode(); }

該接口只有一個返回編碼的方法，返回值將被存入數據庫。

2. 改造枚舉

就拿上面的ComputerState來實現BaseCodeEnum接口：

public enum ComputerState implements BaseCodeEnum{OPEN(10), //開啟CLOSE(11), //關閉OFF_LINE(12), //離線FAULT(200), //故障UNKNOWN(255); //未知private int code;ComputerState(int code) { this.code = code; }@Overridepublic int getCode() { return this.code; } }

3. 編寫一個轉換工具類

現在我們能順利的將枚舉轉換為某個數值了，還需要一個工具將數值轉換為枚舉實例。

public class CodeEnumUtil {public static <E extends Enum<?> & BaseCodeEnum> E codeOf(Class<E> enumClass, int code) {E[] enumConstants = enumClass.getEnumConstants();for (E e : enumConstants) {if (e.getCode() == code)return e;}return null;} }

4. 自定義類型轉換器

準備工作做的差不多了，是時候開始編寫轉換器了。
BaseTypeHandler<T> 一共需要實現4個方法：

void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)

用于定義設置參數時，該如何把Java類型的參數轉換為對應的數據庫類型

T getNullableResult(ResultSet rs, String columnName)

用于定義通過字段名稱獲取字段數據時，如何把數據庫類型轉換為對應的Java類型

T getNullableResult(ResultSet rs, int columnIndex)

用于定義通過字段索引獲取字段數據時，如何把數據庫類型轉換為對應的Java類型

T getNullableResult(CallableStatement cs, int columnIndex)

用定義調用存儲過程后，如何把數據庫類型轉換為對應的Java類型

我是這樣實現的：

public class CodeEnumTypeHandler<E extends Enum<?> & BaseCodeEnum> extends BaseTypeHandler<BaseCodeEnum> {private Class<E> type;public CodeEnumTypeHandler(Class<E> type) {if (type == null) {throw new IllegalArgumentException("Type argument cannot be null");}this.type = type;}@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, BaseCodeEnum parameter, JdbcType jdbcType)throws SQLException {ps.setInt(i, parameter.getCode());}@Overridepublic E getNullableResult(ResultSet rs, String columnName) throws SQLException {int code = rs.getInt(columnName);return rs.wasNull() ? null : codeOf(code);}@Overridepublic E getNullableResult(ResultSet rs, int columnIndex) throws SQLException {int code = rs.getInt(columnIndex);return rs.wasNull() ? null : codeOf(code);}@Overridepublic E getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {int code = cs.getInt(columnIndex);return cs.wasNull() ? null : codeOf(code);}private E codeOf(int code){try {return CodeEnumUtil.codeOf(type, code);} catch (Exception ex) {throw new IllegalArgumentException("Cannot convert " + code + " to " + type.getSimpleName() + " by code value.", ex);}} }

5. 使用

接下來需要指定哪個類使用我們自己編寫轉換器進行轉換，在MyBatis配置文件中配置如下：

<typeHandlers><typeHandler handler="com.example.typeHandler.CodeEnumTypeHandler" javaType="com.example.entity.enums.ComputerState"/> </typeHandlers>

搞定！ 經測試ComputerState.OPEN被轉換為10,ComputerState.UNKNOWN被轉換為255，達到了預期的效果。

6. 優化

在第5步時，我們在MyBatis中添加typeHandler用于指定哪些類使用我們自定義的轉換器，一旦系統中的枚舉類多了起來，MyBatis的配置文件維護起來會變得非常麻煩，也容易出錯。如何解決呢？
在Spring中我們可以使用JavaConfig方式來干預SqlSessionFactory的創建過程，來完成轉換器的指定。
思路

再寫一個能自動匹配轉換行為的轉換器

通過sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()取得類型轉換器注冊器

再使用typeHandlerRegistry.setDefaultEnumTypeHandler(Class<? extends TypeHandler> typeHandler)將第一步的轉換器注冊成為默認的

首先，我們需要一個能確定轉換行為的轉換器：
AutoEnumTypeHandler.java

public class AutoEnumTypeHandler<E extends Enum<E>> extends BaseTypeHandler<E> {private BaseTypeHandler typeHandler = null;public AutoEnumTypeHandler(Class<E> type) {if (type == null) {throw new IllegalArgumentException("Type argument cannot be null");}if(BaseCodeEnum.class.isAssignableFrom(type)){// 如果實現了 BaseCodeEnum 則使用我們自定義的轉換器typeHandler = new CodeEnumTypeHandler(type);}else {// 默認轉換器 也可換成 EnumOrdinalTypeHandlertypeHandler = new EnumTypeHandler<>(type);}}@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, E parameter, JdbcType jdbcType) throws SQLException {typeHandler.setNonNullParameter(ps,i, parameter,jdbcType);}@Overridepublic E getNullableResult(ResultSet rs, String columnName) throws SQLException {return (E) typeHandler.getNullableResult(rs,columnName);}@Overridepublic E getNullableResult(ResultSet rs, int columnIndex) throws SQLException {return (E) typeHandler.getNullableResult(rs,columnIndex);}@Overridepublic E getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {return (E) typeHandler.getNullableResult(cs,columnIndex);} }

接下來，我們需要干預SqlSessionFactory的創建過程，將剛剛的轉換器指定為默認的：

@Configuration @ConfigurationProperties(prefix = "mybatis") public class MyBatisConfig {private String configLocation;private String mapperLocations;@Beanpublic SqlSessionFactory sqlSessionFactory(DataSource dataSource,JSONArrayHandler jsonArrayHandler,JSONObjectHandler jsonObjectHandler) throws Exception {SqlSessionFactoryBean factory = new SqlSessionFactoryBean();factory.setDataSource(dataSource);// 設置配置文件及mapper文件地址ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();factory.setConfigLocation(resolver.getResource(configLocation));factory.setMapperLocations(resolver.getResources(mapperLocations));SqlSessionFactory sqlSessionFactory = factory.getObject();// 取得類型轉換注冊器TypeHandlerRegistry typeHandlerRegistry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry();// 注冊默認枚舉轉換器typeHandlerRegistry.setDefaultEnumTypeHandler(AutoEnumTypeHandler.class);return sqlSessionFactory;}// ... getter setter }

搞定！ 這樣一來，如果枚舉實現了BaseCodeEnum接口就使用我們自定義的CodeEnumTypeHandler，如果沒有實現BaseCodeEnum接口就使用默認的。再也不用寫MyBatis的配置文件了！

結束了

以上就是我對如何在MyBatis中優雅的使用枚舉的探索。如果你還有更優的解決方案，請一定在評論中告知，萬分感激。

總結

以上是生活随笔為你收集整理的如何在MyBatis中优雅的使用枚举的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。