Mybatis 源码系列专栏（三）--- MyBatis 核心配置文件讲解（typeHandler）

最新推荐文章于 2024-05-26 22:32:25 发布
最新推荐文章于 2024-05-26 22:32:25 发布
阅读量217 收藏
点赞数
分类专栏： MyBatis MyBatis 源码专栏 文章标签： java mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sunflower_m/article/details/117250303
版权

文章目录

前言

上篇文章《Mybatis 源码系列专栏（二）— MyBatis 核心配置文件讲解（properties，settings，typeAliases）》为大家介绍了mybatis的properties、settings以及typealias标签的分析，这篇文章我们将继续探索其余的标签。

typeHandler

MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时， 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。简单来说 ，typeHandlers主要是用来实现Java对象和数据库字段类型间的转换关系。在看源码之前，还是像之前一样，先看看怎么配置吧？

 <typeHandlers>
        <!--
            扫描指定包下的 TypeHandler
            <package name="com.xxx"/>
         -->

        <!-- handler属性直接配置我们要指定的TypeHandler -->
        <typeHandler handler=""/>

        <!-- 指定 typeHandler 处理指定的java数据类型-->
        <typeHandler javaType="" handler=""/>

        <!-- 指定 typeHandler 处理指定的jdbc数据类型  -->
        <typeHandler jdbcType="" handler=""/>

        <!-- 两者都配置 -->
       <typeHandler javaType="" jdbcType="" handler=""/>

    </typeHandlers>

下面我们先自己实现一个typeHandler ，只需 继承mybatis 提供给的BaseTypeHandler 类。我们在自定义TypeHandler的时候，可以在TypeHandler上面通过注解@MappedJdbcTypes指定jdbcType, 通过 @MappedTypes 注解指定javaType, 如果没有使用注解指定，那么我们就需要在配置文件中配置。

// 通过注解配置jdbcType 属性
@MappedJdbcTypes(JdbcType.VARCHAR)
public class ExampleTypeHandler 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 {
    return rs.getString(columnName);
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    return rs.getString(columnIndex);
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    return cs.getString(columnIndex);
  }
}

<typeHandlers>
	 <!-- handler属性直接配置我们要指定的TypeHandler -->
	<typeHandler handler="mytest.typeHandlers.ExampleTypeHandler"/>
</typeHandlers>

下面二话不多说，撸起袖子干源码

private void typeHandlerElement(XNode parent) throws Exception {
    if (parent != null) {
      for (XNode child : parent.getChildren()) {
        // 指定扫描typeHandler的package
        if ("package".equals(child.getName())) {
          String typeHandlerPackage = child.getStringAttribute("name");
          typeHandlerRegistry.register(typeHandlerPackage);
        } else {
        // 获取子标签typeHandler的属性
          String javaTypeName = child.getStringAttribute("javaType");
          String jdbcTypeName = child.getStringAttribute("jdbcType");
          String handlerTypeName = child.getStringAttribute("handler");
          Class<?> javaTypeClass = resolveClass(javaTypeName);
          JdbcType jdbcType = resolveJdbcType(jdbcTypeName);
          Class<?> typeHandlerClass = resolveClass(handlerTypeName);
          // 下面重点看 typeHandlerRegistry.register 方法
          if (javaTypeClass != null) {
            if (jdbcType == null) {
              typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);
            } else {
              typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);
            }
          } else {
            typeHandlerRegistry.register(typeHandlerClass);
          }
        }
      }
    }
  }

 // 存储jdbctype handle
  private final Map<JdbcType, TypeHandler<?>> JDBC_TYPE_HANDLER_MAP = new EnumMap<JdbcType, TypeHandler<?>>(JdbcType.class);
 // 一个javatype 可能对应多个 jdbctype 例如：String----{VARCHAR,NVARCHAR....}
  private final Map<Type, Map<JdbcType, TypeHandler<?>>> TYPE_HANDLER_MAP = new ConcurrentHashMap<Type, Map<JdbcType, TypeHandler<?>>>();
  private final TypeHandler<Object> UNKNOWN_TYPE_HANDLER = new UnknownTypeHandler(this);
  private final Map<Class<?>, TypeHandler<?>> ALL_TYPE_HANDLERS_MAP = new HashMap<Class<?>, TypeHandler<?>>();

  private static final Map<JdbcType, TypeHandler<?>> NULL_TYPE_HANDLER_MAP = Collections.emptyMap();

  private Class<? extends TypeHandler> defaultEnumTypeHandler = EnumTypeHandler.class;
  
  // 默认注册的TypeHandler
  public TypeHandlerRegistry() {
    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(Integer.class, new IntegerTypeHandler());
    register(int.class, new IntegerTypeHandler());
    register(JdbcType.INTEGER, new IntegerTypeHandler());

    register(Long.class, new LongTypeHandler());
    register(long.class, new LongTypeHandler());

    register(Float.class, new FloatTypeHandler());
    register(float.class, new FloatTypeHandler());
    register(JdbcType.FLOAT, new FloatTypeHandler());

    register(Double.class, new DoubleTypeHandler());
    register(double.class, new DoubleTypeHandler());
    register(JdbcType.DOUBLE, new DoubleTypeHandler());

    register(Reader.class, new ClobReaderTypeHandler());
    register(String.class, new StringTypeHandler());
    register(String.class, JdbcType.CHAR, new StringTypeHandler());
    register(String.class, JdbcType.CLOB, new ClobTypeHandler());
    register(String.class, JdbcType.VARCHAR, new StringTypeHandler());
    register(String.class, JdbcType.LONGVARCHAR, new ClobTypeHandler());
    register(String.class, JdbcType.NVARCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCLOB, new NClobTypeHandler());
    register(JdbcType.CHAR, new StringTypeHandler());
    register(JdbcType.VARCHAR, new StringTypeHandler());
    register(JdbcType.CLOB, new ClobTypeHandler());
    register(JdbcType.LONGVARCHAR, new ClobTypeHandler());
    register(JdbcType.NVARCHAR, new NStringTypeHandler());
    register(JdbcType.NCHAR, new NStringTypeHandler());
    register(JdbcType.NCLOB, new NClobTypeHandler());

    register(Object.class, JdbcType.ARRAY, new ArrayTypeHandler());
    register(JdbcType.ARRAY, new ArrayTypeHandler());

    register(BigInteger.class, new BigIntegerTypeHandler());
    register(JdbcType.BIGINT, new LongTypeHandler());

    register(BigDecimal.class, new BigDecimalTypeHandler());
    register(JdbcType.REAL, new BigDecimalTypeHandler());
    register(JdbcType.DECIMAL, new BigDecimalTypeHandler());
    register(JdbcType.NUMERIC, new BigDecimalTypeHandler());

    register(InputStream.class, new BlobInputStreamTypeHandler());
    register(Byte[].class, new ByteObjectArrayTypeHandler());
    register(Byte[].class, JdbcType.BLOB, new BlobByteObjectArrayTypeHandler());
    register(Byte[].class, JdbcType.LONGVARBINARY, new BlobByteObjectArrayTypeHandler());
    register(byte[].class, new ByteArrayTypeHandler());
    register(byte[].class, JdbcType.BLOB, new BlobTypeHandler());
    register(byte[].class, JdbcType.LONGVARBINARY, new BlobTypeHandler());
    register(JdbcType.LONGVARBINARY, new BlobTypeHandler());
    register(JdbcType.BLOB, new BlobTypeHandler());

    register(Object.class, UNKNOWN_TYPE_HANDLER);
    register(Object.class, JdbcType.OTHER, UNKNOWN_TYPE_HANDLER);
    register(JdbcType.OTHER, UNKNOWN_TYPE_HANDLER);

    register(Date.class, new DateTypeHandler());
    register(Date.class, JdbcType.DATE, new DateOnlyTypeHandler());
    register(Date.class, JdbcType.TIME, new TimeOnlyTypeHandler());
    register(JdbcType.TIMESTAMP, new DateTypeHandler());
    register(JdbcType.DATE, new DateOnlyTypeHandler());
    register(JdbcType.TIME, new TimeOnlyTypeHandler());

    register(java.sql.Date.class, new SqlDateTypeHandler());
    register(java.sql.Time.class, new SqlTimeTypeHandler());
    register(java.sql.Timestamp.class, new SqlTimestampTypeHandler());

    // mybatis-typehandlers-jsr310
    if (Jdk.dateAndTimeApiExists) {
      this.register(Instant.class, InstantTypeHandler.class);
      this.register(LocalDateTime.class, LocalDateTimeTypeHandler.class);
      this.register(LocalDate.class, LocalDateTypeHandler.class);
      this.register(LocalTime.class, LocalTimeTypeHandler.class);
      this.register(OffsetDateTime.class, OffsetDateTimeTypeHandler.class);
      this.register(OffsetTime.class, OffsetTimeTypeHandler.class);
      this.register(ZonedDateTime.class, ZonedDateTimeTypeHandler.class);
      this.register(Month.class, MonthTypeHandler.class);
      this.register(Year.class, YearTypeHandler.class);
      this.register(YearMonth.class, YearMonthTypeHandler.class);
      this.register(JapaneseDate.class, JapaneseDateTypeHandler.class);
    }

    // issue #273
    register(Character.class, new CharacterTypeHandler());
    register(char.class, new CharacterTypeHandler());
  }

 // typehandle.register的核心方法
  private void register(Type javaType, JdbcType jdbcType, TypeHandler<?> handler) {
    if (javaType != null) {
      // 判断 TYPE_HANDLER_MAP 是否存储过该java类型
      Map<JdbcType, TypeHandler<?>> map = TYPE_HANDLER_MAP.get(javaType);
      if (map == null || map == NULL_TYPE_HANDLER_MAP) {
        map = new HashMap<JdbcType, TypeHandler<?>>();
        TYPE_HANDLER_MAP.put(javaType, map);
      }
      // 继续向该java类型对应的jdbc map 存放数据
      map.put(jdbcType, handler);
    }
    ALL_TYPE_HANDLERS_MAP.put(handler.getClass(), handler);
  }
程序猿_老刘
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis-plus-boot-starter-3.1.0.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， ...Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者能够更加方便快捷地进行数据库访问。
mybatis-plus-code-generator-3.5.2.x.jar
03-09
MyBatis-Plus代码生成器
mybatis-3.5.9 源码（mybatis-3-mybatis-3.5.9.tar.gz）
02-07
mybatis-3.5.9 源码（mybatis-3-mybatis-3.5.9.tar.gz）
mybatis-3.5.9 源码（mybatis-3-mybatis-3.5.9.zip）
02-07
mybatis-3.5.9 源码（mybatis-3-mybatis-3.5.9.zip）
Mybatis TypeHandler解析
m0_71777195的博客
02-10 1359
TypeHandler是类型处理器，它用来解析Java类型与Jdbc类型之间的相互转换。TypeHandlerRegistry是一个注册器，其中注册了JDBC与TypeHandler的映射关系、Java类型与TypeHandler的映射关系。那么由此我们可以想象到，在mybatis执行SQL的过程中，一定会在某处调用TypeHandlerRegistry并通过参数的Java类型获取对应的TypeHandler对象为PreparedStatement设置参数。也一定会在解析结果集的过程中，
mybatis解析-TypeHandler作用详解
龚厂长的博客
02-19 7243
TypeHandler被称作类型处理器，MyBatis在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时，都会用类型处理器将Java对象转化为数据库支持的类型或者将获取到数据库值以合适的方式转换成 Java类型。 mybatis提供了31个默认的类型处理器，它们都位于org.apache.ibatis.type包下，这些默认的处理器能够满足我们大部分场景的需求。 本文接下来首先介绍TypeHandler接口的定义，之后介绍其在mybatis中如何使用，最后介绍一些my
Mybatis实现自定义TypeHandler对字段数据进行加解密
RayPick的博客
08-04 2648
在网上看了些方法，发现有一个文章是让继承什么BaseTypeHandler，用了之后发现不好用，实现了这个接口之后，全局都生效了，也可能是我配置的不对。，查询出来的时候是否需要解密由你自己决定，如果给前端传输过程中也是需要密文的话，那就让前端去解密。可以看到数据落库的时候，都已经加密了。查询的时候，数据已经解密。..................
MyBatis配置项--typeHandlers
weixin_34114823的博客
02-01 211
无论是MyBatis在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成java类型。 可以重写类型处理器或创建自己的类型处理器来处理不支持的或非标准的类型。具体做法为： 实现org.apache.ibatis.type.TypeHandler接口，或继承一个很便利的类org.apache.ibatis.t...
深入浅出Mybatis系列（五）---TypeHandler简介及配置（mybatis源码篇）
lisheng19870305的专栏
06-30 293
上篇文章《深入浅出Mybatis系列（四）---配置详解之typeAliases别名（mybatis源码篇）》为大家介绍了mybatis中别名的使用，以及其源码。本篇将为大家介绍TypeHandler， 并简单分析其源码。 Mybatis中的TypeHandler是什么？ 　　无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。Mybatis默认为我们实现了许多TypeHan
Mybatis源码学习笔记（五）配置简介之TypeHandler
海的那边见
06-10 714
配置简介之TypeHandler
Mybatis中的TypeHandler你用过吗？
Pastxu的小屋
04-22 631
什么是TypeHandler？ 顾名思义，类型处理器，将入参和结果转换为所需要的类型，Mybatis中对于内置了许多类型处理器，实际开发中已经足够使用了，如下图： 类型处理器这个接口其实很简单，总共四个方法，一个方法将入参的Java类型的数据转换为JDBC类型，三个方法将返回结果转换为Java类型。源码如下： publicinterfaceTypeHandler<T>{ //设置参数，java类型转换为jdbc类型 voidsetParameter(P...
mybatis启动过程分析 typehandler
zhenghuangyu的博客
12-23 441
本节介绍typehandler的解析，在mybatis中typehandler主要是用于类型转换的比如数据库中是varchar2而Java bean中是string 或者 integer等，需要使用typehandler，typehander的解析使用如下的方法 配置typehander可以使用package包扫描的方式也可以挨个配置 &amp;lt;configuration&amp;gt; &amp;lt;...
mybatis-spring-boot-starter-2.1.3.jar
01-10
mybatis-spring-boot-starter-2.1.3.jarmybatis-spring-boot-starter-2.1.3.jarmybatis-spring-boot-starter-2.1.3.jar
mybatis的配置元素--typeHandler类型处理器
MaXiao092的博客
10-26 1136
typeHandler源码分析可参考:http://www.cnblogs.com/dongying/p/4040435.html typeHandler的作用:可以在bean对象的属性和数据库中存储的对象属性进行转换， 譬如bean中是list属性，存储到数据库中可以是array属性， bean中是java.util.Date属性，数据库中存储的是varchar类型的unix时间戳。 typ
MyBatis中TypeHandler的使用教程
w20001118的博客
01-16 1983
在我们平常开发操作数据库时，查询、插入数据等操作行为，有时会报数据类型不匹配异常，就可以得知数据的类型是不唯一的必然是多种不同的数据类型。假设此时的java类型与数据库数据类型是一样的，哪么其他语言中的日期数据插入数据库时又该怎么解释，例如C#操作数据库存入时间类型，C#与java肯定没有关系吧。因为java与数据库各自有数据类型，所以在将java数据存入数据库前中间是否有其他操作，是我们看不见的，不然java数据怎么知道自己与哪个jdbc数据类型匹配？中间具体有什么操作？多个注册：指定多个单个注册方式；
SpringBoot | 第三十五章：Mybatis的集成和使用
临风暖阳的博客
02-25 1286
前言 最近收到公众号留言说，单纯的Mybatis的集成和使用。前面在第九章：Mybatis-plus的集成和使用介绍了基于mybatis-plus的集成和使用。后者也只是对mybatis进行了功能增强，原本的用法都是没有变化的。那今天就来简单介绍了如何springboot中如何集成和使用Mybatis吧。 SpringBoot的集成和使用 通用配置 注解方式 xml方式 枚举类型处理器配置 参考资料 总结 最后 老生常谈 SpringBoot的集成和使用 MyBatis是一款优秀的持久层框架，它支持定制化S
springboot——typeHandler的使用
tang_seven的博客
03-23 2528
简单记录一下typeHandler的两种使用形式，将JSON类型和VARCHAR类型进行转换，有效避免查询时返回字段带反斜杠的问题
【STM32学习】HAL库点灯学习
最新发布
2301_78895982的博客
05-26 950
STM32基于HAL库流水灯实验_hel库安装教程中文版-CSDN博客t=N7T8。
mybatis.type-handlers-package
07-08
`mybatis.type-handlers-package`是MyBatis配置文件中的一个属性，用于指定自定义类型处理器（Type Handlers）所在的包路径。自定义类型处理器是用于在Java类型和数据库列之间进行转换的组件。 在配置文件中，可以...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值