文档章节

mybatis自定义枚举转换类

STG0825
 STG0825
发布于 2013/12/30 16:29
字数 1038
阅读 12663
收藏 27
点赞 1
评论 2

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

}


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>


数据库脚本
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='用户表';


© 著作权归作者所有

共有 人打赏支持
STG0825
粉丝 5
博文 23
码字总数 24987
作品 0
朝阳
高级程序员
加载中

评论(2)

甜甜田田
那在跟前端的交互呢
C
Chrisdon
Great !
《深入理解mybatis原理》 以及 mybatis自定义枚举转换类

深入理解mybatis原理: 专栏:深入理解MyBatis原理 - 博客频道 - CSDN.NET -------------------------------------------------------------------------------- 摘要: mybatis自定义枚举转换......

weiliu007 ⋅ 2016/11/25 ⋅ 0

EasyMybatis 1.2.0 发布,支持枚举类型字段

EasyMybatis 1.2.0 已发布,此次更新的内容有: 启用驼峰下划线转换。javaBean中的字段是驼峰形式,映射到数据库字段会转换成下划线形式。 doc 支持枚举类型字段。javaBean中可以定义枚举类型...

tanghc ⋅ 2017/09/12 ⋅ 3

12.平凡之路-自定义数据类型转换

胖先森 MyBatis数据类型转换,默认情况下MyBatis已经帮我们完成了很多的数据类型的转换,一般情况下我们直接使用即可,下面大概介绍一下 一 Java日期类型和Jdbc字符串类型转换 在做开发时,我们...

胖先森 ⋅ 2017/09/05 ⋅ 0

Java面试----2018年MyBatis常见实用面试题整理

Java面试----2018年MyBatis常见实用面试题整理 1、什么是MyBatis? 答:MyBatis是一个可以自定义SQL、存储过程和高级映射的持久层框架。 2、讲下MyBatis的缓存 答:MyBatis的缓存分为一级缓存...

优惠券活动 ⋅ 04/29 ⋅ 0

mybatis(五)TypeHandler简介及配置(mybatis源码篇)

上篇文章为大家介绍了mybatis中别名的使用,以及其源码。本篇将为大家介绍TypeHandler, 并简单分析其源码。 Mybatis中的TypeHandler是什么?   无论是 MyBatis 在预处理语句(PreparedSta...

LCZ777 ⋅ 2014/12/19 ⋅ 0

mybatis 自定义枚举转换类

最近在搭建maven多模块项目: http://git.oschina.net/alexgaoyh/MutiModule-parent 项目整体代码部分在上文链接的git中,下面的代码段落只是部分个人觉得比较重要的段落 在选择持久化DAO部分...

alexgaoyh ⋅ 2015/04/15 ⋅ 0

mybaties源码解析(org.apache.ibatis.type)类型处理器

此模块主要是实现MyBaties数据类型和jdbc中的数据类型的转换 一、TypeHandler接口作为参数转换的基础接口: 1、设定参数函数: void setParameter(PreparedStatement ps, int i, T parameter...

lackiechan ⋅ 2016/12/12 ⋅ 0

MyBatis:自定义类型转换器(typeHandlers)

MyBatis定义了一些默认处理器,可以用来设置参数或取结果集时实现自动转换,有些类型MyBatis是不支持的,例如Java 8中的日期类型,本文将介绍如何定义自定义类型处理器,来满足最新的日期类型...

kolbe ⋅ 2015/09/18 ⋅ 0

通用数据库访问层--dexcoder-dal

核心组件dexcoder-dal使用说明 如果你不喜欢用Hibernate、Mybaits这类ORM框架,喜欢JdbcTemplate或DbUtils,那么可以试试这个封装的通用dal,这可能是目前封装的最方便易用的通用dal层了。 ...

首席的哥队长 ⋅ 2015/12/24 ⋅ 6

利用st_geometry进行图形叠加分析--结合mybatis

在上一遍利用stgeometry进行图形叠加分析文章的基础上,结合mybatis操作stgeometry,主要简单实现一下三个功能:利用st_geometry两个表之间图形表的叠加分析、WKT与图形表的叠加分析、将WKT...

翻 ⋅ 2016/11/21 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

从 Confluence 5.3 及其早期版本中恢复空间

如果你需要从 Confluence 5.3 及其早期版本中的导出文件恢复到晚于 Confluence 5.3 的 Confluence 中的话。你可以使用临时的 Confluence 空间安装,然后将这个 Confluence 安装实例升级到你现...

honeymose ⋅ 今天 ⋅ 0

用ZBLOG2.3博客写读书笔记网站能创造今日头条的辉煌吗?

最近两年,著名的自媒体网站今日头条可以说是火得一塌糊涂,虽然从目前来看也遇到了一点瓶颈,毕竟发展到了一定的规模,继续增长就更加难了,但如今的今日头条规模和流量已经非常大了。 我们...

原创小博客 ⋅ 今天 ⋅ 0

MyBatis四大核心概念

本文讲解 MyBatis 四大核心概念(SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession、Mapper)。 MyBatis 作为互联网数据库映射工具界的“上古神器”,训有四大“神兽”,谓之:Sql...

waylau ⋅ 今天 ⋅ 0

以太坊java开发包web3j简介

web3j(org.web3j)是Java版本的以太坊JSON RPC接口协议封装实现,如果需要将你的Java应用或安卓应用接入以太坊,或者希望用java开发一个钱包应用,那么用web3j就对了。 web3j的功能相当完整...

汇智网教程 ⋅ 今天 ⋅ 0

2个线程交替打印100以内的数字

重点提示: 线程的本质上只是一个壳子,真正的逻辑其实在“竞态条件”中。 举个例子,比如本题中的打印,那么在竞态条件中,我只需要一个方法即可; 假如我的需求是2个线程,一个+1,一个-1,...

Germmy ⋅ 今天 ⋅ 0

Springboot2 之 Spring Data Redis 实现消息队列——发布/订阅模式

一般来说,消息队列有两种场景,一种是发布者订阅者模式,一种是生产者消费者模式,这里利用redis消息“发布/订阅”来简单实现订阅者模式。 实现之前先过过 redis 发布订阅的一些基础概念和操...

Simonton ⋅ 今天 ⋅ 0

error:Could not find gradle

一.更新Android Studio后打开Project,报如下错误: Error: Could not find com.android.tools.build:gradle:2.2.1. Searched in the following locations: file:/D:/software/android/andro......

Yao--靠自己 ⋅ 昨天 ⋅ 0

Spring boot 项目打包及引入本地jar包

Spring Boot 项目打包以及引入本地Jar包 [TOC] 上篇文章提到 Maven 项目添加本地jar包的三种方式 ,本篇文章记录下在实际项目中的应用。 spring boot 打包方式 我们知道,传统应用可以将程序...

Os_yxguang ⋅ 昨天 ⋅ 0

常见数据结构(二)-树(二叉树,红黑树,B树)

本文介绍数据结构中几种常见的树:二分查找树,2-3树,红黑树,B树 写在前面 本文所有图片均截图自coursera上普林斯顿的课程《Algorithms, Part I》中的Slides 相关命题的证明可参考《算法(第...

浮躁的码农 ⋅ 昨天 ⋅ 0

android -------- 混淆打包报错 (warning - InnerClass ...)

最近做Android混淆打包遇到一些问题,Android Sdutio 3.1 版本打包的 错误如下: Android studio warning - InnerClass annotations are missing corresponding EnclosingMember annotation......

切切歆语 ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部