mybatisplus 通过自定义拦截器更改sql代码

在 MyBatis-Plus 中，如果你需要通过拦截器来更改 SQL 代码，可以通过实现自定义的 MyBatis 拦截器插件来完成。MyBatis 插件机制允许你在执行 SQL 语句之前或之后对 SQL 语句进行处理，包括修改 SQL 语句。下面是如何实现一个自定义的 MyBatis 拦截器插件来更改 SQL 代码的步骤。

1. 添加 MyBatis-Plus 和 MyBatis 依赖

首先，确保你的项目中包含了 MyBatis-Plus 和 MyBatis 的相关依赖。如果使用 Maven，可以在 pom.xml 中添加：

    com.baomidou
    mybatis-plus-core
    3.5.1


    org.mybatis
    mybatis
    3.5.11

如果使用 Gradle，可以在 build.gradle 中添加：

implementation 'com.baomidou:mybatis-plus-core:3.5.1' // 使用最新版本
implementation 'org.mybatis:mybatis:3.5.11' // 使用最新版本

2. 创建自定义拦截器插件

MyBatis 插件需要实现 Interceptor 接口。以下是一个简单的示例拦截器插件，它会修改 SQL 语句：

import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Plugin;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.reflection.MetaObject;

import java.sql.Statement;
import java.util.Properties;

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

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 获取 StatementHandler 对象
        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        MetaObject metaObject = MetaObject.forObject(statementHandler);

        // 获取 SQL 语句
        String originalSql = (String) metaObject.getValue("delegate.boundSql.sql");
        System.out.println("Original SQL: " + originalSql);

        // 修改 SQL 语句
        String modifiedSql = originalSql + " /* Custom Comment */";
        metaObject.setValue("delegate.boundSql.sql", modifiedSql);

        // 执行修改后的 SQL 语句
        return invocation.proceed();
    }

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

    @Override
    public void setProperties(Properties properties) {
        // 设置插件属性
    }
}
3. 注册拦截器插件

你需要在 MyBatis 配置中注册自定义拦截器插件。可以在 MybatisPlusConfig 配置类中注册插件：

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

@Configuration
public class MybatisPlusConfig {

    @Bean
    public CustomSqlInterceptor customSqlInterceptor() {
        return new CustomSqlInterceptor();
    }

    @Bean
    public MybatisPlusProperties mybatisPlusProperties() {
        MybatisPlusProperties properties = new MybatisPlusProperties();
        // 配置插件
        properties.getGlobalConfig().getSqlInjector().setSqlInterceptor(customSqlInterceptor());
        return properties;
    }
}

4. 测试插件

确保你已经配置了正确的 DataSource 和 SqlSessionFactory，然后运行你的应用，执行相关的 SQL 操作，查看控制台输出，应该能够看到修改后的 SQL 语句。

注意事项

1. 性能影响：自定义插件可能会影响性能，特别是当插件处理大量 SQL 语句时。因此，使用时应注意性能影响。

2. 插件冲突：如果你使用了多个插件，确保它们之间没有冲突，特别是在 SQL 修改方面。

3. 日志记录：在开发和调试阶段，可以通过日志记录插件的操作，以帮助排查问题。

通过以上步骤，你可以创建一个自定义的 MyBatis 拦截器插件，修改 SQL 语句。根据你的需求，可以在插件中实现更复杂的逻辑。