前言
在 Spring Boot 中使用 Mybatis 中遇到了字段為枚舉類型，數據庫存儲的是枚舉的值，發現它不能自動裝載。
解決
內置枚舉轉換器
MyBatis內置了兩個枚舉轉換器分別是：org.apache.ibatis.type.EnumTypeHandler 和 org.apache.ibatis.type.EnumOrdinalTypeHandler。
EnumTypeHandler
mybatis 中默認的枚舉轉換器，是獲取枚舉中的 name 屬性。
EnumOrdinalTypeHandler
獲取枚舉中 ordinal 屬性，就是例如索引一樣的東西，不過是從 1 開始遞增的。
因此上面提供的兩種的轉換器都不能滿足我們的需求，我們需要自定義一個轉換器。
自定義枚舉轉換器
MyBatis提供了 org.apache.ibatis.type.BaseTypeHandler 類用於我們自己擴展類型轉換器，上面的EnumTypeHandler和EnumOrdinalTypeHandler 也都實現了這個接口。
繼承 BaseTypeHandler<T> 一共需要實現4個方法：
1. void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)
用於定義設置參數時，該如何把Java類型的參數轉換為對應的數據庫類型；
2. T getNullableResult(ResultSet rs, String columnName)
用於定義通過字段名稱獲取字段數據時，如何把數據庫類型轉換為對應的Java類型；
3. T getNullableResult(ResultSet rs, int columnIndex)
用於定義通過字段索引獲取字段數據時，如何把數據庫類型轉換為對應的Java類型；
4. T getNullableResult(CallableStatement cs, int columnIndex)
用定義調用存儲過程后，如何把數據庫類型轉換為對應的Java類型。
定義一個枚舉通用行為
定義一個枚舉通用行為，規范枚舉的實現。
public interface BaseEnum<E extends Enum<?>, T> {
/** * 獲取枚舉的值 * @return 枚舉的值 */
T getValue();
}定義自己需要的枚舉：
public class SysConstant {
/** * 人員狀態 */
public enum SysUserStatus implements BaseEnum<SysUserStatus, String> {
/** * 賬戶已經激活（默認） */
ACTIVE("1"),
/** * 賬戶鎖定 */
LOCK("0");
private String value;
private SysUserStatus(String value) {
this.value = value;
}
@Override
public String getValue() {
return value;
}
}
/** * 人員類型 */
public enum SysUserType implements BaseEnum<SysUserType, String> {
/** * 普通用戶 */
USER("1"),
/** * 系統管理員 */
ADMIN("0");
private String value;
private SysUserType(String value) {
this.value = value;
}
@Override
public String getValue() {
return value;
}
}
}實現自定義轉換器
自定義一個基本的枚舉轉換器工具，如果有其他需求可以在這個基類上自定義。
package com.wuwii.common.util;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Objects;
/** * 參考 http://blog.csdn.net/fighterandknight/article/details/51520595 * 進行對本地項目的優化 * <p> * 解決 Mybatis 中枚舉的問題， * 獲取 ResultSet 的值都是獲取字符串的，然后比較字符串，以便通用。 * * @author Zhang Kai * @version 1.0 * @since <pre>2018/2/9 17:26</pre> */
public abstract class BaseEnumTypeHandler<E extends Enum<E> & BaseEnum> extends BaseTypeHandler<E> {
/** * 枚舉的class */
private Class<E> type;
/** * 枚舉的每個子類枚 */
private E[] enums;
/** * 一定要有默認的構造函數，不然拋出 not found method 異常 */
public BaseEnumTypeHandler() {
}
/** * 設置配置文件設置的轉換類以及枚舉類內容，供其他方法更便捷高效的實現 * * @param type 配置文件中設置的轉換類 */
public BaseEnumTypeHandler(Class<E> type) {
if (type == null) {
throw new IllegalArgumentException("Type argument cannot be null");
}
this.type = type;
this.enums = type.getEnumConstants();
if (this.enums == null) {
throw new IllegalArgumentException(type.getSimpleName()
+ " does not represent an enum type.");
}
}
@Override
public void setNonNullParameter(PreparedStatement ps, int i, E parameter,
JdbcType jdbcType) throws SQLException {
/* * BaseTypeHandler已經幫我們做了parameter的null判斷 * 數據庫存儲的是枚舉的值，所以我們這里使用 value ， 如果需要存儲 name，可以自定義修改 */
if (jdbcType == null) {
ps.setString(i, Objects.toString(parameter.getValue()));
} else {
ps.setObject(i, parameter.getValue(), jdbcType.TYPE_CODE);
}
}
@Override
public E getNullableResult(ResultSet rs, String columnName)
throws SQLException {
String i = rs.getString(columnName);
if (rs.wasNull()) {
return null;
} else {
return locateEnumStatus(i);
}
}
@Override
public E getNullableResult(ResultSet rs, int columnIndex)
throws SQLException {
String i = rs.getString(columnIndex);
if (rs.wasNull()) {
return null;
} else {
return locateEnumStatus(i);
}
}
@Override
public E getNullableResult(CallableStatement cs, int columnIndex)
throws SQLException {
String i = cs.getString(columnIndex);
if (cs.wasNull()) {
return null;
} else {
return locateEnumStatus(i);
}
}
/** * 枚舉類型轉換，由於構造函數獲取了枚舉的子類 enums，讓遍歷更加高效快捷， * <p> * 我將取出來的值 全部轉換成字符串 進行比較， * * @param value 數據庫中存儲的自定義value屬性 * @return value 對應的枚舉類 */
private E locateEnumStatus(String value) {
for (E e : enums) {
if (Objects.toString(e.getValue()).equals(value)) {
return e;
}
}
throw new IllegalArgumentException("未知的枚舉類型：" + value + ",請核對"
+ type.getSimpleName());
}
}
配置轉換器
將枚舉轉換器編寫完成后，我們需要定義它對哪些枚舉進行轉換。
可以在Mybatis 配置文件配置
<typeHandlers>
<typeHandler handler="com.example.typeHandler.CodeEnumTypeHandler" javaType="com.example.entity.enums.ComputerState"/>
</typeHandlers>
優化
在MyBatis中添加typeHandler用於指定哪些類使用我們自定義的轉換器，一旦系統中的枚舉類多了起來，MyBatis的配置文件維護起來會變得非常麻煩，也容易出錯。
方法一：
定義一個 EnumTypeHandler 去繼承我們的 BaseEnumTypeHandler。然后使用注解 @MappedTypes 類型轉換。
package com.wuwii.module.sys.common.handle;
import com.wuwii.common.handle.BaseEnumTypeHandler;
import com.wuwii.common.util.BaseEnum;
import com.wuwii.module.sys.common.util.SysConstant;
import org.apache.ibatis.type.MappedTypes;
/** * 枚舉轉換的公共模塊 * * @author Zhang Kai * @version 1.0 * @since <pre>2018/2/9 18:12</pre> */
@MappedTypes(value = {SysConstant.SysUserStatus.class, SysConstant.SysUserType.class})
public class SysEnumTypeHandler<E extends Enum<E> & BaseEnum> extends BaseEnumTypeHandler<E> {
/** * 設置配置文件設置的轉換類以及枚舉類內容，供其他方法更便捷高效的實現 * * @param type 配置文件中設置的轉換類 */
public SysEnumTypeHandler(Class<E> type) {
super(type);
}
}需要在系統配置文件中配置
# 多個模塊的的多個 包配置可以使用逗號分開。
mybatis:
typeHandlersPackage: com.wuwii.module.sys.common.handle,com.wuwii.module.task.common.handle方法二：
如果你的項目中自定義了 SqlSessionFactory，推薦使用下面這種方式，一次使用無需多次配置。
在 =》 方案 6. 優化
方法三：
還有個人修改源碼實現的，有興趣的可以看看：