大家好,又见面了,我是你们的朋友全栈君。
文章目录
- 1. 基础介绍
- 1.1. 核心对象
- 1.2. 执行过程
- 2. 实现步骤
- 2.1. 添加注解
- 2.1.1. type
- 2.1.2. method
- 2.1.3. args
- 2.2. 方法实现
- 2.2.1. intercept
- 2.2.2. plugin
- 2.2.3. setProperties
- 2.1. 添加注解
- 3. 代码示例
MyBatis
拦截器可以做的工作:SQL
修改,分页操作,数据过滤,SQL
执行时间性能监控等。
1. 基础介绍
1.1. 核心对象
从MyBatis
代码实现的角度来看,MyBatis
的主要的核心部件有以下几个:
Configuration
:初始化基础配置,比如MyBatis
的别名等,一些重要的类型对象,如插件,映射器,ObjectFactory
和typeHandler
对象,MyBatis
所有的配置信息都维持在Configuration
对象之中。SqlSessionFactory
:SqlSession
工厂。SqlSession
:作为MyBatis
工作的主要顶层API
,表示和数据库交互的会话,完成必要的数据库增删改查功能。Executor
:MyBatis
的内部执行器,它负责调用StatementHandler
操作数据库,并把结果集通过ResultSetHandler
进行自动映射,另外,它还处理二级缓存的操作。StatementHandler
:MyBatis
直接在数据库执行SQL
脚本的对象。另外它也实现了MyBatis
的一级缓存。ParameterHandler
:负责将用户传递的参数转换成JDBC Statement
所需要的参数。是MyBatis
实现SQL
入参设置的对象。ResultSetHandler
:负责将JDBC
返回的ResultSet
结果集对象转换成List
类型的集合。是MyBatis
把ResultSet
集合映射成POJO
的接口对象。TypeHandler
:负责Java
数据类型和JDBC
数据类型之间的映射和转换。MappedStatement
:MappedStatement
维护了一条<select|update|delete|insert>
节点的封装。SqlSource
:负责根据用户传递的parameterObject
,动态地生成SQL
语句,将信息封装到BoundSql
对象中,并返回。BoundSql
:表示动态生成的SQL
语句以及相应的参数信息。
1.2. 执行过程
2. 实现步骤
- 写一个实现
org.apache.ibatis.plugin.Interceptor
接口的拦截器类,并实现其中的方法。 - 添加
@Intercepts
注解,写上需要拦截的对象和方法,以及方法参数。 Spring
项目注意添加@Component
注解即可,使其成为Spring
管理的一个Bean
。
2.1. 添加注解
MyBatis
拦截器默认可以拦截的类型只有四种,即四种接口类型Executor
、StatementHandler
、ParameterHandler
和ResultSetHandler
。对于我们的自定义拦截器必须使用MyBatis
提供的@Intercepts
注解来指明我们要拦截的是四种类型中的哪一种接口。
注解 | 描述 |
---|---|
@Intercepts | 标志该类是一个拦截器 |
@Signature | 指明该拦截器需要拦截哪一个接口的哪一个方法 |
@Signature
注解的参数:
参数 | 描述 |
---|---|
type | 四种类型接口中的某一个接口,如Executor.class。 |
method | 对应接口中的某一个方法名,比如Executor的query方法。 |
args | 对应接口中的某一个方法的参数,比如Executor中query方法因为重载原因,有多个,args就是指明参数类型,从而确定是具体哪一个方法。 |
@Intercepts({
@Signature(type = Executor.class, method = "query", args = {
MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
@Signature(type = StatementHandler.class, method = "prepare", args = {
Connection.class, Integer.class}),
@Signature(type = ParameterHandler.class, method = "setParameters", args = {
PreparedStatement.class}),
@Signature(type = ResultSetHandler.class, method = "handleResultSets", args = {
Statement.class})
})
2.1.1. type
MyBatis
拦截器默认会按顺序拦截以下的四个接口中的所有方法:
org.apache.ibatis.executor.Executor //拦截执行器方法
org.apache.ibatis.executor.statement.StatementHandler //拦截SQL语法构建处理
org.apache.ibatis.executor.parameter.ParameterHandler //拦截参数处理
org.apache.ibatis.executor.resultset.ResultSetHandler //拦截结果集处理
具体是拦截这四个接口对应的实现类:
代码语言:javascript复制org.apache.ibatis.executor.CachingExecutor
org.apache.ibatis.executor.statement.RoutingStatementHandler
org.apache.ibatis.scripting.defaults.DefaultParameterHandler
org.apache.ibatis.executor.resultset.DefaultResultSetHandler
2.1.2. method
这个可以根据MyBatis
源码了解下。
2.1.3. args
根据参数类型区分重载的方法。
2.2. 方法实现
2.2.1. intercept
进行拦截的时候要执行的方法。该方法参数Invocation
类中有三个字段:
private final Object target;
private final Method method;
private final Object[] args;
可通过这三个字段分别获取下面的信息:
代码语言:javascript复制Object target = invocation.getTarget();//被代理对象
Method method = invocation.getMethod();//代理方法
Object[] args = invocation.getArgs();//方法参数
拦截接口 | 接口实现类 |
---|---|
Executor | CachingExecutor |
StatementHandler | RoutingStatementHandler |
ParameterHandler | DefaultParameterHandler |
ResultSetHandler | DefaultResultSetHandler |
2.2.2. plugin
插件用于封装目标对象的,通过该方法我们可以返回目标对象本身,也可以返回一个它的代理,可以决定是否要进行拦截进而决定要返回一个什么样的目标对象,官方提供了示例:return Plugin.wrap(target, this);
,可以在这个方法中提前进行拦截对象类型判断,提高性能:
@Override
public Object plugin(Object target) {
//只对要拦截的对象生成代理
if(target instanceof StatementHandler){
//调用插件
return Plugin.wrap(target, this);
}
return target;
}
MyBatis
拦截器用到责任链模式 动态代理 反射机制;
所有可能被拦截的处理类都会生成一个代理类,如果有N
个拦截器,就会有N
个代理,层层生成动态代理是比较耗性能的。而且虽然能指定插件拦截的位置,但这个是在执行方法时利用反射动态判断的,初始化的时候就是简单的把拦截器插入到了所有可以拦截的地方。所以尽量不要编写不必要的拦截器。另外我们可以在调用插件的地方添加判断,只要是当前拦截器拦截的对象才进行调用,否则直接返回目标对象本身,这样可以减少反射判断的次数,提高性能。
2.2.3. setProperties
如果我们拦截器需要用到一些变量参数,而且这个参数是支持可配置的,类似Spring
中的@Value("${}")
从application.properties
文件获取自定义变量属性,这个时候我们就可以使用这个方法。
(1)在application.properties
文件中添加配置:
mybatis.config-location=classpath:mybatis-config.xml
(2)在resources
目录下添加mybatis-config.xml
配置文件,并添加插件和属性配置。添加完需要注意去掉自定义MyBatis
拦截器上的@Component
注解,否则该拦截器相当于注册了两个,会执行两遍拦截方法。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<plugins>
<plugin interceptor="com.example.demo.mapper.plugin.MyPlugin">
<property name="key1" value="value1"/>
<property name="key2" value="value2"/>
<property name="key3" value="value3"/>
</plugin>
</plugins>
</configuration>
(3)在拦截器插件的setProperties
方法中进行。这些自定义属性参数会在项目启动的时候被加载。
@Override
public void setProperties(Properties properties) {
System.out.println("key1=" properties.getProperty("key1"));
System.out.println("key2=" properties.getProperty("key2"));
System.out.println("key3=" properties.getProperty("key3"));
}
3. 代码示例
代码语言:javascript复制package com.example.demo.mapper.plugin;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import java.lang.reflect.Method;
import java.sql.Connection;
import java.util.Properties;
@Intercepts({
@Signature(type = StatementHandler.class, method = "prepare", args = {
Connection.class, Integer.class})
})
public class MyPlugin implements Interceptor {
Properties properties = null;
/** * 拦截方法逻辑 * 这里主要是通过反射去获取要执行的SQL相关信息,然后进行操作 */
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object target = invocation.getTarget();//被代理对象
Method method = invocation.getMethod();//代理方法
Object[] args = invocation.getArgs();//方法参数
// do something ...... 方法拦截前执行代码块
Object result = invocation.proceed();
// do something .......方法拦截后执行代码块
return result;
}
/** * 生成MyBatis拦截器代理对象 */
@Override
public Object plugin(Object target) {
if(target instanceof StatementHandler){
//调用插件
return Plugin.wrap(target, this);
}
return target;
}
/** * 设置插件属性(直接通过Spring的方式获取属性,所以这个方法一般也用不到) * 项目启动的时候数据就会被加载 */
@Override
public void setProperties(Properties properties) {
//赋值成员变量,在其他方法使用。
this.properties = properties;
}
}
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/195539.html原文链接:https://javaforall.cn