mybatis自定义枚举转换类

转载自:http://my.oschina.net/SEyanlei/blog/188919


mybatis提供了EnumTypeHandler和EnumOrdinalTypeHandler完成枚举类型的转换,两者的功能已经基本满足了日常的使用。但是可能有这样的需求:由于某种原因,我们不想使用枚举的name和ordinal作为数据存储字段。mybatis的自定义转换类出现了。

前提知识

1. mybatis废弃了ibatis的TypeHandlerCallback接口,取而代之的接口是TypeHandler,它与原来的接口略有不同,但是方法类似。(见说明 https://code.google.com/p/mybatis/wiki/DocUpgrade3

2. BaseTypeHandler是mybatis提供的基础转换类,该类实现了TypeHandler接口并提供很多公用方法,建议每个自定义转换类都继承它。

示例

使用一段代码,将枚举类EnumStatus中的code属性存储到数据库对应字段statusCustom。

自定义转换类

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

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException; import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType; import com.sg.bean.EnumStatus; /**
* 自定义EnumStatus转换类 <br>
* 存储属性:EnumStatus.getCode() <br>
* JDBCType:INT
* @author yanlei
*/
public class EnumStatusHandler extends BaseTypeHandler<EnumStatus> { private Class<EnumStatus> type; private final EnumStatus[] enums; /**
* 设置配置文件设置的转换类以及枚举类内容,供其他方法更便捷高效的实现
* @param type 配置文件中设置的转换类
*/
public EnumStatusHandler(Class<EnumStatus> type) {
if (type == null)
throw new IllegalArgumentException("Type argument cannot be null");
this.type = type;
this.enums = type.getEnumConstants();
if (this.enums == null)
throw new IllegalArgumentException(type.getSimpleName()
+ " does not represent an enum type.");
} @Override
public EnumStatus 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 EnumStatus 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 EnumStatus getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
// 根据数据库存储类型决定获取类型,本例子中数据库中存放INT类型
int i = cs.getInt(columnIndex);
if (cs.wasNull()) {
return null;
} else {
// 根据数据库中的code值,定位EnumStatus子类
return locateEnumStatus(i);
}
} @Override
public void setNonNullParameter(PreparedStatement ps, int i, EnumStatus parameter, JdbcType jdbcType)
throws SQLException {
// baseTypeHandler已经帮我们做了parameter的null判断
ps.setInt(i, parameter.getCode()); } /**
* 枚举类型转换,由于构造函数获取了枚举的子类enums,让遍历更加高效快捷
* @param code 数据库中存储的自定义code属性
* @return code对应的枚举类
*/
private EnumStatus locateEnumStatus(int code) {
for(EnumStatus status : enums) {
if(status.getCode().equals(Integer.valueOf(code))) {
return status;
}
}
throw new IllegalArgumentException("未知的枚举类型:" + code + ",请核对" + type.getSimpleName());
} }

枚举类

  1. package com.sg.bean;
  2. public enum EnumStatus {
  3. NORMAL(1, "正常"),
  4. DELETE(0, "删除"),
  5. CANCEL(2, "注销");
  6. private EnumStatus(int code, String description) {
  7. this.code = new Integer(code);
  8. this.description = description;
  9. }
  10. private Integer code;
  11. private String description;
  12. public Integer getCode() {
  13. return code;
  14. }
  15. public String getDescription() {
  16. return description;
  17. }
  18. }
mybatis自定义枚举转换类
package com.sg.bean;

public enum EnumStatus {
NORMAL(1, "正常"),
DELETE(0, "删除"),
CANCEL(2, "注销"); private EnumStatus(int code, String description) {
this.code = new Integer(code);
this.description = description;
}
private Integer code; private String description; public Integer getCode() { return code;
} public String getDescription() { return description;
}
}

实体类

  1. package com.sg.bean;
  2. public class User {
  3. private String id;
  4. private String accountID;
  5. private String userName;
  6. private EnumStatus statusDef; //枚举属性,使用mybatis默认转换类
  7. private EnumStatus statusOrdinal; //枚举属性,使用EnumOrdinalTypeHandler转换
  8. private EnumStatus statusCustom; // 枚举属性,自定义枚举转换类
  9. public String getId() {
  10. return id;
  11. }
  12. public void setId(String id) {
  13. this.id = id;
  14. }
  15. public String getAccountID() {
  16. return accountID;
  17. }
  18. public void setAccountID(String accountID) {
  19. this.accountID = accountID;
  20. }
  21. public String getUserName() {
  22. return userName;
  23. }
  24. public void setUserName(String userName) {
  25. this.userName = userName;
  26. }
  27. public EnumStatus getStatusDef() {
  28. return statusDef;
  29. }
  30. public void setStatusDef(EnumStatus statusDef) {
  31. this.statusDef = statusDef;
  32. }
  33. public EnumStatus getStatusOrdinal() {
  34. return statusOrdinal;
  35. }
  36. public void setStatusOrdinal(EnumStatus statusOrdinal) {
  37. this.statusOrdinal = statusOrdinal;
  38. }
  39. public EnumStatus getStatusCustom() {
  40. return statusCustom;
  41. }
  42. public void setStatusCustom(EnumStatus statusCustom) {
  43. this.statusCustom = statusCustom;
  44. }
  45. @Override
  46. public String toString() {
  47. StringBuffer str = new StringBuffer();
  48. str.append("id:");
  49. str.append(id);
  50. str.append("\n");
  51. str.append("userName:");
  52. str.append(userName);
  53. str.append("\n");
  54. str.append("statusDef:");
  55. str.append(statusDef.name());
  56. str.append("\n");
  57. str.append("statusOrdinal:");
  58. str.append(statusOrdinal.name());
  59. str.append("\n");
  60. str.append("statusCustom:");
  61. str.append(statusCustom.name());
  62. str.append("\n");
  63. return str.toString();
  64. }
  65. }
mybatis自定义枚举转换类
package com.sg.bean;

public class User {

    private String id;

    private String accountID;

    private String userName;

    private EnumStatus statusDef; //枚举属性,使用mybatis默认转换类

    private EnumStatus statusOrdinal; //枚举属性,使用EnumOrdinalTypeHandler转换

    private EnumStatus statusCustom; // 枚举属性,自定义枚举转换类

    public String getId() {
return id;
} public void setId(String id) {
this.id = id;
} public String getAccountID() {
return accountID;
} public void setAccountID(String accountID) {
this.accountID = accountID;
} public String getUserName() {
return userName;
} public void setUserName(String userName) {
this.userName = userName;
} public EnumStatus getStatusDef() {
return statusDef;
} public void setStatusDef(EnumStatus statusDef) {
this.statusDef = statusDef;
} public EnumStatus getStatusOrdinal() {
return statusOrdinal;
} public void setStatusOrdinal(EnumStatus statusOrdinal) {
this.statusOrdinal = statusOrdinal;
} public EnumStatus getStatusCustom() {
return statusCustom;
} public void setStatusCustom(EnumStatus statusCustom) {
this.statusCustom = statusCustom;
} @Override
public String toString() {
StringBuffer str = new StringBuffer();
str.append("id:");
str.append(id);
str.append("\n"); str.append("userName:");
str.append(userName);
str.append("\n"); str.append("statusDef:");
str.append(statusDef.name());
str.append("\n"); str.append("statusOrdinal:");
str.append(statusOrdinal.name());
str.append("\n"); str.append("statusCustom:");
str.append(statusCustom.name());
str.append("\n"); return str.toString();
} }

mybatis配置文件

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper
  3. PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="com.sg.bean.User">
  6. <resultMap type="User" id="userMap">
  7. <id column="id" property="id"/>
  8. <result column="accountID" property="accountID"/>
  9. <result column="userName" property="userName"/>
  10. <result column="statusDef" property="statusDef"/>
  11. <result column="statusOrdinal" property="statusOrdinal" typeHandler="org.apache.ibatis.type.EnumOrdinalTypeHandler"/>
  12. <result column="statusCustom" property="statusCustom" typeHandler="com.sg.util.typehandler.EnumStatusHandler"/>
  13. </resultMap>
  14. <select id="selectUser" resultMap="userMap">
  15. select * from t_user where id = #{id}
  16. </select>
  17. <insert id="insertUser" parameterType="User">
  18. insert into t_user(id,accountID,userName,statusDef,statusOrdinal,statusCustom)
  19. values(
  20. #{id}, #{accountID}, #{userName},
  21. #{statusDef},
  22. #{statusOrdinal, typeHandler=org.apache.ibatis.type.EnumOrdinalTypeHandler},
  23. #{statusCustom, typeHandler=com.sg.util.typehandler.EnumStatusHandler}
  24. )
  25. </insert>
  26. </mapper>
mybatis自定义枚举转换类
<?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.sg.bean.User"> <resultMap type="User" id="userMap">
<id column="id" property="id"/>
<result column="accountID" property="accountID"/>
<result column="userName" property="userName"/>
<result column="statusDef" property="statusDef"/>
<result column="statusOrdinal" property="statusOrdinal" typeHandler="org.apache.ibatis.type.EnumOrdinalTypeHandler"/>
<result column="statusCustom" property="statusCustom" typeHandler="com.sg.util.typehandler.EnumStatusHandler"/>
</resultMap> <select id="selectUser" resultMap="userMap">
select * from t_user where id = #{id}
</select> <insert id="insertUser" parameterType="User">
insert into t_user(id,accountID,userName,statusDef,statusOrdinal,statusCustom)
values(
#{id}, #{accountID}, #{userName},
#{statusDef},
#{statusOrdinal, typeHandler=org.apache.ibatis.type.EnumOrdinalTypeHandler},
#{statusCustom, typeHandler=com.sg.util.typehandler.EnumStatusHandler}
)
</insert>
</mapper>

数据库脚本

  1. CREATE TABLE `t_user` (
  2. `id` varchar(45) NOT NULL,
  3. `accountID` varchar(45) DEFAULT NULL,
  4. `userName` varchar(45) DEFAULT NULL,
  5. `statusDef` varchar(45) DEFAULT NULL,
  6. `statusOrdinal` varchar(45) DEFAULT NULL,
  7. `statusCustom` int(11) DEFAULT NULL,
  8. PRIMARY KEY (`id`)
  9. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户表';
mybatis自定义枚举转换类
CREATE TABLE `t_user` (
`id` varchar(45) NOT NULL,
`accountID` varchar(45) DEFAULT NULL,
`userName` varchar(45) DEFAULT NULL,
`statusDef` varchar(45) DEFAULT NULL,
`statusOrdinal` varchar(45) DEFAULT NULL,
`statusCustom` int(11) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用户表';

上一篇:SqlDataAdapter的方法之一Fill (DataSet dataset, String datatable)解释


下一篇:Flex 全屏显示方法