首页 > 资讯 > 后端开发 > Python >Mybatis TypeHandler接口及继承关系示例解析

764

分享到

Mybatis TypeHandler接口及继承关系示例解析

Mybatis TypeHandler接口继承 Mybatis TypeHandler 2023-02-08 12:02:42 764人浏览薄情痞子

Python 官方文档：入门教程 => 点击学习

摘要

目录开篇TypeHandler接口TypeHandler继承体系IntegerTypeHandlerDateTypeHandlerTypeHandlerReGIStryTypeHan

开篇

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

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

TypeHandler接口

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

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

public interface TypeHandler&lt;T&gt; {
  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（设置参数）二是操作结果集获取指定对象

方法名	描述
setParameter	使用PreparedStatement执行SQL是，设置带`?`的参数。
getResult	获取结果集中指定列名对应的值，或者获取结果集中指定索引对应的值

实际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类型的转换。

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

设置参数：如果值为null则直接跳过，否则调用具体实现类设置参数
从结果集中获取数据：调用具体实现类的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;
  }
}

设置参数：我们使用Java编程，使用的日期常用的类是java.util.Date，但是在JDBC操作数据库的时候，往往需要的不是Date类型，而是SQL标准定义的Timestamp类型，DateTypeHandler会帮助我们把Date转化为Timestamp
获取结果，从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<>();
}

jdbcTypeHandlerMap：key是Jdbc类型，value是Jdbc类型对应的处理器
typeHandlerMap：key是Java类型，value是对应的处理器集合（它也是要给Map）。因为一个Java类型可能被多个处理器解析。比如String类型可能被解析为char varchar类型等。比如Java的java.util.Date类型可以被解析为Date Time TimeStamp类型。存在一对多的关系
unknownTypeHandler：位置的TypeHandler，一般为空
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);
  }
}

我们来分析下注册步骤：

获取MappedJdbcTypes注解，对自定义的TypeHandler进行注册。（自定义TypeHandler时需要该注解指定自定义的TypeHandler都解析哪些JDBC类型）
如果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);
}

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

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

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

JDBC类型与 TypeHandler 的映射关系（通过Jdbc类型寻找合适的TypeHandler类型，通常用于结果集的解析过程）
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对象为来解析结果集中的记录

以上就是Mybatis TypeHandler接口及继承关系示例解析的详细内容，更多关于Mybatis TypeHandler接口继承的资料请关注编程网其它相关文章！

您可能感兴趣的文档:

--结束END--

本文标题: Mybatis TypeHandler接口及继承关系示例解析

本文链接: https://lsjlt.com/news/195154.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

回答

如何调试操作系统的错误？
操作系统

2023-11-15发布

回答

操作系统中的I/O系统是如何实现的？
操作系统

2023-11-15发布

回答

如何实现操作系统的内存管理？
操作系统

2023-11-15发布

回答

什么是虚拟内存，它对操作系统有什么影响？
操作系统

2023-11-15发布

回答

ASP中的MVC架构和WebForms架构有什么区别和使用场景？
ASP.NET

2023-11-15发布

回答

ASP中的数据验证和数据校验有什么不同？
ASP.NET

2023-11-15发布

回答

ASP中的ADO对象和DAO对象有什么区别和使用方法？
ASP.NET

2023-11-15发布

回答

Node.js中的包管理器NPM是什么？如何使用它进行依赖管理？
node.js

2023-11-15发布

回答

Vue.js中的动态组件是什么？如何使用它来动态渲染组件？
VUE

2023-11-15发布

回答

如何使用Vue.js实现懒加载和预加载？
VUE

2023-11-15发布

Mybatis TypeHandler接口及继承关系示例解析

目录

开篇

TypeHandler接口

TypeHandler继承体系

IntegerTypeHandler

DateTypeHandler

TypeHandlerRegistry

TypeHandlerRegistry#register方法

总结

Mybatis TypeHandler接口及继承关系示例解析

go语言interface接口继承多态示例及定义解析

c++中继承关系的示例分析

PHP中类继承关系的示例分析

如何解析C++类继承关系问题

C++三种继承方式及好处示例详解

go语言数组及结构体继承和初始化示例解析

Java集合类之组织结构和继承、实现关系的示例分析

剖析 JavaScript 继承的精髓：理解类的层级关系

Golang接口实现方式及示例分析

Java源码解析之接口Collection的示例分析

java接口语法以及与类的关系详解

Java面向对象编程之继承和多态以及包的解析与使用范例

Java之Swagger配置扫描接口以及开关案例讲解

java理论基础函数式接口特点示例解析

MySQL用户和权限及破解root口令的示例分析

R语言绘制corrplot相关热图分析美化示例及详细图解

MySQL系列多表连接查询92及99语法示例详解教程

Win8.1系统连接WLAN提示“不可用"的故障分析及解决方法

Python光学仿真实现波长与颜色之间对应关系示例解析

python分析数据的方法是什么

如何使用Python实现抽奖小程序

python copy函数的作用是什么

python ffmpeg模块怎么安装和使用

python进程池创建队列的方法是什么

python无法运行文件的原因有哪些

python can't open file报错怎么解决

python keyerror错误怎么解决

python字符串处理与应用的方法有哪些

python全局变量如何定义