MyBatis 之枚举映射

314598340

我定义一些实体时，有时我们在定义枚举是会用到枚举，Mybatis提供了EnumTypeHandler和EnumOrdinalTypeHandler完成枚举类型的转换，两者的功能已经基本满足了日常的使用。但是有可能我们不想使用枚举的name和ordinal作为数据存储字段，因此我们需要自己定义转换类。
 
以下是我在项目中用到的一个比较通用的枚举处理方式
 
1、枚举的抽象接口
因为比较通用，所以抽取出来了

public interface GenericEnum {
int getCode();
String getName();
}
 
2、枚举类

public enum CommStatus implements GenericEnum {
DELETED(-1, "Deleted"), ENABLE(1, "Enable"), UNABLE(0, "Unable");
private int code;
private String name;
CommStatus(int code, String name) {
this.code = code;
this.name = name;
}
public int getCode() {
return this.code;
}
public String getName() {
return this.name;
}
public static CommStatus valueOfEnum(int code) {
CommStatus[] iss = values();
for (CommStatus cs : iss) {
if (cs.getCode() == code) {
return cs;
}
}
return null;
}
}
 
 
3、枚举转换类
数据库保存code的转换类

/**
* @author leibo
*
*         2014-2-12 上午10:27:23
*/
public class GenericEnumCodeHandler extends BaseTypeHandler<GenericEnum> {
private final GenericEnum[] enums;
/**
*
* 设置配置文件设置的转换类以及枚举类内容，供其他方法更便捷高效的实现
*
* @param type
*            配置文件中设置的转换类
*/
public GenericEnumCodeHandler(Class<GenericEnum> type) {
if (type == null)
throw new IllegalArgumentException("Type argument cannot be null");
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,
GenericEnum parameter, JdbcType jdbcType) throws SQLException {
// baseTypeHandler已经帮我们做了parameter的null判断
ps.setInt(i, parameter.getCode());
}
@Override
public GenericEnum getNullableResult(ResultSet rs, String columnName)
throws SQLException {
// 根据数据库存储类型决定获取类型，本例子中数据库中存放INT类型
int i = rs.getInt(columnName);
if (rs.wasNull()) {
return null;
} else {
// 根据数据库中的code值，定位EnumStatus子类
return locateEnumStatus(i);
}
}
@Override
public GenericEnum getNullableResult(ResultSet rs, int columnIndex)
throws SQLException {
// 根据数据库存储类型决定获取类型，本例子中数据库中存放INT类型
int i = rs.getInt(columnIndex);
if (rs.wasNull()) {
return null;
} else {
// 根据数据库中的code值，定位EnumStatus子类
return locateEnumStatus(i);
}
}
@Override
public GenericEnum getNullableResult(CallableStatement cs, int columnIndex)
throws SQLException {
// 根据数据库存储类型决定获取类型，本例子中数据库中存放INT类型
int i = cs.getInt(columnIndex);
if (cs.wasNull()) {
return null;
} else {
// 根据数据库中的code值，定位EnumStatus子类
return locateEnumStatus(i);
}
}
/**
* 枚举类型转换，由于构造函数获取了枚举的子类enums，让遍历更加高效快捷
*
* @param code
*            数据库中存储的自定义code属性
* @return code对应的枚举类
*/
private GenericEnum locateEnumStatus(int code) {
for (GenericEnum status : enums) {
if (status.getCode() == code) {
return status;
}
}
return null;
}
}
 
数据库保存Name的转换类

/**
* @author leibo
*
*         2014-2-12 上午10:27:23
*/
public class GenericEnumNameHandler extends BaseTypeHandler<GenericEnum> {
private final GenericEnum[] enums;
/**
*
* 设置配置文件设置的转换类以及枚举类内容，供其他方法更便捷高效的实现
*
* @param type
*            配置文件中设置的转换类
*/
public GenericEnumNameHandler(Class<GenericEnum> type) {
if (type == null)
throw new IllegalArgumentException("Type argument cannot be null");
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,
GenericEnum parameter, JdbcType jdbcType) throws SQLException {
// baseTypeHandler已经帮我们做了parameter的null判断
ps.setString(i, parameter.getName());
}
@Override
public GenericEnum getNullableResult(ResultSet rs, String columnName)
throws SQLException {
String name = rs.getString(columnName);
if (rs.wasNull()) {
return null;
} else {
return locateEnumStatus(name);
}
}
@Override
public GenericEnum getNullableResult(ResultSet rs, int columnIndex)
throws SQLException {
String name = rs.getString(columnIndex);
if (rs.wasNull()) {
return null;
} else {
return locateEnumStatus(name);
}
}
@Override
public GenericEnum getNullableResult(CallableStatement cs, int columnIndex)
throws SQLException {
String name = cs.getString(columnIndex);
if (cs.wasNull()) {
return null;
} else {
return locateEnumStatus(name);
}
}
private GenericEnum locateEnumStatus(String name) {
for (GenericEnum status : enums) {
if (status.getName().equals(name)) {
return status;
}
}
return null;
}
}
 
4、Mybatis配置文件
　　貌似也可以通过其他方式进行转换器的配置，但我感觉直接在用到的SQL中配置转换器更直观

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xxx.xxx.persistence.mapper.cc.FilterItemMapper">
<resultMap type="FilterItem" id="FilterItemMap">
<result property="id" column="id" />
<result property="pv" column="pv"
typeHandler="com.xxx.xxx.persistence.mapper.cc.handler.GenericEnumNameHandler" />
<result property="status" column="status"
typeHandler="com.xxx.xxx.persistence.mapper.cc.handler.GenericEnumCodeHandler" />
<result property="menuId" column="menu_id" />
<result property="versionRegular" column="version_regular" />
<result property="unionRegular" column="union_regular" />
<result property="regularRelation" column="regular_relation"
typeHandler="com.xxx.xxx.persistence.mapper.cc.handler.GenericEnumCodeHandler" />
<result property="effectiveStartTime" column="effective_starttime" />
<result property="effectiveEndTime" column="effective_endtime" />
</resultMap>
<insert id="insert" parameterType="FilterItem" useGeneratedKeys="true"
keyProperty="id">
insert into
t_cc_filter_menu
(pv,status,menu_id,version_regular,union_regular,regular_relation,effective_starttime,effective_endtime)
values
(#{pv,typeHandler=com.xxx.xxx.persistence.mapper.cc.handler.GenericEnumNameHandler},#{status,typeHandler=com.xxx.xxx.persistence.mapper.cc.handler.GenericEnumCodeHandler},#{menuId},#{versionRegular},#{unionRegular},
#{regularRelation,typeHandler=com.xxx.xxx.persistence.mapper.cc.handler.GenericEnumCodeHandler},#{effectiveStartTime},#{effectiveEndTime})
</insert>
<select id="queryById" parameterType="int" resultMap="FilterItemMap">
select
id,pv,status,menu_id,version_regular,union_regular,regular_relation,effective_starttime,effective_endtime
from t_cc_filter_menu
where id = #{id}
</select>
</mapper>