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。

自定义转换类

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());
}
}

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());

    }

}

枚举类

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;
}
}

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;

    }

}

实体类

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();
}
}

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配置文件

<?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>

<?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>

数据库脚本

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='用户表';

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='用户表';

来自为知笔记(Wiz)

mybatis自定义枚举转换类的更多相关文章

springboot mybatis自定义枚举enum转换
原文链接:https://blog.csdn.net/u014527058/article/details/62883573 一.概述在利用Spring进行Web后台开发时,经常会遇到枚举类型的绑定 ...
Mybatis自定义分布式二级缓存实现与遇到的一些问题解决方案!
先说两句: 我们都知道Mybatis缓存分两类: 一级缓存(同一个Session会话内) & 二级缓存(基于HashMap实现的以 namespace为范围的缓存) 今天呢, 我们不谈一级缓存 ...
解决mybatis使用枚举的转换
解决mybatis使用枚举的转换 >>>>>>>>>>>>>>>>>>>>> ...
MyBatis 查询映射自定义枚举
背景 MyBatis查询若想映射枚举类型,则需要从 EnumTypeHandler 或者 EnumOrdinalTypeHandler 中选一个来使用 ...
学习Spring Boot：（十二）Mybatis 中自定义枚举转换器
前言在 Spring Boot 中使用 Mybatis 中遇到了字段为枚举类型,数据库存储的是枚举的值,发现它不能自动装载. 解决内置枚举转换器 MyBatis内置了两个枚举转换器分别是:org. ...
Mybatis枚举转换
自定义mybatis枚举转换,原理是如果用户没有定义自己的枚举转换工具,mybatis在解析枚举类时会自动获取mybatis的BaseTypeHandler,来转换枚举类,我们只需要重写这个枚举转换器 ...
mybatis类型转换器 - 自定义全局转换enum
在数据模型.接口参数等场景部分属性参数为一些常量值,比如性别:男.女.若是定义成int或String类型,于是类型本身的范围太宽,要求使用者需要了解底层的业务方可知如何传值,那整体来看增加沟通成本,对 ...
QMetaEnum利用Qt元数据实现枚举(enum)类型值及字符串转换
版权声明:若无来源注明,Techie亮博客文章均为原创. 转载请以链接形式标明本文标题和地址: 本文标题:QMetaEnum利用Qt元数据实现枚举(enum)类型值及字符串转换本文地址:ht ...
java 28 - 4 JDK5的新特性之枚举的概述和自定义枚举类
枚举枚举概述是指将变量的值一一列出来,变量的值只限于列举出来的值的范围内.举例:一周只有7天,一年只有12个月等. 回想单例设计模式:单例类是一个类只有一个实例那么多例类就是一个类有多个实例,但 ...

随机推荐

什么是.Net, IL, CLI, BCL, FCL, CTS, CLS, CLR, JIT
什么是.NET? 起源:比尔盖茨在2000年的Professional Developers Conference介绍了一个崭新的平台叫作Next Generation Windows Service ...
使用jQuery实现input数值的增量和减量
在很多电商网站中,在购物车所在页面,涉及到商品数量的时候,都会提供一个+号按钮和-号按钮来实现增1和减1,并且只允许input中输入数值.Bootstrap TouchSpin这款插件就是针对此需求而 ...
使用Nginx过滤网络爬虫
原文:https://www.liaoxuefeng.com/article/001509844125769eafbb65df0a04430a2d010a24a945bfa000 现在的网络爬虫越来越 ...
tomcat内存溢出设置JAVA_OPTS
答案1设置Tomcat启动的初始内存其初始空间(即-Xms)是物理内存的1/64,最大空间(-Xmx)是物理内存的1/4.可以利用JVM提供的-Xmn -Xms -Xmx等选项可进行设置三.实例,以 ...
C#编程（四十九）----------队列
队列 1.Queue定义 System.Collections.Queue类表示对象的先进先出集合,存储在Queue(队列)中的对象在一端插入,从另一端移除. 2.优点 (1).能对集合进行顺序处理( ...
U转串口驱动安装
在装有Win7 32位系统的台式机上先卸载旧驱动,再又一次安装. 对设备管理器里的U转串口设备从本地更新驱动.选择下图文件系统弹出红色提示框(是否安装XXXX驱动),选择安装,随后该设备由无法启动 ...
权力的游戏第一季/全集Game of Thrones迅雷下载
<权力的游戏>是一部中世纪史诗奇幻题材的电视连续剧,该剧以美国作家乔治·R·R·马丁的奇幻巨作<冰与火之歌>七部曲为基础改编创作. 故事背景中虚构的世界,分为两片大陆:位于西面 ...
摩拜单车模式优于OFO双向通信才能被认可
马化腾 :摩拜单车模式优于OFO双向通信才能被认可 2017-06-20 00:12 最近共享单车里最头条的新闻是悟空单车宣布退出竞争,并全部退还投资款和押金以及余额.运营才5个月,成为第一家倒下的 ...
Java多线程之Callable接口与Runnable的实现以及选择
通过实现Runnable接口的实现 package Thread; import java.util.concurrent.ExecutorService;import java.util.concu ...
Python json模块dumps loads
python中json数据的使用. dumps和loads也是需要成对使用的,就像c++ new/delete malloc/free一样需要成对使用. 看着像json的字符串,也不一定是json字符 ...