feat(crud): CrudRequestMapping 注解增加 ignoreAuth、ignorePermission 支持

Author: Charles7c

continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/annotation/CrudApi.java

@@ -23,6 +23,8 @@
 /**
  * CRUD（增删改查）API
  *
+ * <p>{@link CrudRequestMapping#apis} 优先级高于方法上的 @CrudApi</p>
+ *
  * @author Charles7c
  * @since 2.7.5
  */
@@ -35,4 +37,14 @@
      * API 类型
      */
     Api value() default Api.LIST;
+
+    /**
+     * 是否忽略认证
+     */
+    boolean ignoreAuth() default false;
+
+    /**
+     * 是否忽略权限校验
+     */
+    boolean ignorePermission() default false;
 }

continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/annotation/CrudRequestMapping.java

@@ -36,8 +36,26 @@
      */
     String value() default "";
 
+    /**
+     * API 列表
+     * <p>优先级高于 {@link #api}</p>
+     */
+    CrudApi[] apis() default {};
+
     /**
      * API 列表
      */
     Api[] api() default {Api.PAGE, Api.GET, Api.CREATE, Api.UPDATE, Api.DELETE, Api.EXPORT};
+
+    /**
+     * 是否忽略认证
+     * <p>全部忽略，优先级低于 {@link CrudApi#ignoreAuth}</p>
+     */
+    boolean ignoreAuth() default false;
+
+    /**
+     * 是否忽略权限校验
+     * <p>全部忽略，优先级低于 {@link CrudApi#ignorePermission}</p>
+     */
+    boolean ignorePermission() default false;
 }

continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/aop/CrudApiAnnotationInterceptor.java

@@ -16,16 +16,19 @@
 
 package top.continew.starter.extension.crud.aop;
 
+import cn.hutool.core.util.ArrayUtil;
 import org.aopalliance.intercept.MethodInterceptor;
 import org.aopalliance.intercept.MethodInvocation;
 import org.springframework.aop.support.AopUtils;
 import org.springframework.core.BridgeMethodResolver;
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.util.ClassUtils;
 import top.continew.starter.extension.crud.annotation.CrudApi;
+import top.continew.starter.extension.crud.annotation.CrudRequestMapping;
 import top.continew.starter.extension.crud.controller.AbstractCrudController;
 
 import java.lang.reflect.Method;
+import java.util.Arrays;
 import java.util.Objects;
 
 /**
@@ -44,10 +47,28 @@ public Object invoke(MethodInvocation invocation) throws Throwable {
         Method specificMethod = ClassUtils.getMostSpecificMethod(invocation.getMethod(), targetClass);
         Method targetMethod = BridgeMethodResolver.findBridgedMethod(specificMethod);
         // 获取 @CrudApi 注解
-        CrudApi crudApi = AnnotatedElementUtils.findMergedAnnotation(targetMethod, CrudApi.class);
+        CrudApi crudApi = this.getCrudApi(targetMethod, targetClass);
         // 执行处理
         AbstractCrudController crudController = (AbstractCrudController)invocation.getThis();
         crudController.preHandle(crudApi, invocation.getArguments(), targetMethod, targetClass);
         return invocation.proceed();
     }
+
+    /**
+     * 获取 @CrudApi 注解
+     *
+     * @param targetMethod 目标方法
+     * @param targetClass  目标类
+     * @return @CrudApi 注解
+     */
+    private CrudApi getCrudApi(Method targetMethod, Class<?> targetClass) {
+        CrudRequestMapping crudRequestMapping = AnnotatedElementUtils
+            .findMergedAnnotation(targetClass, CrudRequestMapping.class);
+        CrudApi[] crudApis = crudRequestMapping.apis();
+        CrudApi crudApi = AnnotatedElementUtils.findMergedAnnotation(targetMethod, CrudApi.class);
+        if (ArrayUtil.isEmpty(crudApis)) {
+            return crudApi;
+        }
+        return Arrays.stream(crudApis).filter(api -> api.value() == crudApi.value()).findFirst().orElse(null);
+    }
 }

continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/autoconfigure/CrudRequestMappingHandlerMapping.java

@@ -31,6 +31,7 @@
 
 import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.Method;
+import java.util.Arrays;
 
 /**
  * CRUD 请求映射器处理器映射器
@@ -51,17 +52,40 @@ protected RequestMappingInfo getMappingForMethod(@NonNull Method method, @NonNul
             return requestMappingInfo;
         }
         CrudRequestMapping crudRequestMapping = handlerType.getDeclaredAnnotation(CrudRequestMapping.class);
-        // 过滤 API，如果非本类中定义，且 API 列表中不包含，则忽略
-        Api[] apiArr = crudRequestMapping.api();
         CrudApi crudApi = AnnotatedElementUtils.findMergedAnnotation(method, CrudApi.class);
-        if (method.getDeclaringClass() != handlerType && !ArrayUtil.contains(apiArr, ExceptionUtils
+        // 过滤 API：如果非本类中定义，且 API 列表中不包含，则忽略
+        Api[] apis = this.getApis(crudRequestMapping);
+        if (method.getDeclaringClass() != handlerType && !ArrayUtil.contains(apis, ExceptionUtils
             .exToNull(crudApi::value))) {
             return null;
         }
         // 拼接路径（合并了 @RequestMapping 的部分能力）
         return this.getMappingForMethodWrapper(method, handlerType, crudRequestMapping);
     }
 
+    /**
+     * 获取 API 列表
+     *
+     * @param crudRequestMapping CRUD 请求映射
+     * @return API 列表
+     */
+    private Api[] getApis(CrudRequestMapping crudRequestMapping) {
+        Api[] apiArr = crudRequestMapping.api();
+        CrudApi[] crudApiArr = crudRequestMapping.apis();
+        if (ArrayUtil.isEmpty(crudApiArr)) {
+            return apiArr;
+        }
+        return Arrays.stream(crudApiArr).map(CrudApi::value).toArray(Api[]::new);
+    }
+
+    /**
+     * 获取请求映射信息
+     *
+     * @param method             方法
+     * @param handlerType        处理程序类型
+     * @param crudRequestMapping CRUD 请求映射
+     * @return 请求映射信息
+     */
     private RequestMappingInfo getMappingForMethodWrapper(@NonNull Method method,
                                                           @NonNull Class<?> handlerType,
                                                           CrudRequestMapping crudRequestMapping) {
@@ -81,6 +105,12 @@ private RequestMappingInfo getMappingForMethodWrapper(@NonNull Method method,
         return info;
     }
 
+    /**
+     * 构建请求映射信息
+     *
+     * @param element 元素
+     * @return 请求映射信息
+     */
     private RequestMappingInfo buildRequestMappingInfo(AnnotatedElement element) {
         RequestMapping requestMapping = AnnotatedElementUtils.findMergedAnnotation(element, RequestMapping.class);
         RequestCondition<?> condition = (element instanceof Class<?> clazz