MyBatis对于Java对象里的枚举类型处理

平时咱们写程序实体类内或多或少都会有枚举类型属性，方便嘛。但是mybatis里怎么处理他们的增删改查呢？

要求：

插入的时候，会用枚举的定义插入数据库，我们希望在数据库中看到的是数字或者其他东西；

查询的时候，数据库的值可以自动转换为我们对应的枚举值。

举例，我有一个这样的枚举类型：

Java Code复制内容到剪贴板

1. package cn.com.shuyangyang.domain;
2. public enum UserStatus {
3. /** 无效*/
4. DISABLED(0),
5. /** 有效 */
6. AVAILABLE(1);
7. private int status;
8. UserStatus(int status){
9. this.status = status;
10. }
11. public int getStatus() {
12. return status;
13. }
14. }

我们插入数据库中，数据库应该为我们保存0或者1

我们可以使用mybatis自带的枚举类型EnumOrdinalTypeHandler

举例如下：

Java Code复制内容到剪贴板

1. <insert id="addUser" parameterType="User">
2. INSERT INTO t_user(USER_ID,USER_NAME,LOGIN_NAME,
3. LOGIN_PASSWORD,USER_STATUS,CREATE_TIME,UPDATE_TIME)
4. VALUES(
5. #{user_id},
6. #{user_name},
7. #{login_name},
8. #{login_password},
9. #{user_status, typeHandler=org.apache.ibatis.type.EnumOrdinalTypeHandler},
10. #{create_time},
11. #{update_time}
12. )
13. </insert>

我们的UserStatus插入的时候是UserStatus.AVAILABLE

执行完毕后，看结果：

看，是不是结果是我们期望的那样。

但是问题来了？

我们查询的时候报错了：Error querying database.  Cause: java.lang.IllegalArgumentException: No enum constant cn.com.shuyangyang.mybatis.UserStatus.1

我们可以自定义这样的一个EnumStatusHandler：

Java Code复制内容到剪贴板

1. package cn.com.shuyangyang.mybatis;
2. import java.sql.CallableStatement;
3. import java.sql.PreparedStatement;
4. import java.sql.ResultSet;
5. import java.sql.SQLException;
6. import org.apache.ibatis.type.BaseTypeHandler;
7. import org.apache.ibatis.type.JdbcType;
8. /**
9. * Mybatis自定义转换类型
10. * @author ShuYangYang
11. * E-Mail:[email protected]
12. * http://www.shuyangyang.com.cn
13. * Date:2015年1月26日下午10:12:54
14. *
15. */
16. public class EnumStatusHandler extends BaseTypeHandler<UserStatus> {
17. private Class<UserStatus> type;
18. private final UserStatus[] enums;
19. /**
20. * 设置配置文件设置的转换类以及枚举类内容，供其他方法更便捷高效的实现
21. * @param type 配置文件中设置的转换类
22. */
23. public EnumStatusHandler(Class<UserStatus> type) {
24. if (type == null)
25. throw new IllegalArgumentException("Type argument cannot be null");
26. this.type = type;
27. this.enums = type.getEnumConstants();
28. if (this.enums == null)
29. throw new IllegalArgumentException(type.getSimpleName()
30. + " does not represent an enum type.");
31. }
32. @Override
33. public void setNonNullParameter(PreparedStatement ps, int i,
34. UserStatus parameter, JdbcType jdbcType) throws SQLException {
35. // baseTypeHandler已经帮我们做了parameter的null判断
36. ps.setInt(i, parameter.getStatus());
37. }
38. @Override
39. public UserStatus getNullableResult(ResultSet rs, String columnName)
40. throws SQLException {
41. // 根据数据库存储类型决定获取类型，本例子中数据库中存放INT类型
42. int i = rs.getInt(columnName);
43. if (rs.wasNull()) {
44. return null;
45. } else {
46. // 根据数据库中的code值，定位EnumStatus子类
47. return locateEnumStatus(i);
48. }
49. }
50. @Override
51. public UserStatus getNullableResult(ResultSet rs, int columnIndex)
52. throws SQLException {
53. // 根据数据库存储类型决定获取类型，本例子中数据库中存放INT类型
54. int i = rs.getInt(columnIndex);
55. if (rs.wasNull()) {
56. return null;
57. } else {
58. // 根据数据库中的code值，定位EnumStatus子类
59. return locateEnumStatus(i);
60. }
61. }
62. @Override
63. public UserStatus getNullableResult(CallableStatement cs, int columnIndex)
64. throws SQLException {
65. // 根据数据库存储类型决定获取类型，本例子中数据库中存放INT类型
66. int i = cs.getInt(columnIndex);
67. if (cs.wasNull()) {
68. return null;
69. } else {
70. // 根据数据库中的code值，定位EnumStatus子类
71. return locateEnumStatus(i);
72. }
73. }
74. /**
75. * 枚举类型转换，由于构造函数获取了枚举的子类enums，让遍历更加高效快捷
76. * @param code 数据库中存储的自定义code属性
77. * @return code对应的枚举类
78. */
79. private UserStatus locateEnumStatus(int code) {
80. for(UserStatus status : enums) {
81. if(status.getStatus()==(Integer.valueOf(code))) {
82. return status;
83. }
84. }
85. throw new IllegalArgumentException("未知的枚举类型：" + code + ",请核对" + type.getSimpleName());
86. }
87. }

mapper.xml里这样配置：

XML/HTML Code复制内容到剪贴板

1. <resultMap type="User" id="userResult">
2. ……省略其他属性配置
3. <result column="USER_STATUS" property="user_status" typeHandler="cn.com.shuyangyang.mybatis.EnumStatusHandler"/>
4. ……省略其他属性配置
5. </resultMap>

现在来看看结果：

[User [user_id=782cba19-559f-41c3-a1b0-25fcac4cf118, user_name=系统管理员, login_name=admin, login_password=admin,user_status=AVAILABLE, create_time=Mon Jan 26 21:17:09 CST 2015, update_time=Mon Jan 26 21:17:09 CST 2015]]

完美结果。

来源： http://www.shuyangyang.com.cn/jishuliangongfang/Javabiancheng/2015-01-26/229.html

来自为知笔记(Wiz)