一、痛点
我们的项目开发中一定会遇到枚举,那么如何将枚举值存储在数据库,如何把枚举值返回给前端就成了一个必须考虑的问题。
假如我们的User实体定义如下,其中的status是个枚举,代表用户的状态:
@Data
class User{
private Long id;
private UserStatus status;//用户状态
}
@Getter
@AllArgsConstructor
class UserStatus{
ENABLED(1,"启用"),
DISABLED(2,"限制登录");
private static final Integer value;
private static final String name;
}
如果我们要将用户数据存储到数据库中,ORM 框架一般会将UserStatus 的ordinal(序号,从0开始)当作值来存储,在我们增加和删除状态时会带来很大的隐患,这显然是我们不能接受的,另外前端也可能会要求使用数字来传递这些枚举,所以我们就要寻求一些优雅的方法来处理这个问题。
二、解决方案
我们的目标呢,就是在传给前端或存储到数据库时,将这个枚举的value(Short或Int型)作为值,而不是枚举或者时枚举的ordinal。
2.0 让我们要进行转换的枚举继承一个统一的接口
public interface ConvertibleEnum {
Integer getValue();
}
@Getter
@AllArgsConstructor
class UserStatus extends ConvertibleEnum{
ENABLED(1,"启用"),
DISABLED(2,"限制登录");
private static final Integer value;
private static final String name;
}
2.1 MyBatis
Mybatis的处理比较简单,只要自定义一个TypeHandler,然后再添加一下配置就可以了。
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;
public class ValuedEnumTypeHandler<E extends ConvertibleEnum> extends BaseTypeHandler<E> {
private final Class<E> type;
private final E[] enums;
public