Mybatis枚举使用

枚举定义如下：

public enum SexEnum {
    //男
    nan("sex1"),
    //女
    nv("sex2");

    private String sex;
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }

    SexEnum(String s){
        this.sex=s;
    }
}

实体如下：

public class User{
    private long id;
    private String userName;
    private SexEnum sex;

    //略过get set方法....
}

下面新增实体对象sex属性值为：SexEnum.nan，SQL中ID都自己设置，主要是看存储枚举的值。

1.存储枚举的名称，sex在数据库中值为：nan

此方式是mybatis对枚举类型的默认处理方式，使用的类型处理器是org.apache.ibatis.type.EnumTypeHandler

SQL如下：

<insert id="add" parameterType="com.test.entity.User">
    insert into user (id,username,sex) values
    (#{id},#{username},#{sex})
</insert>

2.存储枚举的索引，sex在数据库中值为：0

此方式使用的类型处理器是org.apache.ibatis.type.EnumOrdinalTypeHandler,使用 typeHandler 设置类型处理为org.apache.ibatis.type.EnumOrdinalTypeHandler

SQL如下：

<insert id="add" parameterType="com.test.entity.User">
    insert into user (id,username,sex) values
    (#{id},#{username},#{sex,typeHandler=org.apache.ibatis.type.EnumOrdinalTypeHandler})
</insert>

3.存储枚举的值

前面两种方式使用mybatis提供的类型处理器，如果想存储上面枚举的值，比如：SexEnum.nan的值sex1,就需要创建一个自定义的类型处理器,只需要继承BaseTypeHandler

自定义类型处理器如下：

public class StringEnumTypeHandler extends BaseTypeHandler<SexEnum>{

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, SexEnum parameter, JdbcType jdbcType)
            throws SQLException {
        ps.setString(i, parameter.getSex());
    }

    @Override
    public SexEnum getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String val = rs.getString(columnName);
        return getEnum(val);
    }

    @Override
    public SexEnum getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return getEnum(rs.getString(columnIndex));
    }

    @Override
    public SexEnum getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return getEnum(cs.getNString(columnIndex));
    }

    /**
     * 根据值获得对应的枚举
     * @param val
     * @return
     */
    private SexEnum getEnum(String val){
        Class<SexEnum> sexClass = SexEnum.class;
        SexEnum[] sexs = sexClass.getEnumConstants();

        for(SexEnum se:sexs){
            if(se.getSex().equals(val)){
                return se;
            }
        }
        return null;
    }
}

最后在mybatis的配置文件的typeHandlers节点下添加如下配置:

<typeHandler handler="com.test.EnumHandlers.StringEnumTypeHandler" javaType="com.test.enums.SexEnum" />

完整的配置如下：

<configuration> 
    <typeHandlers>
        <typeHandler handler="com.test.EnumHandlers.StringEnumTypeHandlerr" javaType="com.test.enums.SexEnum" />
    </typeHandlers>
</configuration>

SQL里面的typeHandler使用自定义的类型处理器

<insert id="add" parameterType="com.test.entity.User">
    insert into user (id,username,sex) values
    (#{id},#{username},#{sex,typeHandler=com.test.EnumHandlers.StringEnumTypeHandler})
</insert>