From 99de90a015fb0494950f6f52f03ab5c34d192eee Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期一, 28 六月 2021 19:23:02 +0800
Subject: [PATCH] update 更新配置注释(规范使用方法)
---
ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/LogAspect.java | 455 +++++++++++++++++++++++++++++---------------------------
1 files changed, 238 insertions(+), 217 deletions(-)
diff --git a/ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/LogAspect.java b/ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/LogAspect.java
index 51a7cd2..d5c0fe8 100644
--- a/ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/LogAspect.java
+++ b/ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/LogAspect.java
@@ -1,217 +1,238 @@
-package com.ruoyi.framework.aspectj;
-
-import java.lang.reflect.Method;
-import java.util.Map;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-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.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.stereotype.Component;
-import org.springframework.web.multipart.MultipartFile;
-import org.springframework.web.servlet.HandlerMapping;
-import com.alibaba.fastjson.JSON;
-import com.ruoyi.common.annotation.Log;
-import com.ruoyi.common.core.domain.model.LoginUser;
-import com.ruoyi.common.enums.BusinessStatus;
-import com.ruoyi.common.enums.HttpMethod;
-import com.ruoyi.common.utils.ServletUtils;
-import com.ruoyi.common.utils.StringUtils;
-import com.ruoyi.common.utils.ip.IpUtils;
-import com.ruoyi.common.utils.spring.SpringUtils;
-import com.ruoyi.framework.manager.AsyncManager;
-import com.ruoyi.framework.manager.factory.AsyncFactory;
-import com.ruoyi.framework.web.service.TokenService;
-import com.ruoyi.system.domain.SysOperLog;
-
-/**
- * 鎿嶄綔鏃ュ織璁板綍澶勭悊
- *
- * @author ruoyi
- */
-@Aspect
-@Component
-public class LogAspect
-{
- private static final Logger log = LoggerFactory.getLogger(LogAspect.class);
-
- // 閰嶇疆缁囧叆鐐�
- @Pointcut("@annotation(com.ruoyi.common.annotation.Log)")
- public void logPointCut()
- {
- }
-
- /**
- * 澶勭悊瀹岃姹傚悗鎵ц
- *
- * @param joinPoint 鍒囩偣
- */
- @AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
- public void doAfterReturning(JoinPoint joinPoint, Object jsonResult)
- {
- handleLog(joinPoint, null, jsonResult);
- }
-
- /**
- * 鎷︽埅寮傚父鎿嶄綔
- *
- * @param joinPoint 鍒囩偣
- * @param e 寮傚父
- */
- @AfterThrowing(value = "logPointCut()", throwing = "e")
- public void doAfterThrowing(JoinPoint joinPoint, Exception e)
- {
- handleLog(joinPoint, e, null);
- }
-
- protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult)
- {
- try
- {
- // 鑾峰緱娉ㄨВ
- Log controllerLog = getAnnotationLog(joinPoint);
- if (controllerLog == null)
- {
- return;
- }
-
- // 鑾峰彇褰撳墠鐨勭敤鎴�
- LoginUser loginUser = SpringUtils.getBean(TokenService.class).getLoginUser(ServletUtils.getRequest());
-
- // *========鏁版嵁搴撴棩蹇�=========*//
- SysOperLog operLog = new SysOperLog();
- operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
- // 璇锋眰鐨勫湴鍧�
- String ip = IpUtils.getIpAddr(ServletUtils.getRequest());
- operLog.setOperIp(ip);
- // 杩斿洖鍙傛暟
- operLog.setJsonResult(JSON.toJSONString(jsonResult));
-
- operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
- if (loginUser != null)
- {
- operLog.setOperName(loginUser.getUsername());
- }
-
- if (e != null)
- {
- operLog.setStatus(BusinessStatus.FAIL.ordinal());
- operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
- }
- // 璁剧疆鏂规硶鍚嶇О
- String className = joinPoint.getTarget().getClass().getName();
- String methodName = joinPoint.getSignature().getName();
- operLog.setMethod(className + "." + methodName + "()");
- // 璁剧疆璇锋眰鏂瑰紡
- operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
- // 澶勭悊璁剧疆娉ㄨВ涓婄殑鍙傛暟
- getControllerMethodDescription(joinPoint, controllerLog, operLog);
- // 淇濆瓨鏁版嵁搴�
- AsyncManager.me().execute(AsyncFactory.recordOper(operLog));
- }
- catch (Exception exp)
- {
- // 璁板綍鏈湴寮傚父鏃ュ織
- log.error("==鍓嶇疆閫氱煡寮傚父==");
- log.error("寮傚父淇℃伅:{}", exp.getMessage());
- exp.printStackTrace();
- }
- }
-
- /**
- * 鑾峰彇娉ㄨВ涓鏂规硶鐨勬弿杩颁俊鎭� 鐢ㄤ簬Controller灞傛敞瑙�
- *
- * @param log 鏃ュ織
- * @param operLog 鎿嶄綔鏃ュ織
- * @throws Exception
- */
- public void getControllerMethodDescription(JoinPoint joinPoint, Log log, SysOperLog operLog) throws Exception
- {
- // 璁剧疆action鍔ㄤ綔
- operLog.setBusinessType(log.businessType().ordinal());
- // 璁剧疆鏍囬
- operLog.setTitle(log.title());
- // 璁剧疆鎿嶄綔浜虹被鍒�
- operLog.setOperatorType(log.operatorType().ordinal());
- // 鏄惁闇�瑕佷繚瀛榬equest锛屽弬鏁板拰鍊�
- if (log.isSaveRequestData())
- {
- // 鑾峰彇鍙傛暟鐨勪俊鎭紝浼犲叆鍒版暟鎹簱涓��
- setRequestValue(joinPoint, operLog);
- }
- }
-
- /**
- * 鑾峰彇璇锋眰鐨勫弬鏁帮紝鏀惧埌log涓�
- *
- * @param operLog 鎿嶄綔鏃ュ織
- * @throws Exception 寮傚父
- */
- private void setRequestValue(JoinPoint joinPoint, SysOperLog operLog) throws Exception
- {
- String requestMethod = operLog.getRequestMethod();
- if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod))
- {
- String params = argsArrayToString(joinPoint.getArgs());
- operLog.setOperParam(StringUtils.substring(params, 0, 2000));
- }
- 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)
- {
- String params = "";
- if (paramsArray != null && paramsArray.length > 0)
- {
- for (int i = 0; i < paramsArray.length; i++)
- {
- if (!isFilterObject(paramsArray[i]))
- {
- Object jsonObj = JSON.toJSON(paramsArray[i]);
- params += jsonObj.toString() + " ";
- }
- }
- }
- return params.trim();
- }
-
- /**
- * 鍒ゆ柇鏄惁闇�瑕佽繃婊ょ殑瀵硅薄銆�
- *
- * @param o 瀵硅薄淇℃伅銆�
- * @return 濡傛灉鏄渶瑕佽繃婊ょ殑瀵硅薄锛屽垯杩斿洖true锛涘惁鍒欒繑鍥瀎alse銆�
- */
- public boolean isFilterObject(final Object o)
- {
- return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse;
- }
-}
+package com.ruoyi.framework.aspectj;
+
+import cn.hutool.core.lang.Validator;
+import cn.hutool.core.util.StrUtil;
+import com.ruoyi.common.annotation.Log;
+import com.ruoyi.common.core.domain.model.LoginUser;
+import com.ruoyi.common.enums.BusinessStatus;
+import com.ruoyi.common.enums.HttpMethod;
+import com.ruoyi.common.utils.JsonUtils;
+import com.ruoyi.common.utils.ServletUtils;
+import com.ruoyi.common.utils.spring.SpringUtils;
+import com.ruoyi.framework.web.service.AsyncService;
+import com.ruoyi.framework.web.service.TokenService;
+import com.ruoyi.system.domain.SysOperLog;
+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.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+import org.springframework.validation.BindingResult;
+import org.springframework.web.multipart.MultipartFile;
+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
+ */
+@Aspect
+@Component
+public class LogAspect
+{
+ private static final Logger log = LoggerFactory.getLogger(LogAspect.class);
+
+ // 閰嶇疆缁囧叆鐐�
+ @Pointcut("@annotation(com.ruoyi.common.annotation.Log)")
+ public void logPointCut()
+ {
+ }
+
+ /**
+ * 澶勭悊瀹岃姹傚悗鎵ц
+ *
+ * @param joinPoint 鍒囩偣
+ */
+ @AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
+ public void doAfterReturning(JoinPoint joinPoint, Object jsonResult)
+ {
+ handleLog(joinPoint, null, jsonResult);
+ }
+
+ /**
+ * 鎷︽埅寮傚父鎿嶄綔
+ *
+ * @param joinPoint 鍒囩偣
+ * @param e 寮傚父
+ */
+ @AfterThrowing(value = "logPointCut()", throwing = "e")
+ public void doAfterThrowing(JoinPoint joinPoint, Exception e)
+ {
+ handleLog(joinPoint, e, null);
+ }
+
+ protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult)
+ {
+ try
+ {
+ // 鑾峰緱娉ㄨВ
+ Log controllerLog = getAnnotationLog(joinPoint);
+ if (controllerLog == null)
+ {
+ return;
+ }
+
+ // 鑾峰彇褰撳墠鐨勭敤鎴�
+ LoginUser loginUser = SpringUtils.getBean(TokenService.class).getLoginUser(ServletUtils.getRequest());
+
+ // *========鏁版嵁搴撴棩蹇�=========*//
+ SysOperLog operLog = new SysOperLog();
+ operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
+ // 璇锋眰鐨勫湴鍧�
+ String ip = ServletUtils.getClientIP();
+ operLog.setOperIp(ip);
+ // 杩斿洖鍙傛暟
+ operLog.setJsonResult(JsonUtils.toJsonString(jsonResult));
+
+ operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
+ if (loginUser != null)
+ {
+ operLog.setOperName(loginUser.getUsername());
+ }
+
+ if (e != null)
+ {
+ operLog.setStatus(BusinessStatus.FAIL.ordinal());
+ operLog.setErrorMsg(StrUtil.sub(e.getMessage(), 0, 2000));
+ }
+ // 璁剧疆鏂规硶鍚嶇О
+ String className = joinPoint.getTarget().getClass().getName();
+ String methodName = joinPoint.getSignature().getName();
+ operLog.setMethod(className + "." + methodName + "()");
+ // 璁剧疆璇锋眰鏂瑰紡
+ operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
+ // 澶勭悊璁剧疆娉ㄨВ涓婄殑鍙傛暟
+ getControllerMethodDescription(joinPoint, controllerLog, operLog);
+ // 淇濆瓨鏁版嵁搴�
+ SpringUtils.getBean(AsyncService.class).recordOper(operLog);
+ }
+ catch (Exception exp)
+ {
+ // 璁板綍鏈湴寮傚父鏃ュ織
+ log.error("==鍓嶇疆閫氱煡寮傚父==");
+ log.error("寮傚父淇℃伅:{}", exp.getMessage());
+ exp.printStackTrace();
+ }
+ }
+
+ /**
+ * 鑾峰彇娉ㄨВ涓鏂规硶鐨勬弿杩颁俊鎭� 鐢ㄤ簬Controller灞傛敞瑙�
+ *
+ * @param log 鏃ュ織
+ * @param operLog 鎿嶄綔鏃ュ織
+ * @throws Exception
+ */
+ public void getControllerMethodDescription(JoinPoint joinPoint, Log log, SysOperLog operLog) throws Exception
+ {
+ // 璁剧疆action鍔ㄤ綔
+ operLog.setBusinessType(log.businessType().ordinal());
+ // 璁剧疆鏍囬
+ operLog.setTitle(log.title());
+ // 璁剧疆鎿嶄綔浜虹被鍒�
+ operLog.setOperatorType(log.operatorType().ordinal());
+ // 鏄惁闇�瑕佷繚瀛榬equest锛屽弬鏁板拰鍊�
+ if (log.isSaveRequestData())
+ {
+ // 鑾峰彇鍙傛暟鐨勪俊鎭紝浼犲叆鍒版暟鎹簱涓��
+ setRequestValue(joinPoint, operLog);
+ }
+ }
+
+ /**
+ * 鑾峰彇璇锋眰鐨勫弬鏁帮紝鏀惧埌log涓�
+ *
+ * @param operLog 鎿嶄綔鏃ュ織
+ * @throws Exception 寮傚父
+ */
+ private void setRequestValue(JoinPoint joinPoint, SysOperLog operLog) throws Exception
+ {
+ String requestMethod = operLog.getRequestMethod();
+ if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod))
+ {
+ String params = argsArrayToString(joinPoint.getArgs());
+ operLog.setOperParam(StrUtil.sub(params, 0, 2000));
+ }
+ else
+ {
+ Map<?, ?> paramsMap = (Map<?, ?>) ServletUtils.getRequest().getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
+ operLog.setOperParam(StrUtil.sub(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)
+ {
+ StringBuilder params = new StringBuilder();
+ if (paramsArray != null && paramsArray.length > 0)
+ {
+ for (Object o : paramsArray) {
+ if (Validator.isNotNull(o) && !isFilterObject(o)) {
+ params.append(JsonUtils.toJsonString(o)).append(" ");
+ }
+ }
+ }
+ return params.toString().trim();
+ }
+
+ /**
+ * 鍒ゆ柇鏄惁闇�瑕佽繃婊ょ殑瀵硅薄銆�
+ *
+ * @param o 瀵硅薄淇℃伅銆�
+ * @return 濡傛灉鏄渶瑕佽繃婊ょ殑瀵硅薄锛屽垯杩斿洖true锛涘惁鍒欒繑鍥瀎alse銆�
+ */
+ @SuppressWarnings("rawtypes")
+ public boolean isFilterObject(final Object o)
+ {
+ Class<?> clazz = o.getClass();
+ if (clazz.isArray())
+ {
+ return clazz.getComponentType().isAssignableFrom(MultipartFile.class);
+ }
+ else if (Collection.class.isAssignableFrom(clazz))
+ {
+ Collection collection = (Collection) o;
+ 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;
+ }
+ }
+ return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse
+ || o instanceof BindingResult;
+ }
+}
--
Gitblit v1.9.3