MyBatis拦截器(Interceptor)的理解与实践

IT_陈寒

发布于 2025-06-01 12:44:24

2K0

在MyBatis中，拦截器（Interceptor）是一种强大的机制，它允许开发者在执行SQL语句或处理结果集的过程中介入，并且可以进行自定义的处理逻辑。本文将深入探讨MyBatis拦截器的基本概念、工作原理，以及如何在实际项目中应用拦截器来解决常见问题和优化性能。

1. 什么是MyBatis拦截器？

MyBatis拦截器是一种基于Java反射机制和动态代理的插件，用于拦截MyBatis的方法调用。它允许开发者在SQL语句执行前后、结果集处理前后等关键节点进行拦截，并在拦截器中编写自定义逻辑。主要作用包括但不限于：

SQL语句重写、增强或修改；
对参数进行加工；
对结果集进行加工；
统计SQL执行时间；
实现分页、缓存等通用功能。

2. 拦截器的基本原理

MyBatis拦截器基于Java的动态代理机制实现。当执行MyBatis的方法时，实际上是调用了代理对象的方法。拦截器通过实现Interceptor接口，并覆盖其中的intercept方法，实现对目标对象方法的拦截和增强。主要涉及的核心类和接口包括：

Interceptor：拦截器接口，定义了拦截和处理逻辑；
Invocation：方法调用对象，包含了目标方法、参数等信息；
Plugin：MyBatis提供的工具类，用于生成代理对象并应用拦截器。

3. 编写自定义拦截器

接下来，我们将通过一个实际的示例来展示如何编写和配置自定义拦截器，并说明其实现的功能和作用。

3.1 示例：实现SQL执行时间统计拦截器

我们编写一个拦截器，用于统计每个SQL语句的执行时间。首先，创建一个实现Interceptor接口的拦截器类：

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;

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})
})
public class SqlExecuteTimeInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = invocation.proceed();
        long endTime = System.currentTimeMillis();
        long timeElapsed = endTime - startTime;

        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        String sqlId = mappedStatement.getId();
        System.out.println("执行SQL【" + sqlId + "】耗时：" + timeElapsed + "ms");

        return result;
    }

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

    @Override
    public void setProperties(Properties properties) {
        // 可以配置拦截器的属性
    }
}

3.2 配置拦截器

在MyBatis的配置文件（例如mybatis-config.xml或者Spring Boot中的配置类）中配置该拦截器：

<plugins>
    <plugin interceptor="com.example.interceptor.SqlExecuteTimeInterceptor">
        <!-- 这里可以配置拦截器的属性 -->
    </plugin>
</plugins>

或者在Spring Boot中，通过配置类来注入拦截器：

@Configuration
@MapperScan("com.example.mapper")
public class MyBatisConfig {

    @Bean
    public SqlExecuteTimeInterceptor sqlExecuteTimeInterceptor() {
        return new SqlExecuteTimeInterceptor();
    }

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return configuration -> configuration.addInterceptor(sqlExecuteTimeInterceptor());
    }
}