摘要:如何解決呢在中我們可以使用方式來干預的創建過程,來完成轉換器的指定。再也不用寫的配置文件了結束了以上就是我對如何在中優雅的使用枚舉的探索。
問題
在編碼過程中,經常會遇到用某個數值來表示某種狀態、類型或者階段的情況,比如有這樣一個枚舉:
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。
這是默認的枚舉轉換器,該轉換器將枚舉實例轉換為實例名稱的字符串,即將ComputerState.OPEN轉換OPEN。
EnumOrdinalTypeHandler顧名思義這個轉換器將枚舉實例的ordinal屬性作為取值,即ComputerState.OPEN轉換為0,ComputerState.CLOSE轉換為1。
使用它的方式是在MyBatis配置文件中定義:
以上的兩種轉換器都不能滿足我們的需求,所以看起來要自己編寫一個轉換器了。
方案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 static4. 自定義類型轉換器& BaseCodeEnum> E codeOf(Class enumClass, int code) { E[] enumConstants = enumClass.getEnumConstants(); for (E e : enumConstants) { if (e.getCode() == code) return e; } return null; } }
準備工作做的差不多了,是時候開始編寫轉換器了。
BaseTypeHandler
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 CodeEnumTypeHandler5. 使用& 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); } } }
接下來需要指定哪個類使用我們自己編寫轉換器進行轉換,在MyBatis配置文件中配置如下:
搞定! 經測試ComputerState.OPEN被轉換為10,ComputerState.UNKNOWN被轉換為255,達到了預期的效果。
6. 優化在第5步時,我們在MyBatis中添加typeHandler用于指定哪些類使用我們自定義的轉換器,一旦系統中的枚舉類多了起來,MyBatis的配置文件維護起來會變得非常麻煩,也容易出錯。如何解決呢?
在Spring中我們可以使用JavaConfig方式來干預SqlSessionFactory的創建過程,來完成轉換器的指定。
思路
再寫一個能自動匹配轉換行為的轉換器
通過sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()取得類型轉換器注冊器
再使用typeHandlerRegistry.setDefaultEnumTypeHandler(Class extends TypeHandler> typeHandler)將第一步的轉換器注冊成為默認的
首先,我們需要一個能確定轉換行為的轉換器:
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)){ // 如果實現了 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中優雅的使用枚舉的探索。如果你還有更優的解決方案,請一定在評論中告知,萬分感激。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://m.specialneedsforspecialkids.com/yun/70196.html
摘要:內置的枚舉處理器為了處理上述遇到的問題,內置了兩種,分別是和。將使用枚舉實例的值序數值,從開始來和枚舉類之間做轉換。比如有記錄顯式為全局指定在查詢時,類變量將自動賦值為,添加記錄時同理,數據庫值將存儲為其枚舉類實例序號。 場景描述 我們在實際場景中經常會遇到需要將枚舉值存儲到數據庫中,或是將從數據庫中查詢到的值對應到枚舉類上的情況。 比如表process大致定義如下: -- -----...
摘要:自帶對枚舉的處理類該類實現了枚舉類型和類型的相互轉換。而在具體中也需要使用屬性,如在處理到該位置時,就會調用指定的處理類來處理枚舉類型。 mybatis自帶對枚舉的處理類 org.apache.ibatis.type.EnumOrdinalTypeHandler :該類實現了枚舉類型和Integer類型的相互轉換。 但是給轉換僅僅是將對應的枚舉轉換為其索引位置,也就是ordinal(...
摘要:哪吒社區技能樹打卡打卡貼函數式接口簡介領域優質創作者哪吒公眾號作者架構師奮斗者掃描主頁左側二維碼,加入群聊,一起學習一起進步歡迎點贊收藏留言前情提要無意間聽到領導們的談話,現在公司的現狀是碼農太多,但能獨立帶隊的人太少,簡而言之,不缺干 ? 哪吒社區Java技能樹打卡?【打卡貼 day2...
摘要:本文速覽本篇文章是我為接下來的源碼分析系列文章寫的一個導讀文章。年該項目從基金會遷出,并改名為。同期,停止維護。符號所在的行則是表示的執行結果。同時,使用無需處理受檢異常,比如。另外,把寫在配置文件中,進行集中管理,利于維護。 1.本文速覽 本篇文章是我為接下來的 MyBatis 源碼分析系列文章寫的一個導讀文章。本篇文章從 MyBatis 是什么(what),為什么要使用(why),...
閱讀 4015·2023-04-26 02:13
閱讀 2260·2021-11-08 13:13
閱讀 2748·2021-10-11 10:59
閱讀 1745·2021-09-03 00:23
閱讀 1314·2019-08-30 15:53
閱讀 2293·2019-08-28 18:22
閱讀 3061·2019-08-26 10:45
閱讀 744·2019-08-23 17:58