問(wèn)題
在編碼過(guò)程中，經(jīng)常會(huì)遇到用某個(gè)數(shù)值來(lái)表示某種狀態(tài)、類(lèi)型或者階段的情況，比如有這樣一個(gè)枚舉：
public enum ComputerState {
OPEN(10), //開(kāi)啟
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ù)庫(kù)，即ComputerState.OPEN存入數(shù)據(jù)庫(kù)取值為10。
探索
首先，我們先看看MyBatis是否能夠滿足我們的需求。
MyBatis內(nèi)置了兩個(gè)枚舉轉(zhuǎn)換器分別是：org.apache.ibatis.type.EnumTypeHandler和org.apache.ibatis.type.EnumOrdinalTypeHandler。
EnumTypeHandler
這是默認(rèn)的枚舉轉(zhuǎn)換器，該轉(zhuǎn)換器將枚舉實(shí)例轉(zhuǎn)換為實(shí)例名稱的字符串，即將ComputerState.OPEN轉(zhuǎn)換OPEN。
EnumOrdinalTypeHandler
顧名思義這個(gè)轉(zhuǎn)換器將枚舉實(shí)例的ordinal屬性作為取值，即ComputerState.OPEN轉(zhuǎn)換為0,ComputerState.CLOSE轉(zhuǎn)換為1。
使用它的方式是在MyBatis配置文件中定義：
<typeHandlers>
<typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="com.example.entity.enums.ComputerState"/>
</typeHandlers>
以上的兩種轉(zhuǎn)換器都不能滿足我們的需求，所以看起來(lái)要自己編寫(xiě)一個(gè)轉(zhuǎn)換器了。
方案
MyBatis提供了org.apache.ibatis.type.BaseTypeHandler類(lèi)用于我們自己擴(kuò)展類(lèi)型轉(zhuǎn)換器，上面的EnumTypeHandler和EnumOrdinalTypeHandler也都實(shí)現(xiàn)了這個(gè)接口。
- 定義接口
我們需要一個(gè)接口來(lái)確定某部分枚舉類(lèi)的行為。如下：
public interface BaseCodeEnum {
int getCode();
}
該接口只有一個(gè)返回編碼的方法，返回值將被存入數(shù)據(jù)庫(kù)。
- 改造枚舉
就拿上面的ComputerState來(lái)實(shí)現(xiàn)BaseCodeEnum接口：
public enum ComputerState implements BaseCodeEnum{
OPEN(10), //開(kāi)啟
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; }
}
- 編寫(xiě)一個(gè)轉(zhuǎn)換工具類(lèi)
現(xiàn)在我們能順利的將枚舉轉(zhuǎn)換為某個(gè)數(shù)值了，還需要一個(gè)工具將數(shù)值轉(zhuǎn)換為枚舉實(shí)例。
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;
}
}
- 自定義類(lèi)型轉(zhuǎn)換器
準(zhǔn)備工作做的差不多了，是時(shí)候開(kāi)始編寫(xiě)轉(zhuǎn)換器了。
BaseTypeHandler<T> 一共需要實(shí)現(xiàn)4個(gè)方法：
void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)
用于定義設(shè)置參數(shù)時(shí)，該如何把Java類(lèi)型的參數(shù)轉(zhuǎn)換為對(duì)應(yīng)的數(shù)據(jù)庫(kù)類(lèi)型
T getNullableResult(ResultSet rs, String columnName)
用于定義通過(guò)字段名稱獲取字段數(shù)據(jù)時(shí)，如何把數(shù)據(jù)庫(kù)類(lèi)型轉(zhuǎn)換為對(duì)應(yīng)的Java類(lèi)型
T getNullableResult(ResultSet rs, int columnIndex)
用于定義通過(guò)字段索引獲取字段數(shù)據(jù)時(shí)，如何把數(shù)據(jù)庫(kù)類(lèi)型轉(zhuǎn)換為對(duì)應(yīng)的Java類(lèi)型
T getNullableResult(CallableStatement cs, int columnIndex)
用定義調(diào)用存儲(chǔ)過(guò)程后，如何把數(shù)據(jù)庫(kù)類(lèi)型轉(zhuǎn)換為對(duì)應(yīng)的Java類(lèi)型
我是這樣實(shí)現(xiàn)的：
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);
}
}
}
- 使用
接下來(lái)需要指定哪個(gè)類(lèi)使用我們自己編寫(xiě)轉(zhuǎn)換器進(jìn)行轉(zhuǎn)換，在MyBatis配置文件中配置如下：
<typeHandlers>
<typeHandler handler="com.example.typeHandler.CodeEnumTypeHandler" javaType="com.example.entity.enums.ComputerState"/>
</typeHandlers>
搞定！ 經(jīng)測(cè)試ComputerState.OPEN被轉(zhuǎn)換為10,ComputerState.UNKNOWN被轉(zhuǎn)換為255，達(dá)到了預(yù)期的效果。
- 優(yōu)化
在第5步時(shí)，我們?cè)贛yBatis中添加typeHandler用于指定哪些類(lèi)使用我們自定義的轉(zhuǎn)換器，一旦系統(tǒng)中的枚舉類(lèi)多了起來(lái)，MyBatis的配置文件維護(hù)起來(lái)會(huì)變得非常麻煩，也容易出錯(cuò)。如何解決呢？
在Spring中我們可以使用JavaConfig方式來(lái)干預(yù)SqlSessionFactory的創(chuàng)建過(guò)程，來(lái)完成轉(zhuǎn)換器的指定。
思路
再寫(xiě)一個(gè)能自動(dòng)匹配轉(zhuǎn)換行為的轉(zhuǎn)換器
通過(guò)sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()取得類(lèi)型轉(zhuǎn)換器注冊(cè)器
再使用typeHandlerRegistry.setDefaultEnumTypeHandler(Class<? extends TypeHandler> typeHandler)將第一步的轉(zhuǎn)換器注冊(cè)成為默認(rèn)的
首先，我們需要一個(gè)能確定轉(zhuǎn)換行為的轉(zhuǎn)換器：
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)){
// 如果實(shí)現(xiàn)了 BaseCodeEnum 則使用我們自定義的轉(zhuǎn)換器
typeHandler = new CodeEnumTypeHandler(type);
}else {
// 默認(rèn)轉(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);
}
}
接下來(lái)，我們需要干預(yù)SqlSessionFactory的創(chuàng)建過(guò)程，將剛剛的轉(zhuǎn)換器指定為默認(rè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();
// 取得類(lèi)型轉(zhuǎn)換注冊(cè)器
TypeHandlerRegistry typeHandlerRegistry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry();
// 注冊(cè)默認(rèn)枚舉轉(zhuǎn)換器
typeHandlerRegistry.setDefaultEnumTypeHandler(AutoEnumTypeHandler.class);
return sqlSessionFactory;
}
// ... getter setter
}
搞定！ 這樣一來(lái)，如果枚舉實(shí)現(xiàn)了BaseCodeEnum接口就使用我們自定義的CodeEnumTypeHandler，如果沒(méi)有實(shí)現(xiàn)BaseCodeEnum接口就使用默認(rèn)的。再也不用寫(xiě)MyBatis的配置文件了！
結(jié)束了
以上就是我對(duì)如何在MyBatis中優(yōu)雅的使用枚舉的探索。如果你還有更優(yōu)的解決方案，請(qǐng)一定在評(píng)論中告知，萬(wàn)分感激。
參考
轉(zhuǎn)載自：如何在MyBatis中優(yōu)雅的使用枚舉
