update 优化aop写法 使用spring自动注入注解参数

ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/DataScopeAspect.java

@@ -9,14 +9,10 @@ import com.ruoyi.common.utils.SecurityUtils;
 import com.ruoyi.common.utils.StringUtils;
 import com.ruoyi.common.utils.reflect.ReflectUtils;
 import org.aspectj.lang.JoinPoint;
-import org.aspectj.lang.Signature;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Before;
-import org.aspectj.lang.annotation.Pointcut;
-import org.aspectj.lang.reflect.MethodSignature;
 import org.springframework.stereotype.Component;
 
-import java.lang.reflect.Method;
 import java.util.Map;
 
 /**
@@ -58,23 +54,13 @@ public class DataScopeAspect {
 	 */
 	public static final String DATA_SCOPE = "dataScope";
 
-	// 配置织入点
-	@Pointcut("@annotation(com.ruoyi.common.annotation.DataScope)")
-	public void dataScopePointCut() {
-	}
-
-	@Before("dataScopePointCut()")
-	public void doBefore(JoinPoint point) throws Throwable {
+	@Before("@annotation(controllerDataScope)")
+	public void doBefore(JoinPoint point, DataScope controllerDataScope) throws Throwable {
 		clearDataScope(point);
-		handleDataScope(point);
+		handleDataScope(point, controllerDataScope);
 	}
 
-	protected void handleDataScope(final JoinPoint joinPoint) {
-		// 获得注解
-		DataScope controllerDataScope = getAnnotationLog(joinPoint);
-		if (controllerDataScope == null) {
-			return;
-		}
+	protected void handleDataScope(final JoinPoint joinPoint, DataScope controllerDataScope) {
 		// 获取当前的用户
 		LoginUser loginUser = SecurityUtils.getLoginUser();
 		if (StringUtils.isNotNull(loginUser)) {
@@ -133,20 +119,6 @@ public class DataScopeAspect {
 		}
 	}
 
-	/**
-	 * 是否存在注解，如果存在就获取
-	 */
-	private DataScope getAnnotationLog(JoinPoint joinPoint) {
-		Signature signature = joinPoint.getSignature();
-		MethodSignature methodSignature = (MethodSignature) signature;
-		Method method = methodSignature.getMethod();
-
-		if (method != null) {
-			return method.getAnnotation(DataScope.class);
-		}
-		return null;
-	}
-
 	/**
 	 * 拼接权限sql前先清空params.dataScope参数防止注入
 	 */

ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/DataSourceAspect.java

@@ -6,33 +6,21 @@ import com.ruoyi.common.utils.StringUtils;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
-import org.aspectj.lang.annotation.Pointcut;
-import org.aspectj.lang.reflect.MethodSignature;
-import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.core.annotation.Order;
 import org.springframework.stereotype.Component;
 
-import java.util.Objects;
-
 /**
  * 多数据源处理
  *
- * @author ruoyi
+ * @author Lion Li
  */
 @Aspect
 @Order(-500)
 @Component
 public class DataSourceAspect {
 
-	@Pointcut("@annotation(com.ruoyi.common.annotation.DataSource)"
-		+ "|| @within(com.ruoyi.common.annotation.DataSource)")
-	public void dsPointCut() {
-	}
-
-	@Around("dsPointCut()")
-	public Object around(ProceedingJoinPoint point) throws Throwable {
-		DataSource dataSource = getDataSource(point);
-
+	@Around("@annotation(dataSource) || @within(dataSource)")
+	public Object around(ProceedingJoinPoint point, DataSource dataSource) throws Throwable {
 		if (StringUtils.isNotNull(dataSource)) {
 			DynamicDataSourceContextHolder.poll();
 			String source = dataSource.value().getSource();
@@ -47,16 +35,4 @@ public class DataSourceAspect {
 		}
 	}
 
-	/**
-	 * 获取需要切换的数据源
-	 */
-	public DataSource getDataSource(ProceedingJoinPoint point) {
-		MethodSignature signature = (MethodSignature) point.getSignature();
-		DataSource dataSource = AnnotationUtils.findAnnotation(signature.getMethod(), DataSource.class);
-		if (Objects.nonNull(dataSource)) {
-			return dataSource;
-		}
-
-		return AnnotationUtils.findAnnotation(signature.getDeclaringType(), DataSource.class);
-	}
 }

ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/LogAspect.java

@@ -1,11 +1,11 @@
 package com.ruoyi.framework.aspectj;
 
 import com.ruoyi.common.annotation.Log;
+import com.ruoyi.common.core.domain.dto.OperLogDTO;
 import com.ruoyi.common.core.domain.model.LoginUser;
+import com.ruoyi.common.core.service.OperLogService;
 import com.ruoyi.common.enums.BusinessStatus;
 import com.ruoyi.common.enums.HttpMethod;
-import com.ruoyi.common.core.service.OperLogService;
-import com.ruoyi.common.core.domain.dto.OperLogDTO;
 import com.ruoyi.common.utils.JsonUtils;
 import com.ruoyi.common.utils.SecurityUtils;
 import com.ruoyi.common.utils.ServletUtils;
@@ -13,12 +13,9 @@ import com.ruoyi.common.utils.StringUtils;
 import com.ruoyi.common.utils.spring.SpringUtils;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
-import org.aspectj.lang.Signature;
 import org.aspectj.lang.annotation.AfterReturning;
 import org.aspectj.lang.annotation.AfterThrowing;
 import org.aspectj.lang.annotation.Aspect;
-import org.aspectj.lang.annotation.Pointcut;
-import org.aspectj.lang.reflect.MethodSignature;
 import org.springframework.stereotype.Component;
 import org.springframework.validation.BindingResult;
 import org.springframework.web.multipart.MultipartFile;
@@ -26,60 +23,42 @@ import org.springframework.web.servlet.HandlerMapping;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
-import java.lang.reflect.Method;
 import java.util.Collection;
 import java.util.Map;
 
 /**
  * 操作日志记录处理
- * 
- * @author ruoyi
+ *
+ * @author Lion Li
  */
 @Slf4j
 @Aspect
 @Component
-public class LogAspect
-{
-
-    // 配置织入点
-    @Pointcut("@annotation(com.ruoyi.common.annotation.Log)")
-    public void logPointCut()
-    {
-    }
+public class LogAspect {
 
     /**
      * 处理完请求后执行
      *
      * @param joinPoint 切点
      */
-    @AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
-    public void doAfterReturning(JoinPoint joinPoint, Object jsonResult)
-    {
-        handleLog(joinPoint, null, jsonResult);
+    @AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")
+    public void doAfterReturning(JoinPoint joinPoint, Log controllerLog, Object jsonResult) {
+        handleLog(joinPoint, controllerLog, null, jsonResult);
     }
 
     /**
      * 拦截异常操作
-     * 
+     *
      * @param joinPoint 切点
-     * @param e 异常
+     * @param e         异常
      */
-    @AfterThrowing(value = "logPointCut()", throwing = "e")
-    public void doAfterThrowing(JoinPoint joinPoint, Exception e)
-    {
-        handleLog(joinPoint, e, null);
+    @AfterThrowing(value = "@annotation(controllerLog)", throwing = "e")
+    public void doAfterThrowing(JoinPoint joinPoint, Log controllerLog, Exception e) {
+        handleLog(joinPoint, controllerLog, e, null);
     }
 
-    protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult)
-    {
-        try
-        {
-            // 获得注解
-            Log controllerLog = getAnnotationLog(joinPoint);
-            if (controllerLog == null)
-            {
-                return;
-            }
+    protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult) {
+        try {
 
             // 获取当前的用户
             LoginUser loginUser = SecurityUtils.getLoginUser();
@@ -91,13 +70,11 @@ public class LogAspect
             String ip = ServletUtils.getClientIP();
             operLog.setOperIp(ip);
             operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
-            if (loginUser != null)
-            {
+            if (loginUser != null) {
                 operLog.setOperName(loginUser.getUsername());
             }
 
-            if (e != null)
-            {
+            if (e != null) {
                 operLog.setStatus(BusinessStatus.FAIL.ordinal());
                 operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
             }
@@ -110,10 +87,8 @@ public class LogAspect
             // 处理设置注解上的参数
             getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
             // 保存数据库
-			SpringUtils.getBean(OperLogService.class).recordOper(operLog);
-        }
-        catch (Exception exp)
-        {
+            SpringUtils.getBean(OperLogService.class).recordOper(operLog);
+        } catch (Exception exp) {
             // 记录本地异常日志
             log.error("==前置通知异常==");
             log.error("异常信息:{}", exp.getMessage());
@@ -123,13 +98,12 @@ public class LogAspect
 
     /**
      * 获取注解中对方法的描述信息 用于Controller层注解
-     * 
-     * @param log 日志
+     *
+     * @param log     日志
      * @param operLog 操作日志
      * @throws Exception
      */
-    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, OperLogDTO operLog, Object jsonResult) throws Exception
-    {
+    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, OperLogDTO operLog, Object jsonResult) throws Exception {
         // 设置action动作
         operLog.setBusinessType(log.businessType().ordinal());
         // 设置标题
@@ -137,68 +111,44 @@ public class LogAspect
         // 设置操作人类别
         operLog.setOperatorType(log.operatorType().ordinal());
         // 是否需要保存request，参数和值
-        if (log.isSaveRequestData())
-        {
+        if (log.isSaveRequestData()) {
             // 获取参数的信息，传入到数据库中。
             setRequestValue(joinPoint, operLog);
         }
         // 是否需要保存response，参数和值
-        if (log.isSaveResponseData() && StringUtils.isNotNull(jsonResult))
-        {
+        if (log.isSaveResponseData() && StringUtils.isNotNull(jsonResult)) {
             operLog.setJsonResult(StringUtils.substring(JsonUtils.toJsonString(jsonResult), 0, 2000));
         }
     }
 
     /**
      * 获取请求的参数，放到log中
-     * 
+     *
      * @param operLog 操作日志
      * @throws Exception 异常
      */
-    private void setRequestValue(JoinPoint joinPoint, OperLogDTO operLog) throws Exception
-    {
+    private void setRequestValue(JoinPoint joinPoint, OperLogDTO operLog) throws Exception {
         String requestMethod = operLog.getRequestMethod();
-        if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod))
-        {
+        if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod)) {
             String params = argsArrayToString(joinPoint.getArgs());
             operLog.setOperParam(StringUtils.substring(params, 0, 2000));
-        }
-        else
-        {
+        } else {
             Map<?, ?> paramsMap = (Map<?, ?>) ServletUtils.getRequest().getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
             operLog.setOperParam(StringUtils.substring(paramsMap.toString(), 0, 2000));
         }
     }
 
-    /**
-     * 是否存在注解，如果存在就获取
-     */
-    private Log getAnnotationLog(JoinPoint joinPoint) throws Exception
-    {
-        Signature signature = joinPoint.getSignature();
-        MethodSignature methodSignature = (MethodSignature) signature;
-        Method method = methodSignature.getMethod();
-
-        if (method != null)
-        {
-            return method.getAnnotation(Log.class);
-        }
-        return null;
-    }
-
     /**
      * 参数拼装
      */
-    private String argsArrayToString(Object[] paramsArray)
-    {
+    private String argsArrayToString(Object[] paramsArray) {
         StringBuilder params = new StringBuilder();
-        if (paramsArray != null && paramsArray.length > 0)
-        {
-			for (Object o : paramsArray) {
-				if (StringUtils.isNotNull(o) && !isFilterObject(o)) {
-					params.append(JsonUtils.toJsonString(o)).append(" ");
-				}
-			}
+        if (paramsArray != null && paramsArray.length > 0) {
+            for (Object o : paramsArray) {
+                if (StringUtils.isNotNull(o) && !isFilterObject(o)) {
+                    params.append(JsonUtils.toJsonString(o)).append(" ");
+                }
+            }
         }
         return params.toString().trim();
     }
@@ -210,27 +160,21 @@ public class LogAspect
      * @return 如果是需要过滤的对象，则返回true；否则返回false。
      */
     @SuppressWarnings("rawtypes")
-    public boolean isFilterObject(final Object o)
-    {
+    public boolean isFilterObject(final Object o) {
         Class<?> clazz = o.getClass();
-        if (clazz.isArray())
-        {
+        if (clazz.isArray()) {
             return clazz.getComponentType().isAssignableFrom(MultipartFile.class);
-        }
-        else if (Collection.class.isAssignableFrom(clazz))
-        {
+        } else if (Collection.class.isAssignableFrom(clazz)) {
             Collection collection = (Collection) o;
-			for (Object value : collection) {
-				return value instanceof MultipartFile;
-			}
-        }
-        else if (Map.class.isAssignableFrom(clazz))
-        {
+            for (Object value : collection) {
+                return value instanceof MultipartFile;
+            }
+        } else if (Map.class.isAssignableFrom(clazz)) {
             Map map = (Map) o;
-			for (Object value : map.entrySet()) {
-				Map.Entry entry = (Map.Entry) value;
-				return entry.getValue() instanceof MultipartFile;
-			}
+            for (Object value : map.entrySet()) {
+                Map.Entry entry = (Map.Entry) value;
+                return entry.getValue() instanceof MultipartFile;
+            }
         }
         return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse
                 || o instanceof BindingResult;

ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/RateLimiterAspect.java

@@ -7,10 +7,8 @@ import com.ruoyi.common.utils.RedisUtils;
 import com.ruoyi.common.utils.ServletUtils;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
-import org.aspectj.lang.Signature;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Before;
-import org.aspectj.lang.annotation.Pointcut;
 import org.aspectj.lang.reflect.MethodSignature;
 import org.redisson.api.RateType;
 import org.springframework.stereotype.Component;
@@ -27,14 +25,8 @@ import java.lang.reflect.Method;
 @Component
 public class RateLimiterAspect {
 
-    // 配置织入点
-    @Pointcut("@annotation(com.ruoyi.common.annotation.RateLimiter)")
-    public void rateLimiterPointCut() {
-    }
-
-    @Before("rateLimiterPointCut()")
-    public void doBefore(JoinPoint point) throws Throwable {
-        RateLimiter rateLimiter = getAnnotationRateLimiter(point);
+    @Before("@annotation(rateLimiter)")
+    public void doBefore(JoinPoint point, RateLimiter rateLimiter) throws Throwable {
         int time = rateLimiter.time();
         int count = rateLimiter.count();
         String combineKey = getCombineKey(rateLimiter, point);
@@ -55,20 +47,6 @@ public class RateLimiterAspect {
         }
     }
 
-    /**
-     * 是否存在注解，如果存在就获取
-     */
-    private RateLimiter getAnnotationRateLimiter(JoinPoint joinPoint) {
-        Signature signature = joinPoint.getSignature();
-        MethodSignature methodSignature = (MethodSignature) signature;
-        Method method = methodSignature.getMethod();
-
-        if (method != null) {
-            return method.getAnnotation(RateLimiter.class);
-        }
-        return null;
-    }
-
     public String getCombineKey(RateLimiter rateLimiter, JoinPoint point) {
         StringBuilder stringBuffer = new StringBuilder(rateLimiter.key());
         if (rateLimiter.limitType() == LimitType.IP) {

ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/RepeatSubmitAspect.java

@@ -14,16 +14,12 @@ import com.ruoyi.framework.config.properties.RepeatSubmitProperties;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
-import org.aspectj.lang.Signature;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Before;
-import org.aspectj.lang.annotation.Pointcut;
-import org.aspectj.lang.reflect.MethodSignature;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
 import javax.servlet.http.HttpServletRequest;
-import java.lang.reflect.Method;
 
 /**
  * 防止重复提交
@@ -40,14 +36,8 @@ public class RepeatSubmitAspect {
     private final RepeatSubmitProperties repeatSubmitProperties;
     private final LockTemplate lockTemplate;
 
-    // 配置织入点
-    @Pointcut("@annotation(com.ruoyi.common.annotation.RepeatSubmit)")
-    public void repeatSubmitPointCut() {
-    }
-
-    @Before("repeatSubmitPointCut()")
-    public void doBefore(JoinPoint point) throws Throwable {
-        RepeatSubmit repeatSubmit = getAnnotationRateLimiter(point);
+    @Before("@annotation(repeatSubmit)")
+    public void doBefore(JoinPoint point, RepeatSubmit repeatSubmit) throws Throwable {
         // 如果注解不为0 则使用注解数值
         long intervalTime = repeatSubmitProperties.getIntervalTime();
         if (repeatSubmit.intervalTime() > 0) {
@@ -76,18 +66,4 @@ public class RepeatSubmitAspect {
         }
     }
 
-    /**
-     * 是否存在注解，如果存在就获取
-     */
-    private RepeatSubmit getAnnotationRateLimiter(JoinPoint joinPoint) {
-        Signature signature = joinPoint.getSignature();
-        MethodSignature methodSignature = (MethodSignature) signature;
-        Method method = methodSignature.getMethod();
-
-        if (method != null) {
-            return method.getAnnotation(RepeatSubmit.class);
-        }
-        return null;
-    }
-
 }