Mybatis interceptor

MyBatis Interceptor 是 MyBatis 框架提供的一个扩展机制，用于在执行 SQL 语句前后进行拦截和处理。通过自定义 Interceptor，我们可以在 SQL 执行前后进行一些额外的逻辑操作，比如日志记录、权限校验、数据脱敏等。

要使用 MyBatis Interceptor，我们需要实现 org.apache.ibatis.plugin.Interceptor 接口，并重写其中的方法。其中最重要的方法是 intercept()，它会在执行 SQL 语句前后被调用。在该方法中，我们可以对传入的参数进行修改或者添加一些额外的逻辑。

另外，我们还需要使用 @Intercepts 注解来标记我们自定义的 Interceptor 类，并指定要拦截的方法和参数类型。

以下是一个简单的示例，演示了如何自定义一个 MyBatis Interceptor：

@Intercepts({

相关问题

mybatis Interceptor 使用

MyBatis的Interceptor是用于在执行SQL语句前后添加额外的操作的一种插件机制，它允许你在执行Mapper方法之前或之后执行自定义逻辑。在MyBatis中，Interceptors主要用于日志记录、事务管理、性能统计等场景。

以下是使用MyBatis Interceptor的基本步骤：

1. **创建Interceptor**：
首先，你需要创建一个实现`com.ibatis.common.jdbc.Interceptor`接口的类。这个接口有两个核心方法：
- `preparedStatementHandler`：在PreparedStatement被调用处理之前执行，此时可以访问到PreparedStatement。
- `postStatementHandler`：在PreparedStatement处理完成之后执行，可以检查结果集并进行后续处理。

import com.ibatis.common.jdbc.preparedStatementHandler.PreparedStatementHandler;
import org.apache.ibatis.logging.Log;
import org.apache.ibatis.logging.LogFactory;

public class MyInterceptor implements Interceptor {

    private static final Log LOGGER = LogFactory.getLog(MyInterceptor.class);

    @Override
    public Object statementHandler(PreparedStatementHandler preparedStatementHandler) {
        // 在执行PreparedStatement之前做些什么
        LOGGER.info("Before executing SQL...");
        Object result = preparedStatementHandler.statementHandler();
        // 执行完毕后可以进一步处理
        LOGGER.info("After executing SQL...");
        return result;
    }

    @Override
    public Object preHandle(Object parameter) {
        // 在Mapper方法执行前做些什么
        return null;
    }

    @Override
    public Object postHandle(Object resultObject, Object parameter, Object target) {
        // 在Mapper方法执行后做些什么
        return resultObject;
    }

    @Override
    public void setProperties(Properties properties) {
        // 可能需要设置一些配置项
    }
}

2. **配置Interceptor**：
将你的Interceptor添加到MyBatis的配置文件中，通常是通过`<plugins>`标签配置：

<configuration>
    <plugins>
        <plugin interceptor="com.example.MyInterceptor"/>
    </plugins>
</configuration>

或者在Java配置中：

SqlSessionFactory sqlSessionFactory = ...;
sqlSessionFactory.getConfiguration().addInterceptor(new MyInterceptor());

3. **使用Intercepted Statement**：
开始使用你的Interceptor拦截的Mapper方法，它们将会在你自定义的回调方法中被执行。

注意：在编写Interceptor时要确保遵守线程安全原则，并且尽量减少对业务逻辑的影响。

springboot mybatis interceptor

### 如何在 Spring Boot 中使用 MyBatis 拦截器

#### 添加依赖
为了在 Spring Boot 项目中使用 MyBatis 拦截器，首先需要添加必要的 Maven 或 Gradle 依赖。对于 MyBatis 和 Spring Boot 的集成，可以添加如下依赖：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>最新版本号</version>
</dependency>

这一步骤确保了 MyBatis 可以与 Spring Boot 正常工作[^1]。

#### 自定义拦截器实现
创建一个自定义的 MyBatis 拦截器可以通过继承 `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})
})
public class ShardingInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 获取原始参数
        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        Object parameterObject = invocation.getArgs()[1];

        // 修改 SQL 语句或其他操作...
        
        return invocation.proceed();
    }

    @Override
    public void setProperties(Properties properties) {}

}

此代码片段展示了如何通过 `@Intercepts` 注解指定要拦截的目标对象及其方法，并实现了 `intercept()` 方法来进行具体的业务处理逻辑[^4]。

#### 配置拦截器
为了让 MyBatis 使用这个新创建的拦截器，在应用程序配置文件 (`application.properties`) 中加入以下设置:

mybatis.configuration.interceptors=com.example.yourpackage.ShardingInterceptor

这样就完成了对 MyBatis 拦截器的基本配置和应用。