Mybatis TypeHandler解析

亦凉 2023-09-26 17:58 21阅读 0赞

## 开篇 ##

JDBC类型与Java类型并不是完全一一对应的。所以在PreparedStatement绑定参数的时候需要把Java类型转为JDBC类型。JDBC类型的枚举值在`JdbcType`枚举值中存储。

MyBatis中提供了一个接口专用于JDBC类型与Java类型的转换。它就是我们今天的主题：**TypeHandler（类型转换器）**

## **TypeHandler接口** ##

**TypeHandler是用于JDBC类型与Java类型的转换**

我们先来看一下这个接口的定义，它都规范了哪些行为。再来说这些方法的实现类和具体作用。

public interface TypeHandler<T> {
      void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;
      T getResult(ResultSet rs, String columnName) throws SQLException;
      T getResult(ResultSet rs, int columnIndex) throws SQLException;
      T getResult(CallableStatement cs, int columnIndex) throws SQLException;
    }
    复制代码

该接口中共有4个方法。这四个方法只定义了两种行为，一是setParameter（设置参数）二是操作结果集获取指定对象

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>setParameter</td> 
   <td>使用PreparedStatement执行SQL是，设置带<code>?</code>的参数。</td> 
  </tr> 
  <tr> 
   <td>getResult</td> 
   <td>获取结果集中指定列名对应的值，或者获取结果集中指定索引对应的值</td> 
  </tr> 
 </tbody> 
</table>

实际setParameter方法的底层实现就是JDBC操作

PreparedStatement ps = connection.prepareStatement();
    ps.setString(1,"value");
    复制代码

getResult方法的底层同样也是JDBC操作

// rs是结果集对象ResultSet
    rs.getInt(colName);
    rs.getInt(i)
    复制代码

### TypeHandler继承体系 ###

在MyBatis中JDBC类型被定义在枚举类`JdbcType`中。共有41中JDBC类型。每个JDBC类型都对应一个`XxxTypeHandler`类。每个类都是解决特定的JDBC类型转换

TypeHandler接口值规定了行为，每种JDBC类型，都提供了对应的实现类来完场JDBC到Java类型的转换。

![format_png][]

每个TypeHandler的实现都大同小异，而为了避免空指针的问题，TypeHandler还有一个抽象子类，对这4个方法做了模板处理。

1.  设置参数：如果值为null则直接跳过，否则调用具体实现类设置参数
2.  从结果集中获取数据：调用具体实现类的`getNullableResult`方法

BaseTypeHandler的代码比较简单易懂，这列举重要实现：

public void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException {
      if (parameter == null) {
        if (jdbcType == null) {抛异常}
        try {
          ps.setNull(i, jdbcType.TYPE_CODE);
        } catch (SQLException e) { 抛异常 }
      } else {
        try {
          // 如果参数不为Null才调用子类方法
          setNonNullParameter(ps, i, parameter, jdbcType);
        } catch (Exception e) { 抛异常 }
      }
    }
    复制代码

我们先来剖析下常用的类型。IntegerTypeHandler

#### IntegerTypeHandler ####

public class IntegerTypeHandler extends BaseTypeHandler<Integer> {
    
      @Override
      public void setNonNullParameter(PreparedStatement ps, int i, Integer parameter, JdbcType jdbcType) throws SQLException {
        ps.setInt(i, parameter);
      }
      public Integer getNullableResult(ResultSet rs, String columnName) throws SQLException {
        int result = rs.getInt(columnName);
        return result == 0 && rs.wasNull() ? null : result;
      }
      // 省略另外两个方法
    }
    复制代码

可以看到IntegerTypeHandler的底层就是调用了JDBC对象PreparedStatement的方法来设置参数与获取结果集中的记录。这个实现是最简单的一个，就不展开介绍了。

下面我们再来看一下日期类型的映射

#### DateTypeHandler ####

public class DateTypeHandler extends BaseTypeHandler<Date> {
    
      @Override
      public void setNonNullParameter(PreparedStatement ps, int i, Date parameter, JdbcType jdbcType) throws SQLException {
        ps.setTimestamp(i, new Timestamp(parameter.getTime()));
      }
    
      @Override
      public Date getNullableResult(ResultSet rs, String columnName) throws SQLException {
        Timestamp sqlTimestamp = rs.getTimestamp(columnName);
        if (sqlTimestamp != null) {
          return new Date(sqlTimestamp.getTime());
        }
        return null;
      }
    }
    复制代码

1.  设置参数：我们使用Java编程，使用的日期常用的类是`java.util.Date`，但是在JDBC操作数据库的时候，往往需要的不是Date类型，而是**SQL标准定义**的`Timestamp`类型，DateTypeHandler会帮助我们把Date转化为Timestamp
2.  获取结果，从JDBC中获取的记录如果是Timestamp类型，则DateTypeHandler帮我们转为`java.util.Date`对象

**注：可能大家在编程JDBC的时候，执行如下语句`select * from user where birthday > ?`，无论数据库中birthday字段是Date/DateTime/TimeStamp类型，我们都会把会把`?`的值设置为Date类型，实际上这是不符合JDBC标准的。**

其他TypeHandler的实现，就不再看了。逻辑都是一样的。

## TypeHandlerRegistry ##

通过上一小节了解到了每一种JDBC类型，都提供了TypeHandler的实现。那么mybatis什么时候才会用到这些实现类呢？或者说当需要进行类型转换的时候，MyBatis是如何使用这些实现类的。

在MyBatis初始化的时候，会加载TypeHandlerRegistry这个类，这个类有在构造方法里会调用一系列的`register`方法把TypeHandler所有实现类都注册到TypeHandlerRegistry中。下面我们先来看一下TypeHandlerRegistry中的重要属性

public final class TypeHandlerRegistry {
      private final Map<JdbcType, TypeHandler<?>> jdbcTypeHandlerMap = new EnumMap<>(JdbcType.class);
      private final Map<Type, Map<JdbcType, TypeHandler<?>>> typeHandlerMap = new ConcurrentHashMap<>();
      private final TypeHandler<Object> unknownTypeHandler;
      private final Map<Class<?>, TypeHandler<?>> allTypeHandlersMap = new HashMap<>();
    }
    复制代码

1.  jdbcTypeHandlerMap：key是Jdbc类型，value是Jdbc类型对应的处理器
2.  typeHandlerMap：key是Java类型，value是对应的处理器集合（它也是要给Map）。因为一个Java类型可能被多个处理器解析。比如String类型可能被解析为char varchar类型等。比如Java的`java.util.Date`类型可以被解析为Date Time TimeStamp类型。**存在一对多的关系**
3.  unknownTypeHandler：位置的TypeHandler，一般为空
4.  allTypeHandlersMap：所有类型处理器，key是TypeHandler实现类的Class对象，value是具体的TypeHandler

### TypeHandlerRegistry\#register方法 ###

上面介绍了TypeHandlerRegistry中几个重要的属性。在mybatis启动时，就会把所有的TypeHandler都注册到如上的4个数据结构中。具体的实现在TypeHandlerRegistry的构造方法中，调用register方法进行注册TypeHandler

public TypeHandlerRegistry(Configuration configuration) {
      register(Boolean.class, new BooleanTypeHandler());
      register(boolean.class, new BooleanTypeHandler());
      register(JdbcType.BOOLEAN, new BooleanTypeHandler());
      register(JdbcType.BIT, new BooleanTypeHandler());
    
      register(Byte.class, new ByteTypeHandler());
      register(byte.class, new ByteTypeHandler());
      register(JdbcType.TINYINT, new ByteTypeHandler());
    
      register(Short.class, new ShortTypeHandler());
      register(short.class, new ShortTypeHandler());
      register(JdbcType.SMALLINT, new ShortTypeHandler());
      // ...省略其他register
    }
    复制代码

这些register最终将如上的3个Map数据结构填充。通过名字也能看出来，注册Class/JdbcType与TypeHandler的映射关系。而这些register分为两大类，一类是注册JDBC-TypeHandler映射关系，一类是注册Java-TypeHandler的映射关系。我们先来看第一种

public void register(JdbcType jdbcType, TypeHandler<?> handler) {
      jdbcTypeHandlerMap.put(jdbcType, handler);
    }
    复制代码

它的实现很简单，就是直接把jdbcType作为key，TypeHandler作为value，存入jdbcTypeHandlerMap即可。接下来我们再来看第二种：注册Java-TypeHandler的映射关系

private <T> void register(Type javaType, TypeHandler<? extends T> typeHandler) {
      MappedJdbcTypes mappedJdbcTypes = typeHandler.getClass().getAnnotation(MappedJdbcTypes.class);
      if (mappedJdbcTypes != null) {
        for (JdbcType handledJdbcType : mappedJdbcTypes.value()) {
          register(javaType, handledJdbcType, typeHandler);
        }
        if (mappedJdbcTypes.includeNullJdbcType()) {
          register(javaType, null, typeHandler);
        }
      } else {
        register(javaType, null, typeHandler);
      }
    }
    复制代码

我们来分析下注册步骤：

1.  获取MappedJdbcTypes注解，对自定义的TypeHandler进行注册。（自定义TypeHandler时需要该注解指定自定义的TypeHandler都解析哪些JDBC类型）
2.  如果TypeHandler没有注解信息（也就是没有自定义TypeHandler）则直接调用重载register方法注册Java-TypeHandler的映射关系。

下面就来看一下这个重载register方法

private void register(Type javaType, JdbcType jdbcType, TypeHandler<?> handler) {
      if (javaType != null) {
        Map<JdbcType, TypeHandler<?>> map = typeHandlerMap.get(javaType);
        if (map == null || map == NULL_TYPE_HANDLER_MAP) {
          map = new HashMap<>();
        }
        map.put(jdbcType, handler);
        typeHandlerMap.put(javaType, map);
      }
      allTypeHandlersMap.put(handler.getClass(), handler);
    }
    复制代码

代码中它主要做了两件事：

1.  注册Java-TypeHandler的映射关系
2.  把TypeHandler的**Class和类**的映射关系存入allTypeHandlersMap

至此TypeHandlerRegistry中就有了最重要的两种映射关系

1.  JDBC类型 与 TypeHandler 的映射关系（通过Jdbc类型寻找合适的TypeHandler类型，通常用于结果集的解析过程）
2.  Java类型 与 TypeHandler 的映射关系（通过Java类型寻找合适的TypeHandler类型，通常用于为PreparedStatement对象设置参数）

TypeHandlerRegistry也提供了一系列的`get*`方法，可以根据指定的信息返回需要的TypeHandler类

*  getMappingTypeHandler(Class>)：根据TypeHandler类型获取对应的TypeHandler对象
 *  getTypeHandler(JdbcType)：根据JdbcType类型获取TypeHandler对象
 *  getTypeHandler(Class)：根据Class类型获取TypeHandler对象
 *  getJdbcHandlerMap(Type)：根据Java类型获取TypeHandler对象

## 总结 ##

TypeHandler是类型处理器，它用来解析Java类型与Jdbc类型之间的相互转换。

TypeHandlerRegistry是一个注册器，其中注册了JDBC与TypeHandler的映射关系、Java类型与TypeHandler的映射关系。

那么由此我们可以想象到，在mybatis执行SQL的过程中，一定会在某处**调用TypeHandlerRegistry并通过参数的Java类型获取对应的TypeHandler对象为PreparedStatement设置参数。**

也一定会在解析结果集的过程中，**调用TypeHandlerRegistry并通过结果集数据的Jdbc类型获取对应的TypeHandler对象为来解析结果集中的记录**

[format_png]: https://img-blog.csdnimg.cn/img_convert/bcb9ca6b280c1efcc0d1ab4ff63de1a3.webp?x-oss-process=image/format,png