Question

如何在MyBatis中优雅的使用枚举

Answer 1

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)
用于定义设置参数时，该如何把Java类型的参数转换为对应的数据库类型
T getNullableResult(ResultSet rs, String columnName)
用于定义通过字段名称获取字段数据时，如何把数据库类型转换为对应的Java类型
T getNullableResult(ResultSet rs, int columnIndex)
用于定义通过字段索引获取字段数据时，如何把数据库类型转换为对应的Java类型
T getNullableResult(CallableStatement cs, int columnIndex)
用定义调用存储过程后，如何把数据库类型转换为对应的Java类型