在 Spring Boot 中为 MyBatis 添加拦截器

在 Spring Boot 中为 MyBatis 添加拦截器以实现分表查询涉及几个步骤。以下是如何在 Spring Boot 应用中配置和使用 MyBatis 拦截器的指南，具体以分表查询为例：

创建拦截器
首先，定义一个自定义的 MyBatis 拦截器，实现 Interceptor 接口。这个拦截器可以在 SQL 执行之前或之后修改 SQL 语句，进行分表查询的逻辑。

java 复制代码

import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;

import java.sql.Connection;
import java.util.Properties;

@Intercepts({
    @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class ShardingInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        // 获取 SQL 和参数
        String sql = statementHandler.getBoundSql().getSql();
        Object parameterObject = statementHandler.getBoundSql().getParameterObject();

        // 这里可以实现分表逻辑
        String newSql = modifySqlForSharding(sql, parameterObject);

        // 修改 SQL
        statementHandler.getBoundSql().setSql(newSql);

        // 继续执行
        return invocation.proceed();
    }

    private String modifySqlForSharding(String sql, Object parameterObject) {
        // 在这里实现分表逻辑，例如根据参数动态修改 SQL
        // 例如：
        // if (需要分表) {
        //     sql = sql.replace("原表名", "新表名");
        // }
        return sql;
    }

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

    @Override
    public void setProperties(Properties properties) {
        // 可以通过 properties 传入配置参数
    }
}

注册拦截器
在 Spring Boot 中，需要将自定义拦截器注册到 MyBatis 配置中。可以通过 MybatisConfiguration 配置类或在 application.yml 文件中进行配置。

使用 Java 配置类注册

java 复制代码

import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.boot.autoconfigure.ConfigurationCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisConfig {

    @Bean
    public ShardingInterceptor shardingInterceptor() {
        return new ShardingInterceptor();
    }

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

使用 application.yml 注册

在 application.yml 文件中，配置拦截器：

java 复制代码

mybatis:
  configuration:
    interceptors:
      - com.example.MyBatisConfig$ShardingInterceptor

分表查询逻辑

在 modifySqlForSharding 方法中实现具体的分表逻辑。这个方法根据实际需求对 SQL 语句进行修改，例如根据参数决定表的名称。
测试拦截器

确保拦截器正常工作，可以编写测试用例或者在应用中运行，观察 SQL 执行的结果是否符合预期的分表规则。

示例总结

以上步骤展示了如何在 Spring Boot 项目中实现和配置一个用于分表查询的 MyBatis 拦截器。通过自定义拦截器，你可以在 SQL 执行之前对 SQL 进行修改，以实现复杂的分表逻辑。