MyBatis配置的typeHandler类型转换器

清疚 2021-12-09 20:31 274阅读 0赞

# 初始typeHandler #

在[JDBC][]中，需要在PreparedStatement对象中设置那些已经预编译过的SQL语句 参数。 执行SQL后，会通过ResultSet对象获取得到数据库的数据，而这些MyBatis是根据数据的类型通过typeHandler来实现的。

在typeHandler中，分为jdbcType和javaType，其中jdbcType用于定义数据库类型，javaType用于定义Java类型，那么typeHandler的作用就是承担jdbcType和javaType之间的相互转换。

在MyBatis中存在系统定义的typeHandler和自定义的typeHandler。MyBatis会根据javaType和数据库的jdbcType决定采用哪个typeHandler处于这些转换规则。

系统提供的typeHandler能覆盖大部分场景的要求，但是有些情况下是不够的，比如我们有特殊的转换规则，枚举类就是这样。

# 系统定义的typeHandler #

MyBatis内部定义了许多有用的typeHandler，这里列举一些

<table> 
 <thead> 
  <tr> 
   <th>类型处理器</th> 
   <th>Java类型</th> 
   <th>JDBC类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>IntegerTypeHandler</td> 
   <td>java.lang.Integer,int</td> 
   <td>数据库兼容的NUMERIC或SHORT INTEGER</td> 
  </tr> 
  <tr> 
   <td>StringTypeHandler</td> 
   <td>java.lang.String</td> 
   <td>CHAR、VARCHAR</td> 
  </tr> 
 </tbody> 
</table>

在MyBatis中typeHandler都要实现接口org.apache.ibatis.type.TypeHandler。

// T是泛型，专指javaType
    public interface TypeHandler<T> {
        // 通过PreparedStatement 对象进行设置SQL参数 
        // i是参数在SQL的下标
        // parameter是参数
        // jdbcType是数据库类型
        void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;
    
        // 从JDBC结果集中获取数据进行转换，要么使用列名(columnName)要么使用下标(columnIndex)获取数据库的数据
        T getResult(ResultSet var1, String var2) throws SQLException;
    
        T getResult(ResultSet var1, int var2) throws SQLException;
        // 存储过程专用的
        T getResult(CallableStatement var1, int var2) throws SQLException;
    }

我们这里以`StringTypeHandler`为例，研究一下MyBatis系统的typeHandler是如何实现的。  
查看StringTypeHandler的源码，可以发现它继承了`BaseTypeHandler`

// BaseTypeHandler本身是一个抽象类，需要子类去实现其定义的4个抽象方法，而它本身实现了typeHandler接口的4个方法
    public abstract class BaseTypeHandler<T> extends TypeReference<T> implements TypeHandler<T> {
        
        public void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
            // 当parameter和jdbcType同时为空，MyBatis将抛出异常
            if (parameter == null) {
                if (jdbcType == null) {
                    throw new TypeException("JDBC requires that the JdbcType must be specified for all nullable parameters.");
                }
    
                try {
                    ps.setNull(i, jdbcType.TYPE_CODE);
                } catch (SQLException var7) {
                    throw new TypeException("Error setting null for parameter #" + i + " with JdbcType " + jdbcType + " . " + "Try setting a different JdbcType for this parameter or a different jdbcTypeForNull configuration property. " + "Cause: " + var7, var7);
                }
            } else {            
                try {
                    // 设置参数
                    this.setNonNullParameter(ps, i, parameter, jdbcType);
                } catch (Exception var6) {
                    throw new TypeException("Error setting non null for parameter #" + i + " with JdbcType " + jdbcType + " . " + "Try setting a different JdbcType for this parameter or a different configuration property. " + "Cause: " + var6, var6);
                }
            }
    
        }
    
        public T getResult(ResultSet rs, String columnName) throws SQLException {
            Object result;
            try {
                // 返回非空结果集
                result = this.getNullableResult(rs, columnName);
            } catch (Exception var5) {
                throw new ResultMapException("Error attempting to get column '" + columnName + "' from result set.  Cause: " + var5, var5);
            }
    
            return rs.wasNull() ? null : result;
        }
    
        public T getResult(ResultSet rs, int columnIndex) throws SQLException {
            Object result;
            try {
                result = this.getNullableResult(rs, columnIndex);
            } catch (Exception var5) {
                throw new ResultMapException("Error attempting to get column #" + columnIndex + " from result set.  Cause: " + var5, var5);
            }
    
            return rs.wasNull() ? null : result;
        }
    
        public T getResult(CallableStatement cs, int columnIndex) throws SQLException {
            Object result;
            try {
                result = this.getNullableResult(cs, columnIndex);
            } catch (Exception var5) {
                throw new ResultMapException("Error attempting to get column #" + columnIndex + " from callable statement.  Cause: " + var5, var5);
            }
    
            return cs.wasNull() ? null : result;
        }
    
        public abstract void setNonNullParameter(PreparedStatement var1, int var2, T var3, JdbcType var4) throws SQLException;
    
        public abstract T getNullableResult(ResultSet var1, String var2) throws SQLException;
    
        public abstract T getNullableResult(ResultSet var1, int var2) throws SQLException;
    
        public abstract T getNullableResult(CallableStatement var1, int var2) throws SQLException;
    }

接下来再看

public class StringTypeHandler extends BaseTypeHandler<String> {
        
        public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
            ps.setString(i, parameter);
        }
    
        public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
            return rs.getString(columnName);
        }
    
        public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
            return rs.getString(columnIndex);
        }
    
        public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
            return cs.getString(columnIndex);
        }
    }

在这里MyBatis就把javaType和jdbcType进行了相互转换。

那么它们是如何注册的？  
是通过`org.apache.ibatis.type.TypeHandlerRegistry`类对象的`register`方法进行注册

public TypeHandlerRegistry() {
        this.register((Class)Boolean.class, (TypeHandler)(new BooleanTypeHandler()));
        this.register((Class)Boolean.TYPE, (TypeHandler)(new BooleanTypeHandler()));
        ...
    }

这样就实现了自带的typeHanlder注册。  
自定义的typeHandler一般不会使用代码注册，而是通过配置或扫描

# 自定义typeHandler #

这里我们仿造一个StringTypeHandler

/**
     * 自定义的typeHandler 实现StringTypeHandler的功能
     * @author Why
     *
     */
    public class MyTypeHandler implements TypeHandler<String>{
        
        Logger logger = Logger.getLogger(MyTypeHandler.class);
    
        @Override
        public String getResult(ResultSet rs, String columnName) throws SQLException {
            String result = rs.getString(columnName);
            logger.info("读取string参数1【" + result +"】");
            return result;
        }
    
        @Override
        public String getResult(ResultSet rs, int columnIndex) throws SQLException {
            String result = rs.getString(columnIndex);
            logger.info("读取string参数2【" + result +"】");
            return result;
        }
    
        @Override
        public String getResult(CallableStatement cs, int columnIndex) throws SQLException {
            String result = cs.getString(columnIndex);
            logger.info("读取string参数3【" + result +"】");
            return result;
        }
    
        @Override
        public void setParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
            logger.info("设置string参数【" + parameter + "】");
            ps.setString(i, parameter);
        }
    }

在完成了typeHandler的自定义之后，我们还需要配置扫描

<typeHandlers>
        <typeHandler handler="com.whyalwaysmea.typeHandler.MyTypeHandler" jdbcType="VARCHAR" javaType="string"/>
    </typeHandlers>

最后就是自定义typeHandler的使用了

<mapper namespace="com.whyalwaysmea.mapper.RoleMapperWithTypeHandler">  
    
        <resultMap type="role" id="roleMapper">
            <result property="id" column="id"/>
            <result property="roleName" column="role_name" jdbcType="VARCHAR" javaType="string"/>
            <result property="note" column="note" typeHandler="com.whyalwaysmea.typeHandler.MyTypeHandler"/>
        </resultMap>
        
        <select id="findRoles1" parameterType="string" resultType="role">
            select id, role_name, note from t_role where role_name like concat('%', #{roleName, jdbcType=VARCHAR, javaType=string}, '%')
        </select>
        
        <select id="findRoles2" parameterType="string" resultType="role">
            select id, role_name, note from t_role where role_name like concat('%', #{roleName, typeHandler=com.whyalwaysmea.typeHandler.MyTypeHandler}, '%')
        </select>
    </mapper>

这里展示两种使用自定义typeHandler的方式：

1.  指定了与自定义typeHandler一致的jdbcType和javaType
2.  直接使用typeHandler指定具体的实现类

有时候配置的typeHandler太多，也可以使用包扫描的方式

<typeHandlers>      
        <package name="com.whyalwaysmea.typeHandler"/>
    </typeHandlers>

这样还需要处理一下自定义的typeHandler类，指定jdbcType和javaType

@MappedJdbcTypes(JdbcType.VARCHAR)
    @MappedTypes(String.class)
    public class MyTypeHandler implements TypeHandler<String>{
        ...
    }

[JDBC]: https://link.jianshu.com?t=http%3A%2F%2Fblog.csdn.net%2Fu013435893%2Farticle%2Fdetails%2F78972310%23t6

发表评论取消回复

表情：

评论列表（有 0 条评论，274人围观）

还没有评论，来说两句吧...

相关阅读

相关一起学习Mybatis----配置类型处理器typeHandlers

MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。

蔚落/ 2024年02月19日 14:17/ 0 赞/ 46 阅读

相关 mybatis自定义类型转换器

有这样一个需求：有一个布尔型的字段需要保存到数据库中，但是数据库不支持布尔类型，因此采用一位字符（char（1））来存储这个布尔值，javabean中仍然采用bool

我不是女神ヾ/ 2022年09月30日 14:58/ 0 赞/ 307 阅读

相关 Mybatis类型转换TypeHandler介绍

1.1 目录 [1.2 建立TypeHandler][1.2_TypeHandler] [1.2.1 TypeHandler接口][1.2.1_T

阳光穿透心脏的1/2处/ 2022年09月29日 01:49/ 0 赞/ 1 阅读

相关 MyBatis TypeHandler配置

MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，或从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。M

曾经终败给现在/ 2022年06月18日 02:11/ 0 赞/ 227 阅读

相关 MyBatis 配置 typeHandlers 详解

0x00：前言参考之前的[《MyBatis 中 SqlMapConfig 配置文件详解》][MyBatis _ SqlMapConfig]记了一下 MyBatis 中的

雨点打透心脏的1/2处/ 2022年05月22日 11:56/ 0 赞/ 360 阅读

相关 mybatis typeHandler分割转换数据类型

例子 <resultMap id="BlogMap" type="com.aya.mapper.Blog" > <id column="

朴灿烈づ我的快乐病毒、/ 2022年05月19日 01:19/ 0 赞/ 215 阅读

相关 MyBatis 类型转换器

MyBatis 类型转换器每当MyBatis设置参数到PrepareStatement或者从ResultSet结果集中取值时，就会用到TypeHandler来处理数据库

秒速五厘米/ 2022年03月18日 03:11/ 0 赞/ 375 阅读

相关 MyBatis自定义类型处理器 TypeHandler

在项目开发中经常会遇到一个问题：当我们在javabean中自定义了枚举类型或者其它某个类型，但是在数据库中存储时往往需要转换成数据库对应的类型，并且在从数据库中取出来时也需

- 日理万妓/ 2022年01月29日 02:27/ 0 赞/ 566 阅读

相关 MyBatis配置的typeHandler类型转换器

初始typeHandler 在[JDBC][]中，需要在PreparedStatement对象中设置那些已经预编译过的SQL语句参数。执行SQL后，会通过Result

清疚/ 2021年12月09日 20:31/ 0 赞/ 275 阅读

相关 MyBatis--TypeHandler类型转换器概述

TypeHandler类型转换器在 JDBC 中，需要在 PreparedStatement 对象中设置那些已经预编译过的 SQL 语句的参数。执行 SQL 后，会通过

野性酷女/ 2021年08月13日 16:21/ 0 赞/ 340 阅读