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

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的配置文件了!

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,627評論 2 380

推薦閱讀更多精彩內容