如何在MyBatis中優(yōu)雅的使用枚舉

clasnake 發(fā)布于2019-08-16 10:39 / 1669人閱讀

摘要：如何解決呢在中我們可以使用方式來干預的創(chuàng)建過程，來完成轉(zhuǎn)換器的指定。再也不用寫的配置文件了結(jié)束了以上就是我對如何在中優(yōu)雅的使用枚舉的探索。

問題

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

public enum ComputerState {
    OPEN(10),         //開啟
    CLOSE(11),         //關(guān)閉
    OFF_LINE(12),     //離線
    FAULT(200),     //故障
    UNKNOWN(255);     //未知

    private int code;
    ComputerState(int code) { this.code = code; }
}

通常我們希望將表示狀態(tài)的數(shù)值存入數(shù)據(jù)庫，即ComputerState.OPEN存入數(shù)據(jù)庫取值為10。

探索

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

EnumTypeHandler

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

EnumOrdinalTypeHandler

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

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

方案

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

1. 定義接口

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

public interface BaseCodeEnum {
    int getCode();
}

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

2. 改造枚舉

就拿上面的ComputerState來實現(xiàn)BaseCodeEnum接口：

public enum ComputerState implements BaseCodeEnum{
    OPEN(10),         //開啟
    CLOSE(11),         //關(guān)閉
    OFF_LINE(12),     //離線
    FAULT(200),     //故障
    UNKNOWN(255);     //未知

    private int code;
    ComputerState(int code) { this.code = code; }

    @Override
    public int getCode() { return this.code; }
}

3. 編寫一個轉(zhuǎn)換工具類

現(xiàn)在我們能順利的將枚舉轉(zhuǎn)換為某個數(shù)值了，還需要一個工具將數(shù)值轉(zhuǎn)換為枚舉實例。

public class CodeEnumUtil {

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

4. 自定義類型轉(zhuǎn)換器

準備工作做的差不多了，是時候開始編寫轉(zhuǎn)換器了。
BaseTypeHandler 一共需要實現(xiàn)4個方法：

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

用于定義設(shè)置參數(shù)時，該如何把Java類型的參數(shù)轉(zhuǎn)換為對應(yīng)的數(shù)據(jù)庫類型

T getNullableResult(ResultSet rs, String columnName)

用于定義通過字段名稱獲取字段數(shù)據(jù)時，如何把數(shù)據(jù)庫類型轉(zhuǎn)換為對應(yīng)的Java類型

T getNullableResult(ResultSet rs, int columnIndex)

用于定義通過字段索引獲取字段數(shù)據(jù)時，如何把數(shù)據(jù)庫類型轉(zhuǎn)換為對應(yīng)的Java類型

T getNullableResult(CallableStatement cs, int columnIndex)

用定義調(diào)用存儲過程后，如何把數(shù)據(jù)庫類型轉(zhuǎn)換為對應(yīng)的Java類型

我是這樣實現(xiàn)的：

public class CodeEnumTypeHandler & BaseCodeEnum> extends BaseTypeHandler {

    private Class type;

    public CodeEnumTypeHandler(Class 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. 使用

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

搞定！ 經(jīng)測試ComputerState.OPEN被轉(zhuǎn)換為10,ComputerState.UNKNOWN被轉(zhuǎn)換為255，達到了預期的效果。

6. 優(yōu)化

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

再寫一個能自動匹配轉(zhuǎn)換行為的轉(zhuǎn)換器

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

再使用typeHandlerRegistry.setDefaultEnumTypeHandler(Class typeHandler)將第一步的轉(zhuǎn)換器注冊成為默認的

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

public class AutoEnumTypeHandler> extends BaseTypeHandler {

    private BaseTypeHandler typeHandler = null;

    public AutoEnumTypeHandler(Class type) {
        if (type == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        }
        if(BaseCodeEnum.class.isAssignableFrom(type)){
            // 如果實現(xiàn)了 BaseCodeEnum 則使用我們自定義的轉(zhuǎn)換器
            typeHandler = new CodeEnumTypeHandler(type);
        }else {
            // 默認轉(zhuǎn)換器 也可換成 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的創(chuàng)建過程，將剛剛的轉(zhuǎn)換器指定為默認的：

@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);


        // 設(shè)置配置文件及mapper文件地址
        ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
        factory.setConfigLocation(resolver.getResource(configLocation));
        factory.setMapperLocations(resolver.getResources(mapperLocations));


        SqlSessionFactory sqlSessionFactory = factory.getObject();


        // 取得類型轉(zhuǎn)換注冊器
        TypeHandlerRegistry typeHandlerRegistry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry();
        // 注冊默認枚舉轉(zhuǎn)換器
        typeHandlerRegistry.setDefaultEnumTypeHandler(AutoEnumTypeHandler.class);

        return sqlSessionFactory;
    }

    // ... getter setter
}

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

結(jié)束了

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