mybatis plus拦截器给查询语句添加额外的判断条件

mybatis拦截器,给所有的mybatis plus中的条件构造器对象添加一个条件。

由于数据库一开始没有设置字段项目Id,后面再添加的项目id,代码又写了很多,一个个去添加修改,不太现实,容易出现错漏,于是添加如下拦截器。

想要能够使用该拦截器,必须DAO实体中有指定参数,我指定的参数就是项目id,
还需要Mapper extends BaseMapper,mapper继承了之后才有用,再到使用LambdaQueryWrapper,必须是走条件构造器(这里可以自己改动代码,变成自己写的sql也能进来),这时候你的查询sql就会默认进入这个拦截器(我这里只处理的查询,外面还判断了只有查询才能进入)。

这个项目id是从请求头中获取,放入了ThreadLocal中,如果做法不同的话,你就需要自己想办法获取到这个参数信息,并填入119行了。

其实代码本质上就是拦截所有的sql,判断是查询,就往下走,反射获取实体类,判断有没有对应的参数,如果有,继续往下走,判断是否能获取到要额外添加的查询参数,如果有就继续,将这个参数,塞入对应的sql中。

package com.bs.common.config;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import lombok.AllArgsConstructor;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import net.sf.jsqlparser.JSQLParserException;
import net.sf.jsqlparser.expression.Alias;
import net.sf.jsqlparser.expression.StringValue;
import net.sf.jsqlparser.expression.operators.conditional.AndExpression;
import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
import net.sf.jsqlparser.parser.CCJSqlParserManager;
import net.sf.jsqlparser.parser.CCJSqlParserUtil;
import net.sf.jsqlparser.schema.Column;
import net.sf.jsqlparser.schema.Table;
import net.sf.jsqlparser.statement.select.PlainSelect;
import net.sf.jsqlparser.statement.select.Select;
import net.sf.jsqlparser.statement.select.SelectBody;

import net.sf.jsqlparser.statement.select.SetOperationList;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.*;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.plugin.Intercepts;
import org.apache.ibatis.plugin.Invocation;
import org.apache.ibatis.plugin.Signature;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.SystemMetaObject;
import org.springframework.stereotype.Component;

import java.io.StringReader;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.sql.Connection;
import java.util.List;

/**
 * mybatis拦截器
 *
 * @author 汪彪
 * @date 2023年08月02日
 */
@Slf4j
@AllArgsConstructor
@Intercepts({
        @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
@Component
public class MybatisProjectInterceptor implements Interceptor {

    private static final String PROJECT_ID = "projectId";

    public static final String PROJECT_ID_DATA_PARAM = "project_id";

    @Override
    public Object intercept(Invocation invocation) throws Throwable {

        StatementHandler statementHandler = (StatementHandler) invocation.getTarget();
        MetaObject metaObject = SystemMetaObject.forObject(statementHandler);
        MappedStatement mappedStatement = (MappedStatement) metaObject.getValue("delegate.mappedStatement");

        //跳过非查询接口,只处理查询的接口
        if (!SqlCommandType.SELECT.equals(mappedStatement.getSqlCommandType())) {
            return invocation.proceed();
        }

        // 获取到mapper的信息
        String resource = mappedStatement.getResource();
        //判断是否是单表查询
        if (resource.contains(".java")) {
            return handleMybatisPlusSql(resource, invocation , metaObject);
        }

        return invocation.proceed();
    }

    /**
     * 处理单表查询的sql语句
     *
     * @param resource
     * @param invocation
     * @param metaObject
     * @author 汪彪
     * @date 2023/8/7 14:19
     **/
    private Object handleMybatisPlusSql(String resource, Invocation invocation, MetaObject metaObject) throws Exception {
        String substring = resource.substring(0, resource.indexOf("."));
        String replace = substring.replace("/", ".");
        Class<?> mapperClass = Class.forName(replace);
        if (BaseMapper.class.isAssignableFrom(mapperClass)) {
            //获取带泛型的父接口
            Type[] interfaces = mapperClass.getGenericInterfaces();
            Type anInterface = interfaces[0];
            ParameterizedType paramType = (ParameterizedType) anInterface;

            //获取父接口的泛型
            Type[] actualTypeArguments = paramType.getActualTypeArguments();
            Class<?> targetClass = (Class<?>) actualTypeArguments[0];

            //判断参数是否包含projectId
            Field projectId = null;
            try {
                projectId = targetClass.getDeclaredField(PROJECT_ID);
            } catch (Exception ignored) {
            }
            if (projectId == null) {
                return invocation.proceed();
            }

            //特殊处理SysSubUser
            if (targetClass.getName().contains("SysSubUser")||targetClass.getName().contains("EngWarningPushRecord")||targetClass.getName().contains("EngWarningPush")){
                return invocation.proceed();
            }

            //获取项目id
            Integer projectIdValue = null;
            try {
                projectIdValue = GengraLcontextHolder.getProjectId();
            } catch (Exception e) {
                return invocation.proceed();
            }

            //给sql添加条件
            String originalSql = (String) metaObject.getValue("delegate.boundSql.sql");
            String sql = handleSql(originalSql, PROJECT_ID_DATA_PARAM, projectIdValue.toString());
            metaObject.setValue("delegate.boundSql.sql", sql);
        } else {
            //父接口不是baseMapper,并非使用的mybatis-plus
            return invocation.proceed();
        }
        return invocation.proceed();
    }

    /**
     * 处理sql语句
     *
     * @param originalSql
     * @param key
     * @param value
     * @date 2023/8/7 14:17
     **/
    private String handleSql(String originalSql, String key, String value) throws JSQLParserException {
        CCJSqlParserManager parserManager = new CCJSqlParserManager();
        //处理select语句
        Select select = (Select) parserManager.parse(new StringReader(originalSql));
        SelectBody selectBody = select.getSelectBody();
        if (selectBody instanceof PlainSelect) {
            this.setWhere((PlainSelect) selectBody, key, value);
        } else if (selectBody instanceof SetOperationList) {
            SetOperationList setOperationList = (SetOperationList) selectBody;
            List<SelectBody> selectBodyList = setOperationList.getSelects();
            selectBodyList.forEach(s -> this.setWhere((PlainSelect) s, key, value));
        }
        return select.toString();
    }

    /**
     * 处理查询条件
     *
     * @param plainSelect
     * @param key
     * @param value
     * @date 2023/8/7 14:16
     **/
    @SneakyThrows(Exception.class)
    protected void setWhere(PlainSelect plainSelect, String key, String value) {
        Table fromItem = (Table) plainSelect.getFromItem();
        // 有别名用别名,无别名用表名,防止字段冲突报错
        Alias fromItemAlias = fromItem.getAlias();
        String mainTableName = fromItemAlias == null ? fromItem.getName() : fromItemAlias.getName();
        // 构建子查询 -- 数据权限过滤SQL
        String dataPermissionSql = "";

        EqualsTo selfEqualsTo = new EqualsTo();
        selfEqualsTo.setLeftExpression(new Column(mainTableName + "." + key));
        selfEqualsTo.setRightExpression(new StringValue(value));
        dataPermissionSql = selfEqualsTo.toString();

        //添加where语句
        if (plainSelect.getWhere() == null) {
            plainSelect.setWhere(CCJSqlParserUtil.parseCondExpression(dataPermissionSql));
        } else {
            plainSelect.setWhere(new AndExpression(plainSelect.getWhere(), CCJSqlParserUtil.parseCondExpression(dataPermissionSql)));
        }
    }
}

  • 3
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
### 回答1: MyBatis-Plus是基于MyBatis的增强工具库,它提供了一系列的功能增强,其中就包括拦截器拦截器MyBatis执行SQL语句时的一个重要环节,可以在执行SQL语句之前或之后对语句进行处理,实现自定义逻辑。 MyBatis-Plus的拦截器可以使用自定义的逻辑来实现添加where条件的功能。具体操作如下: 1.实现自定义的Interceptor拦截器类,并覆盖该类的intercept()方法。 2.在该方法中通过Invocation对象获取当前的MappedStatement、BoundSql和参数列表等对象。 3.根据当前的MappedStatement对象获取到对应的SQL语句,并在该SQL语句的后面添加where条件。 4.创建新的BoundSql对象,将修改过的SQL语句和参数列表注入到BoundSql对象中。 5.通过反射将修改后的BoundSql对象覆盖原有的BoundSql对象。 6.最后将Invocation对象返回即可。 示例代码如下: public class MyInterceptor implements Interceptor { @Override public Object intercept(Invocation invocation) throws Throwable { MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0]; Object parameter = invocation.getArgs()[1]; BoundSql boundSql = mappedStatement.getBoundSql(parameter); String sql = boundSql.getSql(); // 在该SQL语句的后面添加where条件 sql = sql + " where 1=1"; BoundSql newBoundSql = new BoundSql(mappedStatement.getConfiguration(), sql, boundSql.getParameterMappings(), parameter); // 利用反射将新的BoundSql对象覆盖原有的BoundSql对象 Field field = boundSql.getClass().getDeclaredField("sql"); field.setAccessible(true); field.set(boundSql, newBoundSql.getSql()); return invocation.proceed(); } } 上述代码中的where条件为固定值"where 1=1",你可以根据需要修改为具体的条件。同时,我们也可以使用更加灵活的方式进行拦截器的使用和注入。例如,在MyBatis的配置文件中添加以下配置: <plugins> <plugin interceptor=”com.example.MyInterceptor”/> </plugins> 其中,com.example.MyInterceptor为你实现的自定义拦截器类的完整类名。这样,我们就可以直接将这个拦截器注入到MyBatis中,实现添加where条件的效果。 ### 回答2: Mybatis-Plus是一款基于Mybatis的增强工具包,可以方便地进行CRUD操作。Mybatis-Plus提供了很多的增强功能,其中就包括拦截器功能。 拦截器Mybatis-Plus实现增强功能的一种方式。Mybatis-Plus的拦截器是基于Mybatis拦截器实现的,通过拦截器可以在Sql语句执行前、执行后、异常时进行处理,达到自定义增强Sql语句的目的。 添加Where条件是在查询时经常使用的功能。Mybatis-Plus提供了方便的方式来实现拦截器添加Where条件的功能。具体步骤如下: 1. 创建拦截器类 创建一个拦截器类,实现Mybatis的Interceptor接口,并在实现类中实现intercept方法。 2. 复写intercept方法 在intercept方法中获取执行的Sql语句,判断是否查询语句,如果是查询语句,则获取查询条件,并在Sql语句中添加Where条件。 3. 配置拦截器 将编写好的拦截器配置到Mybatis-Plus的SqlSessionFactoryBean中,可以使用Mybatis-Plus提供的全局拦截器GlobalConfig进行配置。 通过以上步骤,可以很方便地实现拦截器添加Where条件的功能。使用拦截器添加Where条件的好处是可以统一管理,不需要在查询业务上重复添加Where条件。同时,拦截器也可以实现很多自定义功能,例如分页、参数校验等。 ### 回答3: Mybatis-Plus 是一款基于 Mybatis 的增强工具,在 Mybatis の基础上提供了很多实用的功能。其中,拦截器就是其重要的一部分。拦截器能够在 Mybatis-Plus 的执行流程中插入一些自己的逻辑,这些逻辑可以用来增强、定制 Mybatis-Plus 的功能,比如添加 where 条件Mybatis-Plus 的拦截器机制是以 Mybatis拦截器机制为基础的。Mybatis-Plus 在 Mybatis拦截器机制基础上,实现了自己的拦截器接口 Interceptor。实现自己的拦截器,需要实现 Interceptor 接口,然后重写 intercept 方法,在中拦截器方法中编写所需的逻辑,比如添加 where 条件添加 where 条件主要是在 SQL 执行的过程中插入一些条件语句,这些语句用于限制查询结果的范围。在 Mybatis 中,可以通过 ParameterHandler 来获取参数,通过 BoundSql 来获取 SQL 语句,并且在 BoundSql 中插入 where 条件语句。在具体的实现中,通过自定义 Mybatis-Plus 的拦截器,就可以轻松地实现添加 where 条件功能。 具体实现步骤如下: 1.自定义拦截器类,实现 Interceptor 接口 2.在 intercept 方法中实现自己的逻辑,获取参数并修改 BoundSql 3.在 Mybatis-Plus 配置文件中配置该拦截器 4.运行代码,查看效果 需要注意的是,添加 where 条件语句必须符合 SQL 语法,否则会导致 SQL 执行失败。另外,如果在拦截器中修改 BoundSql,一定要注意修改之后 SQL 的正确性,以免影响查询结果。 总之,Mybatis-Plus 的拦截器机制为我们提供了很多定制 Mybatis-Plus 功能的方便,添加 where 条件就是其中之一,可以根据实际需求,自定义实现自己的拦截器,并在其中添加需要的 where 条件,以实现更加灵活的查询功能。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值