MyBatis拦截器原理探究-白红宇

MyBatis拦截器原理探究

阅读量：670 次

发布时间：2019-03-16

本文共 3618 字，大约阅读时间需要 12 分钟。

MyBatis 拦截器介绍

MyBatis 提供了一个强大的插件系统，允许开发者在特定的执行点进行拦截调用。虽然这个功能被称为插件，但它实际上是一个非常强大的拦截器功能。拦截器可以拦截 MyBatis 中的多个关键操作，包括但不限于以下内容：

1. 拦截的目标

拦截器拦截以下关键接口中的方法：

Executor 接口：包括 update、query、commit、rollback 等方法。这些方法通常用于执行数据库操作。

ParameterHandler 接口：拦截数据参数的处理，主要涉及 getParameterObject 和 setParameters 方法。

ResultSetHandler 接口：拦截结果集的处理，主要涉及 handleResultSets 和 handleOutputParameters 方法。

StatementHandler 接口：拦截 SQL 语法构建的相关操作，包括 prepare、parameterize、batch、update 和 query 方法。

这些拦截器可以用于各种场景，例如数据带入、结果集处理、事务管理等。

2. 拦截器的使用

2.1 拦截器接口定义

MyBatis 的拦截器接口定义为：

public interface Interceptor {    Object intercept(Invocation invocation) throws Throwable;    Object plugin(Object target);    void setProperties(Properties properties);}

拦截器接口只有三个方法：

intercept(Invocation invocation)：拦截具体的方法调用。

plugin(Object target)：对目标进行适配处理。

setProperties(Properties properties)：设置拦截器的属性。

2.2 拦截器配置

全局配置中，可以通过 XML 或注解的方式注册拦截器。例如，以下是 MyBatis 的一个拦截器示例：

@Intercepts({@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})}public class ExamplePlugin implements Interceptor {    public Object intercept(Invocation invocation) throws Throwable {        return invocation.proceed();    }    public Object plugin(Object target) {        return Plugin.wrap(target, this);    }    public void setProperties(Properties properties) {}}

在 XML 配置中，拦截器可以通过如下方式添加：

2.3 拦截器的实现

拦截器的核心逻辑通常在 plugin 方法中实现。例如，在上面的示例中，plugin 方法使用了 Plugin.wrap(target, this) 来创建一个动态代理，这样可以在拦截器激活时对目标进行适配。

3. 拦截器的内部工作原理

3.1 配置解析

MyBatis 在解析 XML 配置时，会调用 pluginElement 方法处理拦截器配置。解析逻辑如下：

private void pluginElement(XNode parent) throws Exception {    for (XNode child : parent.getChildren()) {        String interceptor = child.getStringAttribute("interceptor");        Properties properties = child.getChildrenAsProperties();        Interceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();        interceptorInstance.setProperties(properties);        configuration.addInterceptor(interceptorInstance);    }}

3.2 拦截器链

拦截器链位于 Configuration 类中，负责协调多个拦截器的运行。拦截器链的主要功能包括：

遍历所有注册的拦截器。

调用每个拦截器的 plugin 方法对目标进行处理。

3.3 方法创建与拦截

MyBatis 在创建 Executor、ParameterHandler、ResultSetHandler 和 StatementHandler 时，会调用拦截器链的 pluginAll 方法：

parameterHandler = newParameterHandler(...)

resultSetHandler = newResultSetHandler(...)

statementHandler = newStatementHandler(...)

executor = newExecutor(...)

这些方法在执行时都会传递给拦截器链，进行插件处理。

4. 通过代码实现拦截

MyBatis 拦截器的实现可以通过反射和动态代理实现。Plugin.wrap(target, interceptor) 方法会生成一个动态代理，代理委托拦截器的 intercept 方法进行处理。

对于 StatementHandler 的拦截，可以实现如下逻辑：

public Object plugin(Object target) {    return Plugin.wrap(target, new Plugin() {        public Object intercept(Invocation invocation) throws Throwable {            // 自定义 SQL 语句处理逻辑            return invocation.proceed();        }    });}

源码解析

4.1 插件代理

Plugin.wrap 方法通过动态代理技术创建一个代理实例，核心逻辑包括：

获取拦截器的签名信息（通过 getSignatureMap 方法）。

根据目标实例的类型与签名信息生成代理。

创建一个动态代理，代理调用目标实例的方法。

4.2 签名信息处理

getSignatureMap 方法用于解析拦截器的 @Intercepts 和 @Signature 注解，返回一个映射，记录每个接口和方法的签名。

4.3 动态代理

动态代理的 invoke 方法实现了拦截逻辑：

public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {    try {        Set
   
     methods = signatureMap.get(method.getDeclaringClass());        if (methods != null && methods.contains(method)) {            return interceptor.intercept(new Invocation(target, method, args));        } else {            return method.invoke(target, args);        }    } catch (Exception e) {        throw ExceptionUtil.unwrapThrowable(e);    }}