MyBatis提供了org.apache.ibatis.type.BaseTypeHandler類用于我們自己擴展類型轉換器,上面的EnumTypeHandler和EnumOrdinalTypeHandler也都實現了這個接口
1. 定義接口
我們需要一個接口來確定某部分枚舉類的行為。如下:
public interface BaseCodeEnum {
????int getCode();
}
該接口只有一個返回編碼的方法,返回值將被存入數據庫。
2. 改造枚舉
public enum ValidStatus implements BaseCodeEnum {
????VALID(1), // 合法
????INVALID(-1); // 不合法
????private int code;
????ValidStatus(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個方法:
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;
????}
????@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的配置文件維護起來會變得非常麻煩,也容易出錯。如何解決呢?
在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
{
// 默認轉換器 也可換成 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的創建過程,將剛剛的轉換器指定為默認的:
@Bean
public SqlSessionFactory sqlSessionFactoryBean() throws Exception
{
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
sqlSessionFactoryBean.setDataSource(dataSource());
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBean.getObject();
// 取得類型轉換注冊器
TypeHandlerRegistry typeHandlerRegistry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry();
// 注冊默認枚舉轉換器
typeHandlerRegistry.setDefaultEnumTypeHandler(AutoEnumTypeHandler.class);
return sqlSessionFactory;
}
搞定!?這樣一來,如果枚舉實現了BaseCodeEnum接口就使用我們自定義的CodeEnumTypeHandler,如果沒有實現BaseCodeEnum接口就使用默認的。再也不用寫MyBatis的配置文件了!