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

2024-08-23 05:20
文章标签 类型 区别 处理器 拦截器 mybatis interceptor basetypehandler

本文主要是介绍Mybatis拦截器Interceptor与字段类型处理器BaseTypeHandler区别，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

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

  • 1. 功能区别
  • 2. 使用场景
  • 3. 原理分析
  • 4. 使用方式
  • 5. 注意事项
  • 6. 参考资料

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");@Overridepublic 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();}@Overridepublic Object plugin(Object target) {return Plugin.wrap(target, this);}/*** 处理配置文件中的参数** @param properties 配置*/@Overridepublic 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");@Overridepublic 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);}@Overridepublic 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);}@Overridepublic 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);}@Overridepublic 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

这篇关于Mybatis拦截器Interceptor与字段类型处理器BaseTypeHandler区别的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1098463。

相关文章

MyBatis常用XML语法详解

MyBatis常用XML语法详解

《MyBatis常用XML语法详解》文章介绍了MyBatis常用XML语法,包括结果映射、查询语句、插入语句、更新语句、删除语句、动态SQL标签以及ehcache.xml文件的使用,感兴趣的朋友跟随小... 目录1、定义结果映射2、查询语句3、插入语句4、更新语句5、删除语句6、动态 SQL 标签7、ehc
阅读更多...
MyBatis延迟加载与多级缓存全解析

MyBatis延迟加载与多级缓存全解析

《MyBatis延迟加载与多级缓存全解析》文章介绍MyBatis的延迟加载与多级缓存机制,延迟加载按需加载关联数据提升性能,一级缓存会话级默认开启,二级缓存工厂级支持跨会话共享,增删改操作会清空对应缓... 目录MyBATis延迟加载策略一对多示例一对多示例MyBatis框架的缓存一级缓存二级缓存MyBat
阅读更多...
MySQL中VARCHAR和TEXT的区别小结

MySQL中VARCHAR和TEXT的区别小结

《MySQL中VARCHAR和TEXT的区别小结》MySQL中VARCHAR和TEXT用于存储字符串,VARCHAR可变长度存储在行内,适合短文本；TEXT存储在溢出页,适合大文本,下面就来具体的了解... 目录一、VARCHAR 和 TEXT 基本介绍1. VARCHAR2. TEXT二、VARCHAR
阅读更多...
mybatis直接执行完整sql及踩坑解决

mybatis直接执行完整sql及踩坑解决

《mybatis直接执行完整sql及踩坑解决》MyBatis可通过select标签执行动态SQL,DQL用ListLinkedHashMap接收结果,DML用int处理,注意防御SQL注入,优先使用#... 目录myBATiFBNZQs直接执行完整sql及踩坑select语句采用count、insert、u
阅读更多...
MyBatis Plus大数据量查询慢原因分析及解决

MyBatis Plus大数据量查询慢原因分析及解决

《MyBatisPlus大数据量查询慢原因分析及解决》大数据量查询慢常因全表扫描、分页不当、索引缺失、内存占用高及ORM开销,优化措施包括分页查询、流式读取、SQL优化、批处理、多数据源、结果集二次... 目录大数据量查询慢的常见原因优化方案高级方案配置调优监控与诊断总结大数据量查询慢的常见原因MyBAT
阅读更多...
MyBatis/MyBatis-Plus同事务循环调用存储过程获取主键重复问题分析及解决

MyBatis/MyBatis-Plus同事务循环调用存储过程获取主键重复问题分析及解决

《MyBatis/MyBatis-Plus同事务循环调用存储过程获取主键重复问题分析及解决》MyBatis默认开启一级缓存,同一事务中循环调用查询方法时会重复使用缓存数据,导致获取的序列主键值均为1,... 目录问题原因解决办法如果是存储过程总结问题myBATis有如下代码获取序列作为主键IdMappe
阅读更多...
python中getsizeof和asizeof的区别小结

python中getsizeof和asizeof的区别小结

《python中getsizeof和asizeof的区别小结》本文详细的介绍了getsizeof和asizeof的区别,这两个函数都用于获取对象的内存占用大小,它们来自不同的库,下面就来详细的介绍一下... 目录sys.getsizeof (python 内置)pympler.asizeof.asizeof
阅读更多...
MyBatis分页查询实战案例完整流程

MyBatis分页查询实战案例完整流程

《MyBatis分页查询实战案例完整流程》MyBatis是一个强大的Java持久层框架,支持自定义SQL和高级映射,本案例以员工工资信息管理为例,详细讲解如何在IDEA中使用MyBatis结合Page... 目录1. MyBATis框架简介2. 分页查询原理与应用场景2.1 分页查询的基本原理2.1.1 分
阅读更多...
MyBatis Plus实现时间字段自动填充的完整方案

MyBatis Plus实现时间字段自动填充的完整方案

《MyBatisPlus实现时间字段自动填充的完整方案》在日常开发中,我们经常需要记录数据的创建时间和更新时间,传统的做法是在每次插入或更新操作时手动设置这些时间字段,这种方式不仅繁琐,还容易遗漏,... 目录前言解决目标技术栈实现步骤1. 实体类注解配置2. 创建元数据处理器3. 服务层代码优化填充机制详
阅读更多...
mybatis映射器配置小结

mybatis映射器配置小结

《mybatis映射器配置小结》本文详解MyBatis映射器配置,重点讲解字段映射的三种解决方案（别名、自动驼峰映射、resultMap）,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定... 目录select中字段的映射问题使用SQL语句中的别名功能使用mapUnderscoreToCame
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2