Mybatis自定义TypeHandler解决特殊类型转换问题详解

我们知道,Java和MySQL中的数据类型是不同的,Java中除了基本数据类型,还有对象。

有时候使用MySQL存储数据,或者从MySQL中读取数据时,会有一些特殊需求 weary ,比如:

  1. 将Integer数组直接存入MySQL,保存为BLOB形式,读取出来时又是正常的Integer数组
  2. 将Integer数组转换为String,然后存入MySQL,使用varchar类型,读取出来时又是正常的Integer数组

这也太难了叭!

解决办法有两种:

  1. Basic Method:Java在存入数据之前,或读取数据之后,做手动类型转换
  2. Clever Method:定义TypeHandler,并在Mybatis对应位置指明

关于第一种方法这里不予赘述,不够Smart。这里主要讲述如何自定义Handler,来解决Java数据->MySQL数据的特殊类型转换问题grinning

这种Handler不仅方便了我们的数据库操作,还有利于代码的复用。

这里以Integer[]数组的存储为形如,1,2,3,的varchar字符串为例。

问题示例

我们定义一个role类,与数据库的role表对应:

public class Role {
  private Integer id;
  private String name;
  private Integer[] accessIds;
  private Date createTime;
  // ... ignore get and set methods
}

注意到里面有一个accessIds字段,它的类型是Integer[]

数据库设计:

DROP TABLE IF EXISTS `role`;
CREATE TABLE `role` (
 `id` int(11) NOT NULL AUTO_INCREMENT,
 `name` varchar(255) NOT NULL,
 `access_ids` varchar(255) DEFAULT NULL,
 `create_time` datetime NOT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of role
-- ----------------------------
INSERT INTO `role` VALUES ('1', '测试角色', ',1,2,', '2019-11-14 13:43:14');

自定义Handler类

通过继承BaseTypeHandler类,重写其方法,定义一个Integer[]与数据库varchar类型自动转换的Handler类:

/**
 * Java Int数组与MySQL String转换器
 * 比如[1,2,3] --> ",1,2,3,"
 */
public class StringToIntArrayHandler extends BaseTypeHandler<Integer[]> {

  private static final String splitCharset = ",";

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, Integer[] objects, JdbcType jdbcType) throws SQLException {
    String str = arrayToString(objects);
    ps.setString(i, str);
  }

  @Override
  public Integer[] getNullableResult(ResultSet rs, String columnName) throws SQLException {
    String str = rs.getString(columnName);
    return stringToArray(str);
  }

  @Override
  public Integer[] getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    String str = rs.getString(columnIndex);
    return stringToArray(str);
  }

  @Override
  public Integer[] getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    String str = cs.getString(columnIndex);
    return stringToArray(str);
  }

  // --- private methods ---

  /**
   * Integer数组转String
   * 注:使用提前设定好的分隔符分割数组的每一项
   */
  private static String arrayToString(Integer[] array) {
    StringBuilder res = new StringBuilder();
    if (array != null && array.length > 0) {
      for (Object o : array) {
        res.append(splitCharset).append(o.toString());
      }
      res.append(splitCharset);
    }
    return res.length() > 0 ? res.toString() : null;
  }

    /**
   * 从String转Integer数组
   * 注:String是用分隔符分割的,使用String.split方法可以分解为数组
   */
  private static Integer[] stringToArray(String str) {
    List<Integer> list = new ArrayList<>();
    if (str != null) {
      String[] array = str.split(splitCharset);
      if (array.length > 0) {
        for (String o : array) {
          if (o != null && o.length() > 0) {
            list.add(Integer.parseInt(o));
          }
        }
      }
    }
    return list.toArray(new Integer[0]);
  }
}

这个类的具体作用是什么呢?

  1. 当Java中类型是Integer[]时,使用这个Handler类,将Integer[]转换为以,号分割的字符串,然后存入数据库
  2. 当从数据库读取以,分割值的字符串时,可以通过这个Handler,自动将字符串转换为Integer[]数组

下面我们演示一下具体的使用smile

在Mybatis中应用自定义的Handler

Mybatis存放SQL语句的XML文件​​:

<?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.example.model.dao.RoleDAO">

  <resultMap id="roleMap" type="com.example.model.bean.Role">
    <id property="id" column="id"/>
    <result property="name" column="name"/>
    <result property="accessIds" column="access_ids"
        typeHandler="ccom.example.model.dao.handler.StringToIntArrayHandler"/>
    <result property="createTime" column="create_time"/>
  </resultMap>

  <select id="findById" parameterType="map" resultMap="roleMap">
    SELECT id, name, access_ids, create_time
    FROM role
    WHERE id = #{id}
  </select>

  <insert id="insert" parameterType="com.example.model.bean.Role">
    <selectKey resultType="java.lang.Integer" order="AFTER" keyProperty="id">
      SELECT LAST_INSERT_ID()
    </selectKey>

    INSERT INTO role
    (name, create_time, access_ids)
    VALUES
    (#{name}, #{createTime}
    , #{accessIds, jdbcType=VARCHAR, typeHandler=com.example.model.dao.handler.StringToIntArrayHandler})
  </insert>

</mapper>

以上XML中演示了select和insert两种情况时,如何应用typeHandler。

(0)

相关推荐

  • Mybatis实现自定义类型转换器TypeHandler的方法

    先给大家简单介绍下mybatis MyBatis是一个支持普通SQL查询,存储过程和高级映射的优秀持久层框架.MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装.MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录. 此文其实是java操作Oracle类型XMLType总结二:使用Mybatis附带的一篇小结. Mybatis实现自定义的转换器,

  • MyBatis自定义typeHandler的完整实例

    自定义typeHandler 对于自定义typeHandler来说,需要在配置文件中注册typeHandlers 然后需要实现TypeHandler接口, 一个例子 首先编写调度的处理类 package com.ming.MyBatis; import org.apache.ibatis.type.JdbcType; import org.apache.ibatis.type.TypeHandler; import org.apache.logging.log4j.LogManager; imp

  • Mybatis实现自定义的typehandler三步曲

    第一步实现接口TypeHandler<T> @MappedJdbcTypes(JdbcType.TIMESTAMP)//此处如果不使用该注解,在myabtis-config.xml中注册该typehandler的时候需要写明jdbctype="TIMESTAMP" @MappedTypes(DateTime.class)//此处如果不使用该注解,在myabtis-config.xml中注册该typehandler的时候需要写明javatype="com.sinos

  • Mybatis中自定义TypeHandler处理枚举详解

    在Mybatis中,处理枚举类的TypeHandler有两个: EnumTypeHandler: 用于保存枚举名 EnumOrdinalTypeHandler: 用于保存枚举的序号. 在实际项目中,以上往往不能满足我们的需求. 需求分析 枚举需要包含两个属性,label(用于显示), value(实际的枚举值).数据库保存枚举值(value). 这很明显Mybatis提供的两个枚举TypeHandler不能满足我们的需求.此时,我们可以自定义一个通用的枚举TypeHandler来满足我们的需求.

  • MyBatis使用自定义TypeHandler转换类型的实现方法

    MyBatis虽然有很好的SQL执行性能,但毕竟不是完整的ORM框架,不同的数据库之间SQL执行还是有差异. 笔者最近在升级 Oracle 驱动至 ojdbc 7 ,就发现了处理DATE类型存在问题.还好MyBatis提供了使用自定义TypeHandler转换类型的功能. 本文介绍如下使用 TypeHandler 实现日期类型的转换. 问题背景 项目中有如下的字段,是采用的DATE类型: birthday = #{birthday, jdbcType=DATE}, 在更新 Oracle 驱动之前

  • Mybatis实战之TypeHandler高级进阶

    上篇文章分享了在项目实战中自定义Mybatis的TypeHandler来处理枚举类型.文章结尾也指出了美中不足之处,那就是每次都需要指定我们自定义的枚举TypeHandler. 随着项目枚举类型的增多,每次都要写一遍这个会令人很反感.那么,本次我们就来解决这一痛点. 思路分析 上篇文章讲到, mybatis有默认的处理枚举类型的TypeHandler,因此,我们要将我们自定义的枚举TypeHandler注册进入Mybatis. 注册完我们自定义的TypeHandler后,还得告诉Mybatis只

  • Mybatis自定义TypeHandler解决特殊类型转换问题详解

    我们知道,Java和MySQL中的数据类型是不同的,Java中除了基本数据类型,还有对象. 有时候使用MySQL存储数据,或者从MySQL中读取数据时,会有一些特殊需求 weary ,比如: 将Integer数组直接存入MySQL,保存为BLOB形式,读取出来时又是正常的Integer数组 将Integer数组转换为String,然后存入MySQL,使用varchar类型,读取出来时又是正常的Integer数组 这也太难了叭! 解决办法有两种: Basic Method:Java在存入数据之前,

  • MyBatis 动态SQL和缓存机制实例详解

    有的时候需要根据要查询的参数动态的拼接SQL语句 常用标签: - if:字符判断 - choose[when...otherwise]:分支选择 - trim[where,set]:字符串截取,其中where标签封装查询条件,set标签封装修改条件 - foreach: if案例 1)在EmployeeMapper接口文件添加一个方法 public Student getStudent(Student student); 2)如果要写下列的SQL语句,只要是不为空,就作为查询条件,如下所示,这样

  • MyBatis注解方式之@Update/@Delete使用详解

    @Update 1. RoleMapper接口增加接口方法 /** * * * @Title: updateSysRoleById * * @Description: updateSysRoleById * * @param sysRole * @return * * @return: int */ @Update({ "update sys_role set role_name = #{roleName},enabled = #{enabled},create_by = #{createBy}

  • 直观详细的typescript隐式类型转换图文详解

    正文 1.unknown是所有类型的父类型,其他类型都可以赋值给 unknown let a: undefined = undefined; let b: null = null; let x2: unknown; x2 = a; //正确 x2 = b; //正确 2.never 是任何类型的子类型,可以赋给任何类型 let a: undefined = undefined; let b: null = null; function err(): never { // OK throw new

  • Mybatis 创建方法、全局配置教程详解

    总体介绍:MyBatis实际上是Ibatis3.0版本以后的持久化层框架[也就是和数据库打交道的框架]! 和数据库打交道的技术有: 原生的JDBC技术--->Spring的JdbcTemplate技术 这些工具都是提供简单的SQL语句的执行,但是和我们这里学的MyBatis框架还有些不同, 框架是一整套的东西,例如事务控制,查询缓存,字段映射等等. 我们用原生JDBC操作数据库的时候都会经过: 编写sql---->预编译---->设置参数----->执行sql------->

  • springboot扫描自定义的servlet和filter代码详解

    这几天使用spring boot编写公司一个应用,在编写了一个filter,用于指定编码的filter,如下: /** * Created by xiaxuan on 16/11/1. */ @WebFilter(urlPatterns = "/*",filterName="CharacterEncodeFilter", initParams={ @WebInitParam(name="encoding",value="UTF-8&qu

  • MyBatis输入映射和输出映射实例详解

    什么是 MyBatis ? MyBatis 是支持定制化 SQL.存储过程以及高级映射的优秀的持久层框架.MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集.MyBatis 可以对配置和原生Map使用简单的 XML 或注解,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录. 我们知道,mapper.xml是我们配置操作数据库的sql语句的地方.其中每个sql语句对应着一个方法,每个方法都有自己的

  • 使用Mybatis的PageHelper分页工具的教程详解

    1.导入相关的jar包 在pom.xm中加入 <!-- https://mvnrepository.com/artifact/com.github.pagehelper/pagehelper --> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>5.1.10</ver

  • IDEA的Mybatis Log Plugin插件配置和使用详解

    在使用Mybatis开发项目时,由于避免出现SQL注入,大部分情况下都是使用#{}占位符的方式传参. 所以日志打印SQL时,打印的也是占位符,如: 如果SQL比较复杂,参数又很多的话,要通过日志拼凑真正可执行的SQL还是件比较头痛的事情. 好在IDEA有款很不错的插件(Mybatis Log Plugin)可以解决上述问题. 插件安装 像其它插件一样,可选择在线安装和离线安装. 在线安装:搜索Mybatis Log Plugin,直接install即可.离线安装:可从:http://plugin

  • MyBatis框架零基础快速入门案例详解

    目录 一.创建数据库和表 二.创建maven工程 三.代码编写 1.编写Student实体类 2.编写DAO接口StudentDao 3.编写DAO接口Mapper映射文件StudentDao.xml. 4.创建MyBatis主配置文件 四.创建测试类进行测试 1.创建测试类MyBatisTest 2.配置日志功能 五.增删改操作 insert操作 MyBatis下载地址:https://github.com/mybatis/mybatis-3/releases 一.创建数据库和表 数据库名ss

随机推荐