如何在MyBatis中優雅的使用枚舉

問題

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

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; }

    @Override
    public 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個方法：

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

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

1. T getNullableResult(ResultSet rs, String columnName)

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

1. T getNullableResult(ResultSet rs, int columnIndex)

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

1. 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;
    }

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, BaseCodeEnum parameter, JdbcType jdbcType)
            throws SQLException {
        ps.setInt(i, parameter.getCode());
    }

    @Override
    public E getNullableResult(ResultSet rs, String columnName) throws SQLException {
        int code = rs.getInt(columnName);
        return rs.wasNull() ? null : codeOf(code);
    }

    @Override
    public E getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        int code = rs.getInt(columnIndex);
        return rs.wasNull() ? null : codeOf(code);
    }

    @Override
    public 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的建立過程，來完成轉換器的指定。
思路

1. 再寫一個能自動匹配轉換行爲的轉換器
2. 經過sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()取得類型轉換器註冊器
3. 再使用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 {
            // 默認轉換器 也可換成 EnumOrdinalTypeHandler
            typeHandler = new EnumTypeHandler<>(type);
        }
    }

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, E parameter, JdbcType jdbcType) throws SQLException {
        typeHandler.setNonNullParameter(ps,i, parameter,jdbcType);
    }

    @Override
    public E getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return (E) typeHandler.getNullableResult(rs,columnName);
    }

    @Override
    public E getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return (E) typeHandler.getNullableResult(rs,columnIndex);
    }

    @Override
    public 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;


    @Bean
    public 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中優雅的使用枚舉的探索。若是你還有更優的解決方案，請必定在評論中告知，萬分感激。