摘要：EnumTypeHandlermybatis中的默认枚举转换器是获取枚举中的name属性。EnumOrdinalTypeHandler获取枚举中的序数属性，该属性与索引类似，但从1开始增加。自定义枚举转换器MyBatis提供org.apache。伊巴提斯。type BaseTypeHandler类用于自己扩展类型转换器。上述EnumTypeHandler和EnumOrdinalTypeHandler也实现了此接口。
https://blog.wuwii.com/springboot-12.html
前言
在 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个方法：
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类型。
定义一个枚举通用行为
定义一个枚举通用行为，规范枚举的实现。
1
2
3
4
5
6
7
| public interface BaseEnum<E extends Enum<?>, T> {
/**
* 获取枚举的值
* @return 枚举的值
*/
T getValue();
}
|
定义自己需要的枚举：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
| 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;
}
}
}
|
实现自定义转换器
自定义一个基本的枚举转换器工具，如果有其他需求可以在这个基类上自定义。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
| 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>
* 我将取出来的值 全部转换成字符串 进行比较，
*
* |