spring boot mybatis TypeHandler 源码如何初始化及调用

已于 2023-12-04 07:32:12 修改
阅读量350 收藏
点赞数
分类专栏： spring 文章标签： spring boot mybatis TypeHandler 源码 初始化 调用
于 2023-12-01 09:48:13 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_79691134/article/details/134720104
版权

目录

概述

阅读此文 可以达到 spring boot mybatis TypeHandler 源码如何初始化及如何调用的。

spring boot 版本为 2.7.17，mybatis(spring boot) 2.3.2
TypeHandler 是 mybatis 中 java 对象和数据库 jdbc 之间进行类型转换的桥梁。

调用层级深，比较复杂，关键源码点，给出了详细的位置，打上断点，降低难度。

接口源码如下：

public interface TypeHandler<T> {
  // 从java对象到数据库类型的转换
  void setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException;
  // 下面三个是从数据库到java对象的转换
  T getResult(ResultSet rs, String columnName) throws SQLException;

  T getResult(ResultSet rs, int columnIndex) throws SQLException;

  T getResult(CallableStatement cs, int columnIndex) throws SQLException;
}

使用

TypeHandler

实现 TypeHandler 接口，也可以实现抽象类 BaseTypeHandler

代码如下：

@MappedJdbcTypes(JdbcType.VARCHAR)
@MappedTypes(Reason.class)
public class ResonJsonTypeHandler extends BaseTypeHandler<Reason> {

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, Reason parameter, JdbcType jdbcType) throws SQLException {
        // 将java对象转换成jdbc中的类型
        ps.setString(i, JSON.toJSONString(parameter));
    }

    @Override
    public Reason getNullableResult(ResultSet rs, String columnName) throws SQLException {
        return JSON.parseObject(rs.getString(columnName), Reason.class);
    }

    @Override
    public Reason getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        return JSON.parseObject(rs.getString(columnIndex), Reason.class);
    }

    @Override
    public Reason getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        return JSON.parseObject(cs.getString(columnIndex), Reason.class);
    }
}

注意：

  • @MappedJdbcTypes 代表对应的数据库中字段的类型，json本质上也是字符串
  • @MappedTypes 代表要转换的 JavaBean 对象
  • java对象与json格式的互相转换需要 JSON 来完成

使用方式

在 select | update | insert 中加入

写在 xml 只有对应的 sql 会被转换
在这里插入图片描述

org.apache.ibatis.mapping.ResultMapping.Builder#resolveTypeHandler

配置文件中指定

如下配置，任何使用 Reason 的地方都会进行转换。

mybatis:
  type-handlers-package: com.fun.demo.mybatis.type.handler

由于 xml 与 mapper 都是会生成覆盖，所以选择配置文件中指定。

源码分析

配置文件指定

protected SqlSessionFactory buildSqlSessionFactory() throws Exception {

    final Configuration targetConfiguration;

    XMLConfigBuilder xmlConfigBuilder = null;
....
    if (hasLength(this.typeHandlersPackage)) {
      scanClasses(this.typeHandlersPackage, TypeHandler.class).stream().filter(clazz -> !clazz.isAnonymousClass())
          .filter(clazz -> !clazz.isInterface()).filter(clazz -> !Modifier.isAbstract(clazz.getModifiers()))
          .forEach(targetConfiguration.getTypeHandlerRegistry()::register);
    }

    if (!isEmpty(this.typeHandlers)) {
      Stream.of(this.typeHandlers).forEach(typeHandler -> {
        targetConfiguration.getTypeHandlerRegistry().register(typeHandler);
        LOGGER.debug(() -> "Registered type handler: '" + typeHandler + "'");
      });
    }

....

scanClasses 方法进行加载自定义的 typeHandler
org.mybatis.spring.SqlSessionFactoryBean#scanClasses
在这里插入图片描述
org.apache.ibatis.mapping.ResultMapping.Builder#resolveTypeHandler
在这里插入图片描述

Mapper

在 Mapper 中自定义时，依然也是在 SqlSessionFactoryBean 的 buildSqlSessionFactory 方法。

org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration#sqlSessionFactory
org.mybatis.spring.SqlSessionFactoryBean#afterPropertiesSet
org.apache.ibatis.builder.xml.XMLMapperBuilder#parse
org.apache.ibatis.builder.xml.XMLMapperBuilder#configurationElement
org.apache.ibatis.builder.xml.XMLMapperBuilder#resultMapElements
org.apache.ibatis.builder.xml.XMLMapperBuilder#resultMapElement(org.apache.ibatis.parsing.XNode)
org.apache.ibatis.builder.xml.XMLMapperBuilder#resultMapElement(org.apache.ibatis.parsing.XNode, java.util.List<org.apache.ibatis.mapping.ResultMapping>, java.lang.Class<?>)
org.apache.ibatis.builder.MapperBuilderAssistant#buildResultMapping(java.lang.Class<?>, java.lang.String, java.lang.String, java.lang.Class<?>, org.apache.ibatis.type.JdbcType, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Class<? extends org.apache.ibatis.type.TypeHandler<?>>, java.util.List<org.apache.ibatis.mapping.ResultFlag>, java.lang.String, java.lang.String, boolean)
org.apache.ibatis.builder.BaseBuilder#resolveTypeHandler(java.lang.Class<?>, java.lang.Class<? extends org.apache.ibatis.type.TypeHandler<?>>)

public void parse() {
  if (!configuration.isResourceLoaded(resource)) {
    configurationElement(parser.evalNode("/mapper"));
    configuration.addLoadedResource(resource);
    bindMapperForNamespace();
  }
  parsePendingResultMaps();
  parsePendingCacheRefs();
  parsePendingStatements();
}

具体的解析 /mapper 元素

private void configurationElement(XNode context) {
  try {
    String namespace = context.getStringAttribute("namespace");
    if (namespace == null || namespace.isEmpty()) {
      throw new BuilderException("Mapper's namespace cannot be empty");
    }
    builderAssistant.setCurrentNamespace(namespace);
    cacheRefElement(context.evalNode("cache-ref"));
    cacheElement(context.evalNode("cache"));
    parameterMapElement(context.evalNodes("/mapper/parameterMap"));
    resultMapElements(context.evalNodes("/mapper/resultMap"));
    sqlElement(context.evalNodes("/mapper/sql"));
    buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
  } catch (Exception e) {
    throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
  }
}

  private ResultMap resultMapElement(XNode resultMapNode, List<ResultMapping> additionalResultMappings,
      Class<?> enclosingType) {
.......
    List<XNode> resultChildren = resultMapNode.getChildren();
    for (XNode resultChild : resultChildren) {
      if ("constructor".equals(resultChild.getName())) {
        processConstructorElement(resultChild, typeClass, resultMappings);
      } else if ("discriminator".equals(resultChild.getName())) {
        discriminator = processDiscriminatorElement(resultChild, typeClass, resultMappings);
      } else {
        List<ResultFlag> flags = new ArrayList<>();
        if ("id".equals(resultChild.getName())) {
          flags.add(ResultFlag.ID);
        }
        resultMappings.add(buildResultMappingFromContext(resultChild, typeClass, flags));
      }
    }
.....
  }

在这里插入图片描述

buildResultMappingFromContext

 private ResultMapping buildResultMappingFromContext(XNode context, Class<?> resultType, List<ResultFlag> flags) {
   String property;
   if (flags.contains(ResultFlag.CONSTRUCTOR)) {
     property = context.getStringAttribute("name");
   } else {
     property = context.getStringAttribute("property");
   }
   ......
   String nestedResultMap = context.getStringAttribute("resultMap",
       () -> processNestedResultMappings(context, Collections.emptyList(), resultType));
       ....
   String typeHandler = context.getStringAttribute("typeHandler");
   String resultSet = context.getStringAttribute("resultSet");
   String foreignColumn = context.getStringAttribute("foreignColumn");
	.....
 }

String typeHandler = context.getStringAttribute(“typeHandler”);

执行query

如何转换

org.apache.ibatis.executor.SimpleExecutor#doQuery
在这里插入图片描述

org.apache.ibatis.session.Configuration#newStatementHandler
org.apache.ibatis.executor.statement.RoutingStatementHandler#RoutingStatementHandler
org.apache.ibatis.executor.statement.PreparedStatementHandler
org.apache.ibatis.executor.statement.BaseStatementHandler#BaseStatementHandler
org.apache.ibatis.executor.statement.RoutingStatementHandler#query
org.apache.ibatis.logging.jdbc.PreparedStatementLogger#invoke
org.apache.ibatis.executor.resultset.ResultSetHandler#handleResultSets
org.apache.ibatis.executor.resultset.DefaultResultSetHandler#handleResultSet
org.apache.ibatis.executor.resultset.DefaultResultSetHandler#handleRowValues
org.apache.ibatis.executor.resultset.DefaultResultSetHandler#handleRowValuesForSimpleResultMap
org.apache.ibatis.executor.resultset.DefaultResultSetHandler#applyPropertyMappings
org.apache.ibatis.executor.resultset.DefaultResultSetHandler#getPropertyMappingValue
com.fun.demo.mybatis.type.handler.ResonJsonTypeHandler#getNullableResult(java.sql.ResultSet, java.lang.String)

在这里插入图片描述
执行结果
在这里插入图片描述

结束

spring boot mybatis TypeHandler 如何初始化及如何调用，就解释的非常明白了，如有疑问，欢迎评论区留言。

流月up
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Spring boot Mybatis源码
11-24
Spring boot Mybatis源码，只是单纯的分享给有需要的人使用，俗话说的好，万事开头难，当迈开了第一步，就相当于打开了一扇门，发现了新大陆，所以我们要持之以恒，才能取得成功，让我们一起努力，为心中最美好的...
springboot——typeHandler的使用
tang_seven的博客
03-23 2904
简单记录一下typeHandler的两种使用形式，将JSON类型和VARCHAR类型进行转换，有效避免查询时返回字段带反斜杠的问题
SpringBoot中使用Mybatis的TypeHandler简单案例及源码简析
tqkm
05-15 3033
1
SpringBoot - MyBatis-Plus使用详解（字段类型处理器TypeHandler）
qq_43842093的博客
08-06 1651
（1）如果我们需要实现一个自定义的类型处理器，则需继承接口，接口作用是用于指定jdbc与java的数据类型间对应关系处理。// 保存操作，数据入库之前时数据处理 void setParameter(PreparedStatement ps , int i , T parameter , JdbcType jdbcType) throws SQLException;
Springboot 使用 BaseTypeHandler 与 TypeHandler 记录
qiaobing1226的博客
11-30 988
TypeHandler是 springboot 在使用Mybatis插件的时候，有需要将Java对象和数据库JDBC数据类型之间进行转换。
SpringBoot第25讲：SpringBoot对TypeHandler的使用
Jet_qi的博客
07-11 762
我们可以通过自定义TypeHandler的形式来在设置参数或者取出结果集的时候自定义参数封装策略。
详解spring boot mybatis全注解化
08-29
Spring Boot MyBatis 全注解化详解 Spring Boot MyBatis 全注解化是指使用 Spring Boot 框架和 MyBatis 持久层框架实现数据访问层的所有配置都是通过注解方式实现的。这种方式可以简化配置，提高开发效率和代码...
Spring boot Mybatis 整合（完整版）
08-27
Spring Boot MyBatis 整合（完整版） 本文将详细介绍 Spring Boot 和 MyBatis 的整合过程，涵盖从项目创建到依赖选择、配置文件设置、MyBatis 配置、PageHelper 分页插件的使用等多个方面。 Spring Boot 项目创建 ...
spring boot mybatis枚举映射示例代码
08-25
在Spring Boot集成MyBatis的项目中，我们经常会遇到实体类中的字段是枚举类型，而数据库中的对应字段是整型或字符串型的情况。这种情况下，我们需要进行枚举与数据库字段之间的映射处理，以便正确地保存和读取数据。...
Spring Boot+Mybatis图书管理系统源码.zip
05-27
Spring Boot+Mybatis图书管理系统；本项目核心技术采用Spring Boot+Mybatis；开发工具idea；数据库MySQL5.6；界面采用了jQuery EasyUI框架；Quartz定时任务。
自定义TypeHandler，解决在springboot+mybatis+postgresql时，数据库字段类型为json时，如何与mybatis进行映射
06-07
解决在springboot+mybatis+postgresql时，数据库字段类型为json时，如何与mybatis进行映射
springboot学习二之之定义typeHandler
m0_37735176的博客
11-17 2493
项目工程沿用上一次springboot学习一的工程。添加新的测试方法。 Controller @PostMapping("/add") public String addUser(@RequestBody User user){ String msg = testService.addUser(user); return msg; } Servi...
MyBatis TypeHandler详解：原理与自定义实践
最新发布
码到三十五
03-02 2万+
TypeHandler是MyBatis中用于处理Java类型与JDBC类型之间转换的接口。在SQL语句执行过程中，无论是设置参数还是获取结果集，都需要通过TypeHandler进行类型转换。MyBatis提供了丰富的内置TypeHandler实现，以支持常见的数据类型转换。同时，开发者也可以根据需要自定义TypeHandler来处理特殊的数据类型或转换逻辑。MyBatis的TypeHandler机制具有很高的扩展性。
SpringBoot Mybatis EnumTypeHandler自定义统一处理器
热门推荐
猪哥
10-17 2万+
需求 mybatis目前已经内嵌入了springboot中了，这说明其目前在数据访问层的绝对优势。而我们在开发的过程中，往往会在程序中使用枚举(enum) 来表示一些状态或选项，而在数据库中使用数字来存储。这样做的好处是在程序中使用enum更直观的可以知道每个值代表的状态及含义，还可以做国际化的功能。那么这样会带来一个问题那就是：程序中的枚举 与 数据库中的数字 转换问题。 介绍
Mybatis+Spring boot整合趟坑————自定义TypeHandler
写个代码 扯个闲淡
11-22 1万+
Spring boot+mybatis整合使用的mybatis-spring-boot-starter，可以参考 springboot(六)-如何优雅的使用mybatis.html 通过注解的形式就可以实现与mybatis整合。 因为JAVA原生的日期处理比较恶心，最近习惯了joda Time。 但是mybatis不像JPA 与原生支持Joda，所以在日期型是Jod
springboot基于Mybatis和XML实现自定义TypeHandler对字段数据进行加解密
weixin_72770510的博客
08-13 1314
springboot基于Mybatis和XML实现自定义TypeHandler对字段数据进行加解密
Spring Boot系列7-SpringBoot+mybatis+druid+TypeHandler
猿份哥
11-17 2873
介绍在SpringBoot中集成mybatis和druid以及自定义TypeHandler 创建数据库表 SET NAMES utf8mb4; SET FOREIGN_KEY_CHECKS = 0; -- ---------------------------- -- 创建student表 -- ---------------------------- DROP TABLE IF EXISTS...
spring+mybatis中typehandler怎么配置
zhaoyf7746的博客
05-03 1万+
我们在不使用spring来管理的时候通常把typehandler的配置放到mybatis-config.xml中，如下：<configuration> <typeHandlers> <!-- 当配置package的时候，mybatis会去配置的package扫描TypeHandler <package name="com.dy.demo"
SpringBoot: MyBatis自定义类型转换器(TypeHandler)
amadeus_liu2的博客
01-01 1622
1.定义自定义类型转换器类，实现TypeHandler接口， package cn.edu.tju.handler; import cn.edu.tju.domain.Name; import org.apache.ibatis.type.JdbcType; import org.apache.ibatis.type.MappedJdbcTypes; import org.apache.ibatis.type.MappedTypes; import org.apache.ibatis.type.TypeH
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

流月up

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值