Mybatis自定義攔截器實(shí)現(xiàn)權(quán)限功能

更新時(shí)間：2024年12月12日 10:20:33 作者：喔喔咿哈哈

本文主要介紹了Mybatis自定義攔截器實(shí)現(xiàn)權(quán)限功能,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

1、Mybatis 攔截器介紹

1.1 Mybatis 執(zhí)行流程

首先讀取配置文件，然后加載映射文件，由SqlSessionFactory工廠對(duì)象去創(chuàng)建核心對(duì)象SqlSession，SqlSession對(duì)象會(huì)通過(guò)Executor執(zhí)行器對(duì)象執(zhí)行sql。然后Executor執(zhí)行器對(duì)象會(huì)調(diào)用StatementHandler對(duì)象去真正的訪問(wèn)數(shù)據(jù)庫(kù)執(zhí)行sql語(yǔ)句。
在執(zhí)行sql語(yǔ)句前MapperStatement會(huì)先對(duì)映射信息進(jìn)行封裝，然后StatementHandler調(diào)用ParameterHandler去設(shè)置編譯參數(shù)【#{}，${}】，編譯在StatementHandler中進(jìn)行。然后StatementHandler調(diào)用JBDC原生API進(jìn)行處理，獲取執(zhí)行結(jié)果，這個(gè)執(zhí)行結(jié)果交給ResultSetHandler 來(lái)進(jìn)行結(jié)果集封裝，然后將結(jié)果返回給StatementHandler。
注意：這里MapperStatement是對(duì)映射信息的封裝，用于存儲(chǔ)要映射的SQL語(yǔ)句的id、參數(shù)等信息。TypeHandler進(jìn)行數(shù)據(jù)庫(kù)類(lèi)型和JavaBean類(lèi)型映射處理。

1.2 Mybatis中可以被攔截的類(lèi)型

Executor：攔截執(zhí)行器的方法。
ParameterHandler：攔截參數(shù)的處理。
ResultHandler：攔截結(jié)果集的處理。
StatementHandler：攔截Sql語(yǔ)法構(gòu)建的處理。

1.3 使用規(guī)則

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Intercepts {
    /**
     * 定義攔截點(diǎn)
     * 只有符合攔截點(diǎn)的條件才會(huì)進(jìn)入到攔截器
     */
    Signature[] value();
}

Signature來(lái)指定咱們需要攔截那個(gè)類(lèi)對(duì)象的哪個(gè)方法

- type：上述四種類(lèi)型中的一種；
- method：對(duì)應(yīng)接口中的哪類(lèi)方法（因?yàn)榭赡艽嬖谥剌d方法）；
- args：對(duì)應(yīng)哪一個(gè)方法的入?yún)ⅲ?/p>

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({})
public @interface Signature {
  /**
   * 定義攔截的類(lèi) Executor、ParameterHandler、StatementHandler、ResultSetHandler當(dāng)中的一個(gè)
   */
  Class<?> type();

  /**
   * 在定義攔截類(lèi)的基礎(chǔ)之上，在定義攔截的方法
   */
  String method();

  /**
   * 在定義攔截方法的基礎(chǔ)之上在定義攔截的方法對(duì)應(yīng)的參數(shù)，
   * JAVA里面方法可能重載，故注意參數(shù)的類(lèi)型和順序
   */
  Class<?>[] args();
}

1.4 攔截器重寫(xiě)的方法

public interface Interceptor {
    //起攔截作用,在此定義一些功能
    Object intercept(Invocation var1) throws Throwable;

    //這個(gè)方法的作用是就是讓mybatis判斷，是否要進(jìn)行攔截，然后做出決定是否生成一個(gè)代理
    Object plugin(Object var1);

    //攔截器需要一些變量對(duì)象，而且這個(gè)對(duì)象是支持可配置的。
    void setProperties(Properties var1);
}

2、實(shí)戰(zhàn)部分：攔截實(shí)現(xiàn)

自定義注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DepartAuth {
    /**
     * 添加查詢(xún)條件的字段名
     * @return
     */
    String field();

    EnumDepartAuthType authType() default EnumDepartAuthType.DEPART_ID;
    
}

在所在接口上添加注解

@DepartAuth(field = "xxx", authType = )

切面（AuthAspect）

@Slf4j
@Aspect
@Component
public class DepartAuthAspect {

    @Autowired
    private DepartAuthHandler departAuthHandler;

    @Pointcut("@annotation(org.jeecg.common.auth.depart.annotation.DepartAuth)")
    public void departAuthPoint() {

    }

    @Before("departAuthPoint()")
    public void before(JoinPoint joinPoint) {
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();

        Annotation[] annotations = methodSignature.getMethod().getAnnotations();

        for (Annotation annotation : annotations) {
            if (annotation instanceof DepartAuth) {
                String field = ((DepartAuth) annotation).field();
                departAuthHandler.beforeHandler((DepartAuth) annotation);
            }
        }

    }

    @After("departAuthPoint()")
    public void after(JoinPoint pjp) {
        departAuthHandler.afterHandler();
    }
}

DepartAuthHandler

將信息存儲(chǔ)到 TreadLocalhost 中，方便后續(xù)修改sql的時(shí)候可以讀取到需要修改的字段

@Slf4j
@Component
public class DepartAuthHandler {

    public static ThreadLocal<DepartAuth> DEPART_AUTH_CACHE = new ThreadLocal<>();
    public static ThreadLocal<Integer> DEPART_AUTH_COUNT = new ThreadLocal<>();

    public void beforeHandler(DepartAuth departAuth) {
        String field = departAuth.field();
        if(StringUtils.isNotBlank(field)) {
            DEPART_AUTH_CACHE.set(departAuth);
            DEPART_AUTH_COUNT.remove();
        }
        PriorityQueue queue = new PriorityQueue<>();
        queue.peek();
    }

    public void afterHandler() {
        DEPART_AUTH_CACHE.remove();
        DEPART_AUTH_COUNT.remove();
    }
}

攔截器部分

獲取StatementHandler：通過(guò) invocation.getTarget() 獲取當(dāng)前被攔截的 StatementHandler 對(duì)象。由于 MyBatis 使用了代理模式，因此這里得到的是一個(gè)代理對(duì)象。接著，通過(guò)反射獲取其實(shí)際的代理對(duì)象，即最終執(zhí)行SQL的 StatementHandler 實(shí)例。
獲取MappedStatement：通過(guò)反射從 StatementHandler 中獲取 mappedStatement 對(duì)象。這個(gè)對(duì)象包含了關(guān)于即將執(zhí)行的SQL語(yǔ)句的所有信息，包括SQL類(lèi)型、參數(shù)類(lèi)型等。
判斷SQL類(lèi)型：通過(guò)mappedStatement.getSqlCommandType()獲取SQL命令類(lèi)型。如果類(lèi)型是SELECT，說(shuō)明當(dāng)前是一個(gè)查詢(xún)操作，需要進(jìn)行權(quán)限檢查和處理。
獲取并解析原始SQL：通過(guò)delegate.getBoundSql()獲取BoundSql對(duì)象，它包含了實(shí)際執(zhí)行的SQL語(yǔ)句和相關(guān)的參數(shù)信息。然后使用CCJSqlParserUtil.parse()解析這個(gè)SQL語(yǔ)句，得到一個(gè)抽象語(yǔ)法樹(shù)（AST）。
修改SQL：從AST中提取出PlainSelect對(duì)象（即SELECT語(yǔ)句的主體）。然后調(diào)用自定義的buildWhereClause方法，根據(jù)departAuth中的權(quán)限信息構(gòu)建一個(gè)權(quán)限檢查條件，并將其注入到原始的SELECT語(yǔ)句中。這通常是通過(guò)在WHERE子句后追加額外的條件來(lái)實(shí)現(xiàn)的。
更新BoundSql對(duì)象：將修改后的SQL語(yǔ)句重新設(shè)置回BoundSql對(duì)象中，以便MyBatis在執(zhí)行時(shí)能夠使用修改后的SQL。
繼續(xù)執(zhí)行后續(xù)流程：在完成SQL修改后，調(diào)用invocation.proceed()繼續(xù)執(zhí)行MyBatis的后續(xù)處理流程，包括實(shí)際的SQL執(zhí)行、結(jié)果集處理等。

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

    private Properties properties;




    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        DepartAuth departAuth = DepartAuthHandler.DEPART_AUTH_CACHE.get();
        Integer count = DepartAuthHandler.DEPART_AUTH_COUNT.get();
        if(departAuth != null && count == null) {
            // 說(shuō)明當(dāng)前線程已經(jīng)執(zhí)行了過(guò)濾條件，避免遞歸調(diào)用
            DepartAuthHandler.DEPART_AUTH_COUNT.set(1);
            RoutingStatementHandler handler = (RoutingStatementHandler) invocation.getTarget();
            //獲取StatementHandler構(gòu)造器
            StatementHandler delegate = (StatementHandler) ReflectUtil.getFieldValue(handler, "delegate");
            // 通過(guò)反射獲取delegate父類(lèi)BaseStatementHandler的mappedStatement屬性
            MappedStatement mappedStatement = (MappedStatement) ReflectUtil.getFieldValue(delegate, "mappedStatement");
            SqlCommandType commandType = mappedStatement.getSqlCommandType();
            // 處理select對(duì)象
            if (SqlCommandType.SELECT.equals(commandType)) {
                // 獲取原始sql
                BoundSql boundSql = delegate.getBoundSql();
                Statement statement = CCJSqlParserUtil.parse(boundSql.getSql());
                PlainSelect selectBody = (PlainSelect) ((Select) statement).getSelectBody();
                log.info("原始 sql:{}", boundSql.getSql());
                // 拼接新條件
                buildWhereClause(selectBody, getSql(departAuth));
                ReflectUtil.setFieldValue(boundSql, "sql", statement.toString());
            }
            return invocation.proceed();

        }
        return invocation.proceed();
    }

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

    @Override
    public void setProperties(Properties properties) {
        this.properties = properties;
    }

    /**
     * 添加查詢(xún)條件
     * @param select
     * @param dataFilter
     * @throws JSQLParserException
     */
    private void buildWhereClause(PlainSelect select, String dataFilter) throws JSQLParserException {
        if(StringUtils.isBlank(dataFilter)) {
            return;
        }
        if (select.getWhere() == null) {
            select.setWhere(CCJSqlParserUtil.parseCondExpression(dataFilter));
        } else {
            AndExpression and = new AndExpression(
                    CCJSqlParserUtil.parseCondExpression(dataFilter), select.getWhere());
            select.setWhere(and);
        }
    }

    private String getSql(DepartAuth departAuth) {
        //結(jié)合自己的業(yè)務(wù)，拼接相對(duì)應(yīng)的sql語(yǔ)句
    }
}

到此這篇關(guān)于Mybatis自定義攔截器實(shí)現(xiàn)權(quán)限功能的文章就介紹到這了,更多相關(guān)Mybatis 權(quán)限內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: