mybatis处理enum类型

一直用hibernate，习惯了枚举类的使用，非常方便，现在用mybatis，发现枚举的处理，还是需要单独处理下。

如果想使用mybatis自带的枚举类处理，有2种方式，一个是EnumTypeHandler，一个是EnumOrdinalTypeHandler。
2者的区别是EnumTypeHandler直接存储name值，而EnumOrdinalTypeHandler会存储enum类里的序号值，此时数据库表字段一般用int类型的处理。

使用方式比较简单，直接在mapper文件里的字段上，加上

typeHandler="org.apache.ibatis.type.EnumOrdinalTypeHandler"

或

typeHandler="org.apache.ibatis.type.EnumTypeHandler"

然后insert或者update的地方，字段处也加上相应的typeHandler即可。

 

但通常的情况下，我们并不希望用序号来标记，而希望通过自定义的id值来存储，这时我们就需要自己写enum的处理类。

为了使处理类通用，我们用泛型来处理，首先定义一个接口类：

 

1. public interface IntEnum<E extends Enum<E>> {

2. int getIntValue();

3. }

 

然后自己的枚举类，去实现这个接口，主要是实现getIntValue方法：

 

1. public enum TestStatusEnum implements IntEnum<TestStatusEnum> {

2. FAILURE(0, "failure"), SUCCESS(1, "success");

3. private int index;

4. private String name;

5.  

6. //....get set

7. private TestStatusEnum(int index, String name) {

8. this.index = index;

9. this.name = name;

10. }

11.  

12. public static String fromIndex(int index) {

13. for (TestStatusEnump : TestStatusEnum.values()) {

14. if (index == p.getIndex())

15. return p.name;

16. }

17. return null;

18. }

19.  

20. @Override

21. public int getIntValue() {

22. return this.index;

23. }

pojo类里的status字段属性，定义为 TestStatusEnum status。

然后自定义一个hanler类：

 

1. public class IntEnumTypeHandler<E extends Enum<E> & IntEnum<E>> extends

2. BaseTypeHandler<IntEnum> {

3. private Class<IntEnum> type;

4.  

5. public IntEnumTypeHandler(Class<IntEnum> type) {

6. if (type == null)

7. throw new IllegalArgumentException("Type argument cannot be null");

8. this.type = type;

9. }

10.  

11. private IntEnum convert(int status) {

12. IntEnum[] objs = type.getEnumConstants();

13. for (IntEnum em : objs) {

14. if (em.getIntValue() == status) {

15. return em;

16. }

17. }

18. return null;

19. }

20.  

21. @Override

22. public IntEnum getNullableResult(ResultSet rs, String columnName)

23. throws SQLException {

24. return convert(rs.getInt(columnName));

25. }

26.  

27. @Override

28. public IntEnum getNullableResult(ResultSet rs, int columnIndex)

29. throws SQLException {

30. return convert(rs.getInt(columnIndex));

31. }

32.  

33. @Override

34. public IntEnum getNullableResult(CallableStatement cs, int columnIndex)

35. throws SQLException {

36. return convert(cs.getInt(columnIndex));

37. }

38.  

39. @Override

40. public void setNonNullParameter(PreparedStatement ps, int i,

41. IntEnum enumObj, JdbcType jdbcType) throws SQLException {

42. // baseTypeHandler已经帮我们做了parameter的null判断

43. ps.setInt(i, enumObj.getIntValue());

44.  

45. }

46. }

 

在mapper文件里，加上typehandler的定义，比如：
<result column="status" property="status"
            jdbcType="BIT" typeHandler="com.**.IntEnumTypeHandler" />
insert和update的地方，同样加上#{condition.status,jdbcType=BIT,typeHandler=com.**.IntEnumTypeHandler}

最后测试下，insert后，表里会存储对应的id值，select的时候，mybatis会自动获取name值。

 

另外有个问题是，当使用了enum类型后，mybatis查询，是获取到的enum对象。比如我们enum里，有name属性，我们在转换到json的时候，想直接获取这个name属性

，就可以使用fastjson来转，最新版本的json已经支持读取enum的toString方法来序列化。

代码：
JSON.DEFFAULT_DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";
        String objJson = JSON.toJSONString(results,
                SerializerFeature.WriteDateUseDateFormat,
                SerializerFeature.WriteEnumUsingToString);
        jsonObject.put("results", objJson);