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>