您好,登錄后才能下訂單哦!
這篇文章給大家介紹枚舉如何在MyBatis中使用,內(nèi)容非常詳細(xì),感興趣的小伙伴們可以參考借鑒,希望對(duì)大家能有所幫助。
具體方法如下:
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ù)庫(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)換器都不能滿足我們的需求,所以看起來要自己編寫一個(gè)轉(zhuǎn)換器了。
方案
MyBatis提供了org.apache.ibatis.type.BaseTypeHandler
類用于我們自己擴(kuò)展類型轉(zhuǎn)換器,上面的EnumTypeHandler和EnumOrdinalTypeHandler也都實(shí)現(xiàn)了這個(gè)接口。
1. 定義接口
我們需要一個(gè)接口來確定某部分枚舉類的行為。如下:
public interface BaseCodeEnum { int getCode(); }
該接口只有一個(gè)返回編碼的方法,返回值將被存入數(shù)據(jù)庫(kù)。
2. 改造枚舉
就拿上面的ComputerState來實(shí)現(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. 編寫一個(gè)轉(zhuǎn)換工具類
現(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; } }
4. 自定義類型轉(zhuǎn)換器
準(zhǔn)備工作做的差不多了,是時(shí)候開始編寫轉(zhuǎn)換器了。
BaseTypeHandler<T>
一共需要實(shí)現(xiàn)4個(gè)方法:
void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)
T getNullableResult(ResultSet rs, String columnName)
T getNullableResult(ResultSet rs, int columnIndex)
T getNullableResult(CallableStatement cs, int columnIndex)
我是這樣實(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 i = rs.getInt(columnName); if (rs.wasNull()) { return null; } else { try { return CodeEnumUtil.codeOf(type, i); } catch (Exception ex) { throw new IllegalArgumentException("Cannot convert " + i + " to " + type.getSimpleName() + " by ordinal value.", ex); } } } @Override public E getNullableResult(ResultSet rs, int columnIndex) throws SQLException { int i = rs.getInt(columnIndex); if (rs.wasNull()) { return null; } else { try { return CodeEnumUtil.codeOf(type, i); } catch (Exception ex) { throw new IllegalArgumentException("Cannot convert " + i + " to " + type.getSimpleName() + " by ordinal value.", ex); } } } @Override public E getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { int i = cs.getInt(columnIndex); if (cs.wasNull()) { return null; } else { try { return CodeEnumUtil.codeOf(type, i); } catch (Exception ex) { throw new IllegalArgumentException("Cannot convert " + i + " to " + type.getSimpleName() + " by ordinal value.", ex); } } } }
5. 使用
接下來需要指定哪個(gè)類使用我們自己編寫轉(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ù)期的效果。
6. 優(yōu)化
在第5步時(shí),我們?cè)贛yBatis中添加typeHandler用于指定哪些類使用我們自定義的轉(zhuǎn)換器,一旦系統(tǒng)中的枚舉類多了起來,MyBatis的配置文件維護(hù)起來會(huì)變得非常麻煩,也容易出錯(cuò)。如何解決呢?
在Spring Boot中我們可以干預(yù)SqlSessionFactory的創(chuàng)建過程,來完成動(dòng)態(tài)的轉(zhuǎn)換器指定。
思路
sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()
取得類型轉(zhuǎn)換器注冊(cè)器實(shí)現(xiàn)如下:
MyBatisConfig.java
@Configuration @ConfigurationProperties(prefix = "mybatis") public class MyBatisConfig { private String configLocation; private String mapperLocations; @Bean public SqlSessionFactory sqlSessionFactory(DataSource dataSource, ResourcesUtil resourcesUtil) throws Exception { SqlSessionFactoryBean factory = new SqlSessionFactoryBean(); factory.setDataSource(dataSource); // 設(shè)置配置文件地址 ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(); factory.setConfigLocation(resolver.getResource(configLocation)); factory.setMapperLocations(resolver.getResources(mapperLocations)); SqlSessionFactory sqlSessionFactory = factory.getObject(); // ----------- 動(dòng)態(tài)加載實(shí)現(xiàn)BaseCodeEnum接口的枚舉,使用CodeEnumTypeHandler轉(zhuǎn)換器 // 取得類型轉(zhuǎn)換注冊(cè)器 TypeHandlerRegistry typeHandlerRegistry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry(); // 掃描所有實(shí)體類 List<String> classNames = resourcesUtil.list("com/example", "/**/entity"); for (String className : classNames) { // 處理路徑成為類名 className = className.replace('/', '.').replaceAll("\\.class", ""); // 取得Class Class<?> aClass = Class.forName(className, false, getClass().getClassLoader()); // 判斷是否實(shí)現(xiàn)了BaseCodeEnum接口 if (aClass.isEnum() && BaseCodeEnum.class.isAssignableFrom(aClass)) { // 注冊(cè) typeHandlerRegistry.register(className, "com.example.typeHandler.CodeEnumTypeHandler"); } } // --------------- end return sqlSessionFactory; } public String getConfigLocation() { return configLocation; } public void setConfigLocation(String configLocation) { this.configLocation = configLocation; } public String getMapperLocations() { return mapperLocations; } public void setMapperLocations(String mapperLocations) { this.mapperLocations = mapperLocations; } }
ResourcesUtil.java
@Component public class ResourcesUtil { private final ResourcePatternResolver resourceResolver; public ResourcesUtil() { this.resourceResolver = new PathMatchingResourcePatternResolver(getClass().getClassLoader()); } /** * 返回路徑下所有class * * @param rootPath 根路徑 * @param locationPattern 位置表達(dá)式 * @return * @throws IOException */ public List<String> list(String rootPath, String locationPattern) throws IOException { Resource[] resources = resourceResolver.getResources("classpath*:" + rootPath + locationPattern + "/**/*.class"); List<String> resourcePaths = new ArrayList<>(); for (Resource resource : resources) { resourcePaths.add(preserveSubpackageName(resource.getURI(), rootPath)); } return resourcePaths; } }
關(guān)于枚舉如何在MyBatis中使用就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò),可以把它分享出去讓更多的人看到。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。