這篇文章給大家介紹枚舉如何在MyBatis中使用，內容非常詳細，感興趣的小伙伴們可以參考借鑒，希望對大家能有所幫助。
具體方法如下：
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。
EnumTypeHandler
這是默認的枚舉轉換器，該轉換器將枚舉實例轉換為實例名稱的字符串，即將ComputerState.OPEN轉換OPEN。
EnumOrdinalTypeHandler
顧名思義這個轉換器將枚舉實例的ordinal屬性作為取值，即ComputerState.OPEN轉換為0,ComputerState.CLOSE轉換為1。
使用它的方式是在MyBatis配置文件中定義：
<typeHandlers> <typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="com.example.entity.enums.ComputerState"/> </typeHandlers>
以上的兩種轉換器都不能滿足我們的需求，所以看起來要自己編寫一個轉換器了。
方案
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 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)T getNullableResult(ResultSet rs, String columnName)T getNullableResult(ResultSet rs, int columnIndex)T getNullableResult(CallableStatement cs, int columnIndex)我是這樣實現的：
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. 使用
接下來需要指定哪個類使用我們自己編寫轉換器進行轉換，在MyBatis配置文件中配置如下：
<typeHandlers> <typeHandler handler="com.example.typeHandler.CodeEnumTypeHandler" javaType="com.example.entity.enums.ComputerState"/> </typeHandlers>
搞定！ 經測試ComputerState.OPEN被轉換為10,ComputerState.UNKNOWN被轉換為255，達到了預期的效果。
6. 優化
在第5步時，我們在MyBatis中添加typeHandler用于指定哪些類使用我們自定義的轉換器，一旦系統中的枚舉類多了起來，MyBatis的配置文件維護起來會變得非常麻煩，也容易出錯。如何解決呢？
在Spring Boot中我們可以干預SqlSessionFactory的創建過程，來完成動態的轉換器指定。
思路
sqlSessionFactory.getConfiguration().getTypeHandlerRegistry()取得類型轉換器注冊器實現如下：
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();
// ----------- 動態加載實現BaseCodeEnum接口的枚舉，使用CodeEnumTypeHandler轉換器
// 取得類型轉換注冊器
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());
// 判斷是否實現了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中使用就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
