mybatis-plus enum实现枚举类型自动转换
作者：xy294636185
mybatis-plus实现了对“实体类指定了枚举类型，想查询时返回的是枚举值而非value值”，“插入数据时，实体赋值的是枚举类型，想入库时插入对应的value值”，“不想写其他的handler处理程序，希望能够自动处理”。
mybatis-plus对于上述的诉求都可以满足，简单的处理方案是：
* 1、实现 IEnum of T
* 2、注解 @EnumValue，不用实现 IEnum of T
具体的官方文档为 https://mp.baomidou.com/guide/enum.html
定义一个简单实体
先定义一个示例实体类，我们在实体Demo中用到了DemoStatusEnum
/**
* 实体类
*/
@Data
@TableName("demo")
public class Demo extends Model<Demo> {
@TableField("status")
private DemoStatusEnum status;
}DemoStatusEnum枚举定义
我们采用了官方提到的两种方式的第一种：即实现IEnum<T>
/**
* 支持枚举值的两种方式
* 1、实现 IEnum of T
* 2、注解 @EnumValue，不用实现 IEnum of T
*/
@Getter
public enum DemoStatusEnum implements IEnum<Integer> {
DEFAULT(0, "default"),
NORMAL(1, "normal"),
LOCKED(2, "locked");
DemoStatusEnum(Integer value, String desc) {
this.value = value;
this.desc = desc;
}
private Integer value;
private String desc;
@Override
public Integer getValue() {
return this.value;
}
} 如果不想继承IEnum<T>，可以通过第二种方式，就是增加一个注解的方式@EnumValue
@EnumValue
private Integer value;
@JsonValue
private String desc;自动转换实现：
配置了Enums枚举，实体中设置了枚举类型，那么mybatis-plus如何转换的呢？重点是看这里
mybatis-plus:
global-config:
db-config:
logic-not-delete-value: 0 #逻辑未删除值为数据库主键
logic-delete-value: id #逻辑删除值是个d
# logic-delete-value: "now()" #逻辑删除值是个db获取时间的函数
# logic-not-delete-value: "null" #逻辑未删除值为字符串 "null"
# logic-not-delete-value: "1753-01-01 00:00:00"
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
# 如果是放在src/main/java目录下 classpath:/com/*/*/mapper/*Mapper.xml
# 如果是放在resource目录 classpath:/mapper/**.xml
default-enum-type-handler: org.apache.ibatis.type.EnumOrdinalTypeHandler
# 如果是放在src/main/java目录下 classpath:/com/*/*/mapper/*Mapper.xml
# 如果是放在resource目录 classpath:/mapper/**.xml
# 支持统配符 * 或者 ; 分割
typeEnumsPackage: com.fii.gxback.eam.domain.enums通过上述的配置后，就可以了。那么，接下来我们重点分析一下type-enums-package
按照官方文档说明：
枚举类 扫描路径，如果配置了该属性，会将路径下的枚举类进行注入，让实体类字段能够简单快捷的使用枚举属性
通过扒源码发现，其实是帮我们实现了对应的 typehandler(com.baomidou.mybatisplus.core.handlers.MybatisEnumTypeHandler)
其中，isMpEnums中，判定整合两种方式的判定，即 IEnum.class、EnumValue.class
/**
* 判断是否为MP枚举处理
*
* @param clazz class
* @return 是否为MP枚举处理
* @since 3.3.1
*/
public static boolean isMpEnums(Class<?> clazz) {
return clazz != null && clazz.isEnum() && (IEnum.class.isAssignableFrom(clazz) || findEnumValueFieldName(clazz).isPresent());
}
/**
* 查找标记标记EnumValue字段
*
* @param clazz class
* @return EnumValue字段
* @since 3.3.1
*/
public static Optional<String> findEnumValueFieldName(Class<?> clazz) {
if (clazz != null && clazz.isEnum()) {
String className = clazz.getName();
return Optional.ofNullable(CollectionUtils.computeIfAbsent(TABLE_METHOD_OF_ENUM_TYPES, className, key -> {
Optional<Field> optional = Arrays.stream(clazz.getDeclaredFields())
// 过滤包含注解@EnumValue的字段
.filter(field -> field.isAnnotationPresent(EnumValue.class))
.findFirst();
return optional.map(Field::getName).orElse(null);
}));
}
return Optional.empty();
}然后，在com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean#buildSqlSessionFactory中，
// 取得类型转换注册器
TypeHandlerRegistry typeHandlerRegistry = targetConfiguration.getTypeHandlerRegistry();
classes.stream()
.filter(Class::isEnum)
.filter(MybatisEnumTypeHandler::isMpEnums)
.forEach(cls -> typeHandlerRegistry.register(cls, MybatisEnumTypeHandler.class));验证逻辑
controller：
@RequestMapping("/{id}")
public Demo get(@PathVariable("id") Long id) {
return demoService.getById(id);
}输出：
"status": "DEFAULT"
可以看到，status最终输出的不是魔术数字0，而是枚举值default。
其实，跟一下代码，可以发现，跟我们自己手写一个typeHandler没区别，这里最终获取转换值时，调用了com.baomidou.mybatisplus.extension.handlers.MybatisEnumTypeHandler#getNullableResult(java.sql.ResultSet, int)，此时已经拿到了枚举值的具体类是什么了。接下来就是调用valueOf去获取对应的枚举值即可。
附源码：
package org.apache.ibatis.type;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
public class EnumOrdinalTypeHandler<E extends Enum<E>> extends BaseTypeHandler<E> {
private final Class<E> type;
private final E[] enums;
public EnumOrdinalTypeHandler(Class<E> type) {
if (type == null) {
throw new IllegalArgumentException("Type argument cannot be null");
} else {
this.type = type;
this.enums = (Enum[])type.getEnumConstants();
if (this.enums == null) {
throw new IllegalArgumentException(type.getSimpleName() + " does not represent an enum type.");
}
}
}
public void setNonNullParameter(PreparedStatement ps, int i, E parameter, JdbcType jdbcType) throws SQLException {
ps.setInt(i, parameter.ordinal());
}
public E getNullableResult(ResultSet rs, String columnName) throws SQLException {
int ordinal = rs.getInt(columnName);
return ordinal == 0 && rs.wasNull() ? null : this.toOrdinalEnum(ordinal);
}
public E getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
int ordinal = rs.getInt(columnIndex);
return ordinal == 0 && rs.wasNull() ? null : this.toOrdinalEnum(ordinal);
}
public E getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
int ordinal = cs.getInt(columnIndex);
return ordinal == 0 && cs.wasNull() ? null : this.toOrdinalEnum(ordinal);
}
private E toOrdinalEnum(int ordinal) {
try {
return this.enums[ordinal];
} catch (Exception var3) {
throw new IllegalArgumentException("Cannot convert " + ordinal + " to " + this.type.getSimpleName() + " by ordinal value.", var3);
}
}
}到此这篇关于mybatis-plus enum实现枚举类型自动转换的文章就介绍到这了,更多相关mybatis-plus 枚举自动转换内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！