Mybatis之类型转换器TypeHandler的初步了解及具体使用方法

一、TypeHandler简介
1、什么是TypeHandler？
简介：TypeHandler（类型转换器）在mybatis中用于实现 java类型 和 JDBC类型 的相互转换。mybatis使用 prepareStatement 来进行参数设置的时候，需要通过 TypeHandler 将传入的java参数设置成合适的jdbc类型参数，这个过程实际上是通过调用 PrepareStatement 不同的set方法实现的；在获取结果返回之后，也需要将返回的结果转换成我们需要的java类型，这时候是通过调用 ResultSet 对象不同类型的get方法实现的；所以不同类型的 TypeHandler 其实就是调用 PrepareStatement 和 ResultSet 的不同方法来进行类型的转换，有些时候会在调用 PrepareStatement 和 ResultSet 的相关方法之前，可以对传入的参数进行一定的处理.。当我们没有指定 TypeHandler 的时候 mybatis 会根据传入参数的类型和返回值的类型调用默认的 TypeHandler 进行处理。对于一个 TypeHandler 需要配置 java类型(javaType) 和 JDBC类型(jdbcType)，TypeHandler 的作用就是实现这两种类型的转换，在传入的参数为指定的Java类型时，将其转换为指定的JDBC类型，当返回值为指定JDBC类型时将其转换为配置的Java类型。
作用： 实现 javaType 与 jdbcType 之间的转换

2、mybatis默认定义的TypeHandler
MyBatis 系统已经创建好常用的 TypeHandler。在大部分的情况下无须显式地声明 jdbcType 和 javaType，或者用 TypeHandler 去指定对应的字段来实现数据类型转换，因为 MyBatis 系统会自己探测映射的数据类型，来自动选择合适的 TypeHandler。
MyBatis 自带的常见 TypeHandler有如下类型：

3、自定义 TypeHandler
虽然 Mybatis 提供的 TypeHandler（类型转换器）很多，可以完成很多中数据类型的转换，但有的时候仍然不能满足我们对于某一字段的转换要求，这时就需要自定义类型处理器。

二、如何自定义类型转换器
表结构：

create table ARTICLE
(
    ID          NUMBER(10) not null constraint ARTICLE_PK primary key,
    NAME        VARCHAR2(100) not null,
    ART_DESC    VARCHAR2(100),
    AUTHOR      VARCHAR2(100) not null,
    CREATE_TIME NUMBER(10)    not null,
    CONTENT     BLOB          not null,
    TYPE        NUMBER,
    EX_FIELD_01 VARCHAR2(100),
    EX_FIELD_02 VARCHAR2(100),
    EX_FIELD_03 VARCHAR2(100)
);

案例：上面这张表中的 content 字段为 BLOB 类型，如果查询中涉及到这个字段，该怎么处理？
1、pom依赖

<dependency>
	<groupId>org.mybatis.spring.boot</groupId>
	<artifactId>mybatis-spring-boot-starter</artifactId>
</dependency>

2、定义类型转换处理类

package com.test.common.typeHandler;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;

import java.sql.*;

/**
 * sql 查询数据的时候将 BLOB 字段转换成 String 类型接收
 */
public class BlobToStringTypeHandler extends BaseTypeHandler<String> {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
    ps.setString(i, parameter);
  }

  @Override
  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
    Blob blob = rs.getBlob(columnName);
    return new String(blob.getBytes(1, (int)blob.length()));
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    Blob blob = rs.getBlob(columnIndex);
    return new String(blob.getBytes(1, (int)blob.length()));
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    Blob blob = cs.getBlob(columnIndex);
    return new String(blob.getBytes(1, (int)blob.length()));
  }

}

3、在 mapper.xml 文件中使用：在 result 标签中使用 typeHandler=“com.test.common.typeHandler.BlobToStringTypeHandler” 指定具体的自定义类型转换器

<?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.test.rabbitmq_producer.mapper.ArticleMapper">

    <resultMap type="com.test.rabbitmq_producer.entity.Article" id="ArticleMap">
        <result property="id" column="ID" jdbcType="INTEGER"/>
        <result property="name" column="NAME" jdbcType="VARCHAR"/>
        <result property="artDesc" column="ART_DESC" jdbcType="VARCHAR"/>
        <result property="author" column="AUTHOR" jdbcType="VARCHAR"/>
        <result property="createTime" column="CREATE_TIME" jdbcType="INTEGER"/>
        <result property="content" column="CONTENT" jdbcType="BLOB" typeHandler="com.test.common.typeHandler.BlobToStringTypeHandler"/>
        <result property="type" column="TYPE" jdbcType="INTEGER"/>
        <result property="exField01" column="EX_FIELD_01" jdbcType="VARCHAR" typeHandler="B"/>
        <result property="exField02" column="EX_FIELD_02" jdbcType="VARCHAR"/>
        <result property="exField03" column="EX_FIELD_03" jdbcType="VARCHAR"/>
    </resultMap>

    <!--查询指定行数据-->
    <select id="queryAllByLimit" parameterType="com.test.rabbitmq_producer.entity.Article" resultMap="ArticleMap">
        select
            ID, NAME, ART_DESC, AUTHOR, CREATE_TIME, CONTENT, TYPE, EX_FIELD_01, EX_FIELD_02, EX_FIELD_03
        from ARTICLE
        <if test="article != null">
            <where>
                <if test="id != null">
                    and ID = #{id}
                </if>
                <if test="name != null and name != ''">
                    and NAME = #{name}
                </if>
                <if test="artDesc != null and artDesc != ''">
                    and ART_DESC = #{artDesc}
                </if>
                <if test="author != null and author != ''">
                    and AUTHOR = #{author}
                </if>
                <if test="createTime != null">
                    and CREATE_TIME = #{createTime}
                </if>
                <if test="content != null and content != ''">
                    and CONTENT = #{content}
                </if>
                <if test="type != null">
                    and TYPE = #{type}
                </if>
                <if test="exField01 != null and exField01 != ''">
                    and EX_FIELD_01 = #{exField01}
                </if>
                <if test="exField02 != null and exField02 != ''">
                    and EX_FIELD_02 = #{exField02}
                </if>
                <if test="exField03 != null and exField03 != ''">
                    and EX_FIELD_03 = #{exField03}
                </if>
            </where>
        </if>
    </select>
    
</mapper>

备注：数据库表字段为 BLOB 类型的时候，mapper.xml 文件中的 jdbcType 对应应该也是 BLOB 类型，java 实体类中应该用 byte[] 接收，但是一般我们希望在实体类中用 String 来接收，所以正常情况下我们查询结果中的某个字段是 BLOB 类型的话，实体类只能用 byte[] 来接收，然后遍历所有查询结果，手动将 byte[] 转换成 String，这样的话效率会比较低。而如果使用自定义的类型转换器，就可以在查询完后自动进行转换，实体类中可以直接用 String 来接收，不用遍历手动进行类型转换。