Mybatis拦截器Interceptor与字段类型处理器BaseTypeHandler区别

已于 2024-08-22 17:09:04 修改
阅读量515 收藏 9
点赞数 6
分类专栏： 基础框架 文章标签： mybatis
于 2024-08-22 17:02:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_37583655/article/details/141432792
版权

Mybatis拦截器Interceptor与字段类型处理器BaseTypeHandler区别

MyBatis 的拦截器（Interceptor）和自定义类型处理器（BaseTypeHandler 的子类）在功能、使用场景、使用方式和注意事项等方面有以下区别。

TypeHandler是MyBatis中用于处理Java类型与JDBC类型之间转换的接口。在SQL语句执行过程中，无论是设置参数还是获取结果集，都需要通过TypeHandler进行类型转换。MyBatis提供了丰富的内置TypeHandler实现，以支持常见的数据类型转换。同时，也可以根据需要自定义TypeHandler来处理特殊的数据类型或转换逻辑。

MyBatis提供了一种插件(plugin)的功能，虽然叫做插件，但其实这是拦截器功能。MyBatis拦截器可以做的工作：SQL修改，分页操作，数据过滤，SQL执行时间性能监控等。

1. 功能区别

  1. 拦截器：

    • 主要用于拦截 MyBatis 的四大核心对象（Executor、StatementHandler、ParameterHandler、ResultSetHandler）的特定方法执行，实现对 SQL 执行过程的干预。
    • 可以在 SQL 执行的不同阶段进行操作，比如在执行 SQL 之前修改参数、在执行 SQL 之后处理结果等。

  2. 自定义类型处理器：

    • 用于处理特定 Java 类型与特定数据库类型之间的转换。
    • 专注于 Java 对象和数据库值之间的数据类型转换。

2. 使用场景

  1. 拦截器：

    • 日志记录：记录 SQL 执行的时间、参数和结果，以便进行性能分析和故障排查。
    • 缓存控制：实现自定义的缓存策略，提高查询性能。
    • 安全控制：在 SQL 执行前进行权限检查，防止未经授权的访问。
    • 动态 SQL 构建：根据特定条件动态修改 SQL 语句。

  2. 自定义类型处理器：

    • 处理数据库中不常见的数据类型或自定义数据类型与 Java 对象之间的转换。
    • 当 MyBatis 内置的类型处理器无法满足特定类型的转换需求时，例如处理特定格式的日期时间类型、自定义枚举类型等。

3. 原理分析

  1. 拦截器原理分析
    MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
ParameterHandler (getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)
概括一下,分别是拦截执行器、参数控制器、结果控制器、SQL语句构建控制器,对执行流程进行更改.对应四个对象.

  1. 字段类型处理器原理分析

自定义TypeHandler需要实现org.apache.ibatis.type.TypeHandler接口，或者继承org.apache.ibatis.type.BaseTypeHandler类，并重写相应的方法。

org.apache.ibatis.type.TypeHandler
TypeHandler是一个接口，用于定义如何处理JDBC类型和Java类型之间的转换。当你需要创建一个自定义的类型处理器时，通常需要实现这个接口。这个接口定义了以下主要方法：

setParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)：用于设置PreparedStatement对象的指定参数。
getResult(ResultSet rs, String columnName)：从结果集中根据列名获取数据。
getResult(ResultSet rs, int columnIndex)：从结果集中根据列索引获取数据。
getResult(CallableStatement cs, int columnIndex)：从存储过程的结果集中根据列索引获取数据。
这些方法分别负责在SQL语句执行时将Java类型的参数转换成JDBC类型，以及在执行SQL查询后将JDBC类型的结果转换成Java类型。

4. 使用方式

使用拦截器与BaseTypeHandler方式实现，将Java类型LocalDateTime（LocalDateTime默认纳秒9位，Time is represented to nanosecond precision.）转为MySQL类型timestamp。

  1. 拦截器：

    • 定义一个实现Interceptor接口的类，并使用@Intercepts注解指定要拦截的对象和方法。
    • 在 MyBatis 配置文件中注册拦截器，或者通过编程方式将拦截器添加到Configuration对象中。

    示例代码：

     import org.apache.ibatis.executor.Executor;
 import org.apache.ibatis.mapping.BoundSql;
 import org.apache.ibatis.mapping.MappedStatement;
 import org.apache.ibatis.plugin.Interceptor;
 import org.apache.ibatis.plugin.Intercepts;
 import org.apache.ibatis.plugin.Invocation;
 import org.apache.ibatis.plugin.Plugin;
 import org.apache.ibatis.plugin.Signature;
 import org.apache.ibatis.reflection.MetaObject;
 import org.apache.ibatis.reflection.SystemMetaObject;

 import java.lang.reflect.Field;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.Properties;

 @Intercepts({@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),
 	// @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class})
 })
 public class ParameterInterceptor implements Interceptor {

 	private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS");

 	@Override
 	public Object intercept(Invocation invocation) throws Throwable {
 		MappedStatement mappedStatement = (MappedStatement)invocation.getArgs()[0];
 		Object parameter = null;
 		BoundSql boundSql = mappedStatement.getBoundSql(parameter);

 		// 获取参数
 		if (invocation.getArgs().length > 1) {
 			parameter = invocation.getArgs()[1];
 		}

 		// 获取 MetaObject，用于反射操作
 		MetaObject metaObject = SystemMetaObject.forObject(parameter);

 		// 遍历所有字段
 		Field[] fields = parameter.getClass().getDeclaredFields();
 		for (Field field : fields) {
 			field.setAccessible(true);
 			Object fieldValue = metaObject.getValue(field.getName());
 			if (fieldValue instanceof LocalDateTime) {
 				LocalDateTime localDateTime = (LocalDateTime)fieldValue;
 				String formattedDate = localDateTime.format(FORMATTER);
 				metaObject.setValue(field.getName(), LocalDateTime.parse(formattedDate, FORMATTER));
 			}
 		}

 		// 继续执行原方法
 		return invocation.proceed();
 	}

 	@Override
 	public Object plugin(Object target) {
 		return Plugin.wrap(target, this);
 	}

 	/**
 	 * 处理配置文件中的参数
 	 *
 	 * @param properties 配置
 	 */
 	@Override
 	public void setProperties(Properties properties) {
 		Interceptor.super.setProperties(properties);
 	}

 }

    全局字段转换在mybatis-config.xml配置文件中注册：

    <configuration>
    <plugins>
        <plugin interceptor="your.package.MyInterceptor">
        </plugin>
    </plugins>
</configuration>

  2. 自定义类型处理器：

    • 继承BaseTypeHandler类，并实现其中的抽象方法，根据需要进行类型转换。
    • 使用@MappedJdbcTypes和@MappedTypes注解指定处理的 JDBC 类型和 Java 类型。
    • 在 MyBatis 配置文件中注册类型处理器，或者通过编程方式将其添加到Configuration对象中。

    示例代码：

     import org.apache.ibatis.type.BaseTypeHandler;
 import org.apache.ibatis.type.JdbcType;
 import org.apache.ibatis.type.MappedJdbcTypes;
 import org.apache.ibatis.type.MappedTypes;

 import java.sql.CallableStatement;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Timestamp;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;

 @MappedJdbcTypes(JdbcType.TIMESTAMP)
 @MappedTypes(LocalDateTime.class)
 public class LocalDateTimeTypeHandler extends BaseTypeHandler<LocalDateTime> {

   private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss.SSS");

   @Override
   public void setNonNullParameter(PreparedStatement preparedStatement, int i, LocalDateTime localDateTime, JdbcType jdbcType) throws SQLException {
 	String formattedDateTime = localDateTime.format(FORMATTER);
 	Timestamp timestamp = Timestamp.valueOf(formattedDateTime);
 	preparedStatement.setTimestamp(i, timestamp);
   }

   @Override
   public LocalDateTime getNullableResult(ResultSet resultSet, String columnName) throws SQLException {
 	Long timestamp = resultSet.getLong(columnName);
 	if (resultSet.wasNull()) {
 	  return null;
 	}
 	String timestampString = String.valueOf(timestamp);
 	return LocalDateTime.parse(timestampString, FORMATTER);
   }

   @Override
   public LocalDateTime getNullableResult(ResultSet resultSet, int columnIndex) throws SQLException {
 	Long timestamp = resultSet.getLong(columnIndex);
 	if (resultSet.wasNull()) {
 	  return null;
 	}
 	String timestampString = String.valueOf(timestamp);
 	return LocalDateTime.parse(timestampString, FORMATTER);
   }

   @Override
   public LocalDateTime getNullableResult(CallableStatement callableStatement, int columnIndex) throws SQLException {
 	Long timestamp = callableStatement.getLong(columnIndex);
 	if (callableStatement.wasNull()) {
 	  return null;
 	}
 	String timestampString = String.valueOf(timestamp);
 	return LocalDateTime.parse(timestampString, FORMATTER);
   }
 }

全局字段转换在mybatis-config.xml配置文件中注册：

<configuration>
    <typeHandlers>
        <typeHandler handler="your.package.LocalDateTimeTypeHandler"/>
    </typeHandlers>
</configuration>

或者SqlSessionFactory 全局配置SqlSessionFactory.setTypeHandlers(new LocalDateTimeTypeHandler());

mapper.xml配置，单个字段转换，单个字段转换：指定jdbcType、javaType与typeHandler

<result property="orderTime" column="order_time" typeHandler="your.package.LocalDateTimeTypeHandler"/>

或者
#{orderTime,typeHandler=your.package.LocalDateTimeTypeHandler}

5. 注意事项

  1. 拦截器：

    • 拦截器可能会影响性能，尤其是在频繁执行的 SQL 操作中，因为拦截器会增加额外的处理逻辑。
    • 谨慎使用拦截器，确保拦截的逻辑不会破坏 MyBatis 的正常执行流程。
    • 多个拦截器的执行顺序可能会影响结果，需要注意拦截器的注册顺序。

  2. 自定义类型处理器：

    • 确保类型处理器的正确性和稳定性，特别是在处理边界情况和异常情况时。
    • 不同的数据库对于特定类型的处理可能会有所不同，需要进行充分的测试以确保兼容性。
    • 如果可能，尽量使用 MyBatis 内置的类型处理器，只有在必要时才创建自定义类型处理器。

6. 参考资料

https://www.bookstack.cn/read/MyBatis-zh-3.4/typeHandlers
https://blog.csdn.net/qq_26664043/article/details/136358934
https://cloud.tencent.com/developer/article/2398586
https://developer.aliyun.com/article/1549764
https://baomidou.com/guides/type-handler/
https://blog.csdn.net/wb1046329430/article/details/111501755
https://www.cnblogs.com/Courage129/p/14121453.html

靖节先生
关注
  • 6
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis拦截器实现通用权限字段添加的方法
08-25
MyBatis拦截器实现通用权限字段添加的方法 MyBatis拦截器是一种非常实用的技术，可以用来实现各种复杂的数据库操作。本文将详细介绍如何使用MyBatis拦截器来实现通用权限字段添加，达到灵活、可靠、可维护的数据库...
MyBatis拦截器:给参数对象属性赋值的实例
08-30
MyBatis拦截器是MyBatis框架中的一种插件机制，允许用户自定义代码来扩展MyBatis的功能。在这个特定的实例中，我们讨论的是一个用于给参数对象属性赋值的拦截器。这个拦截器的主要目标是在执行增删改操作时，自动为...
mybatis拦截器自动填充公共字段
zslsh44的专栏
05-20 260
在开发的过程中 ，在持久化的过程中可能会遇到表中都有公共字段的问题，这样就可以统一赋值，更简化开发，比如说在新增用户需要指定创建时间、创建人等字段，修改用户时需要指定修改时间、修改人等字段，在mybatis配置文件中增加配置。
Mybatis——拦截器Interceptor
热门推荐
娜娜米的博客
05-08 3万+
本篇介绍Mybatis拦截器/插件相关知识，包括相关的类及作用、拦截器有哪几种、拦截器可以在Mybatis的执行过程中的哪些节点起作用、拦截器如何使用、相关的API，最后附上代码示例。
mybatis用拦截器实现字段加解密
Pluto372的博客
10-15 974
根据公司业务需要，灵活对客户敏感信息进行加解密，这里采用mybatis拦截器进行简单实现个demo。
Mybatis拦截器实现公共字段填充
最新发布
while(life)++；
07-17 459
基于springBoot+mybatis，三步完成。
MyBatis拦截器分页与动态修改SQL及其参数值
10-09
1. **MyBatis拦截器**：MyBatis提供了一种插件机制，即拦截器（Interceptor），它基于Java的动态代理，可以在SQL执行前或执行后进行干预。例如，我们可以创建一个自定义的拦截器，来实现特定的功能，如日志记录、...
Mybatis Interceptor 拦截器的实现
08-26
Mybatis Interceptor 拦截器的实现 Mybatis Interceptor 拦截器的实现是 Mybatis 框架中的一种重要机制，通过拦截器可以改变 Mybatis 的默认行为，例如 SQL 重写等。拦截器的实现主要基于责任链模式，通过动态代理...
Jmeter压测工具详解
靖节先生的博客
08-24 3万+
Apache JMetier是Apache组织开发的基于Java的压力测试工具。一款非常优秀的开源的性能测试工具。
Java操作MongoDB详解
靖节先生的博客
03-29 2万+
MongoDB详解1. MongoDB概述1.1 MongoDB简介1.2 MongoDB概念2. MongoDB安装2.1 MongoDB下载3. MongoDB操作4. MongoDB客户端工具5. MongoDB Java操作6. MongoDB集成SpringBoot 1. MongoDB概述 1.1 MongoDB简介 什么是MongoDB ? MongoDB 是由C++语言编写的，是一个基于分布式文件存储的开源数据库系统。 mongodb官网地址：https://www.mongodb.org.
Netty详解（持续更新中）
靖节先生的博客
12-20 1万+
Netty详解1. Netty概述1.1 Netty简介1.2 原生NIO问题1.3 Netty特点1.4 Netty应用场景1.3 Netty版本说明2. Java IO模型2.1 IO模型2.2 BIO,NIO,AIO适用场景3. Java BIO3.1 Java BIO 基本说明3.2 Java BIO 工作机制3.3 Java BIO 问题分析4. Java NIO4.1 Java NIO 基本说明4.2 NIO 和 BIO 的比较4.3 NIO 核心组件4.4 Selector（选择器）4.5 C
工作流引擎Activiti详解
靖节先生的博客
11-15 1万+
工作流引擎Activiti1. 什么是工作流1.1 工作流介绍1.2 工作流系统1.3 工作流实现方式1.4 工作流实现原理2. Activiti7概述2.1 Activiti介绍2.2 Activiti使用3. Activiti环境配置3.1 创建数据库3.2 初始化数据库表：3.3 创建数据库表3.4 数据库表命名规则4. Activiti架构简介5. Activiti入门案例5.1 流程定义5.2 部署流程5.3 启动流程5.4 流程定义查询5.5 流程定义删除5.6 流程定义资源查询 1. 什么是工
YML解析框架SnakeYaml简介
靖节先生的博客
01-25 1万+
YML解析框架SnakeYaml简介1. SnakeYaml概述1.1 yml简介1.2 SnakeYaml简介2. SnakeYaml实现验证2.1 snakeyml依赖2.2 snakeyml实现验证 1. SnakeYaml概述 1.1 yml简介 yaml简称yml，什么是yml，官方解释说，yml不是标记性语言，YAML 是一种人性化的数据序列化，适应所有编程语言的语言。 yml官网地址：https://yaml.org/ 1.2 SnakeYaml简介 SnakeYaml就是用于解析YAML，
流程编排框架LiteFlow详解
靖节先生的博客
11-15 1万+
流程编排框架LiteFlow详解1. 前言2. 概述3. LiteFlow框架的作用4. LiteFlow的设计原则5. LiteFlow不适用于场景6. LiteFlow适用场景7. LiteFlow相比于Flowable和Activiti8. 实现验证 1. 前言 在每个公司的系统中，总有一些拥有复杂业务逻辑的系统，这些系统承载着核心业务逻辑，几乎每个需求都和这些核心业务有关，这些核心业务业务逻辑冗长，涉及内部逻辑运算，缓存操作，持久化操作，外部资源调取，内部其他系统RPC调用等等。时间一长，项目几经易
Java定时任务调度框架
靖节先生的博客
04-14 1万+
Java定时任务调度框架1. 定时任务调度概述1.1 业务场景概述1.2 任务调度场景1.3 调度任务分类2. 定时任务调度详解2.1 Timer2.2 ScheduledExecutorService2.3 SpringTask2.4 Quartz2.5 xxl-job2.6 elastic-job 1. 定时任务调度概述 1.1 业务场景概述 日常开发中定时任务使用场景很多，比如支付系统每天凌晨定时清算对账；未支付订单超时回收；商品定时上下架等等。定时任务框架选择有很多，面对不同的业务场景可以选择不同的
JDK自带JVM分析工具详解
靖节先生的博客
03-22 1万+
JDK自带JVM分析工具详解1. JVM分析工具概述1.1 JVM分析工具简介1.2 JVM分析工具分类2. JVM分析工具详解2.1 idea环境配置2.2 jps2.3 jinfo2.4 jvisualvm2.5 jconsole2.6 jstat2.7 jstack2.8 jcmd2.9 jmap 1. JVM分析工具概述 1.1 JVM分析工具简介 在日常应用开发过程中对JVM状态指标等健康状况的分析是必不可少的操作，尤其是在出现一些内存，GC，线程等问题，JVM分析工具能够很好的帮助我们定位分析问
Java字节码框架ASM简介
靖节先生的博客
01-25 9087
Java字节码框架ASM简介1. ASM概述1.1 ASM简介1.2 ASM提供API1.3 ASM核心模块2. ASM应用2.1 ASM依赖2.2 代码实现2.3 测试验证 1. ASM概述 1.1 ASM简介 ASM 是一个通用的 Java 字节码操作和分析框架。一般用来动态生成类或者增强既有类的功能。也就是既可以创建class文件，也可以修改class文件。 ASM官网地址：https://asm.ow2.io/index.html 1.2 ASM提供API ASM提供了两种API Core API
Java基准测试工具JMH详解
靖节先生的博客
10-12 9010
Java基准测试工具JMH详解1.JMH简介1.1 JMH概念1.2 JMH与JMeter区别1.3 JMH注解说明2.JMH使用2.1 创建项目2.2 引入依赖2.3 启动异常解决2.4 JMH案例1 1.JMH简介 1.1 JMH概念 JMH is a Java harness for building, running, and analysing nano/micro/milli/macro benchmarks written in Java and other languages targett
mybatis拦截器修改字段
08-19
MyBatis拦截器可以用来修改SQL语句、参数或查询结果等。如果您想要在拦截器中修改字段，可以按照以下步骤进行： 1. 创建一个实现了`Interceptor`接口的类，该接口定义了拦截器的方法。例如： ```java public class MyInterceptor implements Interceptor { // 实现拦截逻辑 } ``` 2. 在拦截逻辑中，可以通过`Invocation`对象获取到执行的方法和参数等信息。其中，`Invocation`对象提供了`proceed()`方法来继续执行下一个拦截器或目标方法。可以使用该对象来修改字段。例如： ```java public Object intercept(Invocation invocation) throws Throwable { // 获取方法参数 Object[] args = invocation.getArgs(); // 修改字段逻辑 // ... // 继续执行下一个拦截器或目标方法 return invocation.proceed(); } ``` 3. 在MyBatis的配置文件中，将拦截器配置到对应的`<plugins>`标签中。例如： ```xml <plugins> <plugin interceptor="com.example.MyInterceptor"> <!-- 配置项 --> </plugin> </plugins> ``` 通过以上步骤，您可以在MyBatis拦截器中获取并修改字段。请注意，具体的实现方式可能因您的需求和环境而有所不同，以上仅为一般步骤的示例。请根据您的具体情况进行调整和实现。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值