MyBatis中如何優(yōu)雅的使用枚舉詳解
更新時間：2017年08月21日 10:18:45 作者：Francis_Lee
枚舉類型是我們在開發(fā)中經(jīng)常遇到的一個類型，最近在學習MyBatis，但是發(fā)現(xiàn)網(wǎng)上沒有詳細介紹MyBatis如何使用枚舉的相關文章，索性就自己寫一篇，下面這篇文章主要給大家介紹了關于在MyBatis中如何優(yōu)雅的使用枚舉的相關資料，需要的朋友可以參考借鑒。
問題
本文主要給大家介紹的是關于MyBatis使用枚舉的相關內(nèi)容，我們在編碼過程中，經(jīng)常會遇到用某個數(shù)值來表示某種狀態(tài)、類型或者階段的情況，比如有這樣一個枚舉：
public enum ComputerState {
OPEN(10), //開啟
CLOSE(11), //關閉
OFF_LINE(12), //離線
FAULT(200), //故障
UNKNOWN(255); //未知
private int code;
ComputerState(int code) { this.code = code; }
}
通常我們希望將表示狀態(tài)的數(shù)值存入數(shù)據(jù)庫，即ComputerState.OPEN存入數(shù)據(jù)庫取值為10。
探索
首先，我們先看看MyBatis是否能夠滿足我們的需求。
MyBatis內(nèi)置了兩個枚舉轉(zhuǎn)換器分別是：org.apache.ibatis.type.EnumTypeHandler和org.apache.ibatis.type.EnumOrdinalTypeHandler。
EnumTypeHandler
這是默認的枚舉轉(zhuǎn)換器，該轉(zhuǎn)換器將枚舉實例轉(zhuǎn)換為實例名稱的字符串，即將ComputerState.OPEN轉(zhuǎn)換OPEN。
EnumOrdinalTypeHandler
顧名思義這個轉(zhuǎn)換器將枚舉實例的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)換器都不能滿足我們的需求，所以看起來要自己編寫一個轉(zhuǎn)換器了。
方案
MyBatis提供了org.apache.ibatis.type.BaseTypeHandler類用于我們自己擴展類型轉(zhuǎn)換器，上面的EnumTypeHandler和EnumOrdinalTypeHandler也都實現(xiàn)了這個接口。
1. 定義接口
我們需要一個接口來確定某部分枚舉類的行為。如下：
public interface BaseCodeEnum {
int getCode();
}
該接口只有一個返回編碼的方法，返回值將被存入數(shù)據(jù)庫。
2. 改造枚舉
就拿上面的ComputerState來實現(xiàn)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. 編寫一個轉(zhuǎn)換工具類
現(xiàn)在我們能順利的將枚舉轉(zhuǎn)換為某個數(shù)值了，還需要一個工具將數(shù)值轉(zhuǎn)換為枚舉實例。
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)換器
準備工作做的差不多了，是時候開始編寫轉(zhuǎn)換器了。
BaseTypeHandler<T> 一共需要實現(xiàn)4個方法：
void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)
用于定義設置參數(shù)時，該如何把Java類型的參數(shù)轉(zhuǎn)換為對應的數(shù)據(jù)庫類型T getNullableResult(ResultSet rs, String columnName)
用于定義通過字段名稱獲取字段數(shù)據(jù)時，如何把數(shù)據(jù)庫類型轉(zhuǎn)換為對應的Java類型T getNullableResult(ResultSet rs, int columnIndex)
用于定義通過字段索引獲取字段數(shù)據(jù)時，如何把數(shù)據(jù)庫類型轉(zhuǎn)換為對應的Java類型T getNullableResult(CallableStatement cs, int columnIndex)
用定義調(diào)用存儲過程后，如何把數(shù)據(jù)庫類型轉(zhuǎn)換為對應的Java類型
我是這樣實現(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. 使用
接下來需要指定哪個類使用我們自己編寫轉(zhuǎn)換器進行轉(zhuǎn)換，在MyBatis配置文件中配置如下：
<typeHandlers> <typeHandler handler="com.example.typeHandler.CodeEnumTypeHandler" javaType="com.example.entity.enums.ComputerState"/> </typeHandlers>
搞定！ 經(jīng)測試ComputerState.OPEN被轉(zhuǎn)換為10,ComputerState.UNKNOWN被轉(zhuǎn)換為255，達到了預期的效果。
6. 優(yōu)化
在第5步時，我們在MyBatis中添加typeHandler用于指定哪些類使用我們自定義的轉(zhuǎn)換器，一旦系統(tǒng)中的枚舉類多了起來，MyBatis的配置文件維護起來會變得非常麻煩，也容易出錯。如何解決呢？
在Spring Boot中我們可以干預SqlSessionFactory的創(chuàng)建過程，來完成動態(tài)的轉(zhuǎn)換器指定。
思路
- 通過
sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()取得類型轉(zhuǎn)換器注冊器 - 掃描所有實體類，找到實現(xiàn)了BaseCodeEnum接口的枚舉類
- 將實現(xiàn)了BaseCodeEnum的類注冊使用CodeEnumTypeHandler進行轉(zhuǎn)換。
實現(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);
// 設置配置文件地址
ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
factory.setConfigLocation(resolver.getResource(configLocation));
factory.setMapperLocations(resolver.getResources(mapperLocations));
SqlSessionFactory sqlSessionFactory = factory.getObject();
// ----------- 動態(tài)加載實現(xiàn)BaseCodeEnum接口的枚舉，使用CodeEnumTypeHandler轉(zhuǎn)換器
// 取得類型轉(zhuǎn)換注冊器
TypeHandlerRegistry typeHandlerRegistry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry();
// 掃描所有實體類
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());
// 判斷是否實現(xiàn)了BaseCodeEnum接口
if (aClass.isEnum() && BaseCodeEnum.class.isAssignableFrom(aClass)) {
// 注冊
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 位置表達式
* @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;
}
}
總結
以上就是我對如何在MyBatis中優(yōu)雅的使用枚舉的探索。如果你還有更優(yōu)的解決方案，請一定在評論中告知，萬分感激。希望本文的內(nèi)容對大家的學習或者工作能帶來一定的幫助，謝謝大家對腳本之家的支持。
相關文章
java.lang.FileNotFoundException 異常的正確解決方法(親測有效)
java.io.FileNotFoundException是一個在文件操作過程中常見的異常,它屬于IOException的一個子類,這篇文章主要介紹了java.lang.FileNotFoundException 異常的正確解決方法(親測有效),需要的朋友可以參考下2024-01-01
java中構造器內(nèi)部調(diào)用構造器實例詳解
在本篇文章里小編給大家分享的是關于java中構造器內(nèi)部調(diào)用構造器實例內(nèi)容，需要的朋友們可以學習下。2020-05-05
在Java編程里,枚舉（enum）其實是一種特別的類型,用來表示一組常量,當我們開發(fā)程序的時候,常常需要給這些枚舉加點其他功能,比如自增賦值的方法,這樣就能更方便地管理和使用啦,這篇文章和大家聊聊,怎么在Java中實現(xiàn)枚舉的自增賦值2025-04-04
這篇文章主要介紹了Spring中存對象和取對象的方式,Spring中更簡單的存對象與取對象的方式是注解,注解實現(xiàn)有兩種方式：一在編譯的時候,把注解替換成相關代碼,并添加到我們原來的代碼中,二攔截方法,文中有詳細的代碼示例供大家參考,需要的朋友可以參考下2024-08-08
在SpringBoot項目的生命周期中，存在不同的環(huán)境，我們就需要針對不同環(huán)境制定不同名稱的配置文件，里面放置不同環(huán)境下所需的配置項，下面小編就來和大家詳細講講SpringBoot如何進行多環(huán)境啟動配置的吧2024-02-02
這篇文章主要介紹了String.trim()消除不了空格的問題及解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-07-07
Stream是Java8的一大亮點,是對容器對象功能的增強，下面這篇文章主要給大家介紹了關于java8中Stream使用的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2018-10-10
這篇文章主要介紹了Springboot 使用@Async整合線程池的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-06-06
這篇文章主要為大家詳細介紹了23種設計模式之java中介者模式，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-01-01
這篇文章主要介紹了Spring中@Primary注解的作用詳解,@Primary 注解是Spring框架中的一個注解,用于標識一個Bean作為默認的實現(xiàn)類,當存在多個實現(xiàn)類時,通過使用@Primary注解,可以指定其中一個作為默認的實現(xiàn)類,以便在注入時自動選擇該實現(xiàn)類,需要的朋友可以參考下2023-10-10