| | |
|---|
| | | package com.ruoyi.common.log.aspect;
|
|---|
| | |
|
|---|
| | | import java.lang.reflect.Method;
|
|---|
| | | import java.util.Collection;
|
|---|
| | | import java.util.Iterator;
|
|---|
| | | import java.util.Map;
|
|---|
| | | import javax.servlet.http.HttpServletRequest;
|
|---|
| | | import javax.servlet.http.HttpServletResponse;
|
|---|
| | | import jakarta.servlet.http.HttpServletRequest;
|
|---|
| | | import jakarta.servlet.http.HttpServletResponse;
|
|---|
| | | import org.apache.commons.lang3.ArrayUtils;
|
|---|
| | | 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.aspectj.lang.annotation.Before;
|
|---|
| | | import org.slf4j.Logger;
|
|---|
| | | import org.slf4j.LoggerFactory;
|
|---|
| | | import org.springframework.beans.factory.annotation.Autowired;
|
|---|
| | | import org.springframework.core.NamedThreadLocal;
|
|---|
| | | import org.springframework.http.HttpMethod;
|
|---|
| | | import org.springframework.stereotype.Component;
|
|---|
| | | import org.springframework.validation.BindingResult;
|
|---|
| | | import org.springframework.web.multipart.MultipartFile;
|
|---|
| | | import com.alibaba.fastjson.JSON;
|
|---|
| | | import com.ruoyi.common.core.utils.SecurityUtils;
|
|---|
| | | import com.alibaba.fastjson2.JSON;
|
|---|
| | | import com.ruoyi.common.core.text.Convert;
|
|---|
| | | import com.ruoyi.common.core.utils.ExceptionUtil;
|
|---|
| | | import com.ruoyi.common.core.utils.ServletUtils;
|
|---|
| | | import com.ruoyi.common.core.utils.StringUtils;
|
|---|
| | | import com.ruoyi.common.core.utils.ip.IpUtils;
|
|---|
| | | import com.ruoyi.common.log.annotation.Log;
|
|---|
| | | import com.ruoyi.common.log.enums.BusinessStatus;
|
|---|
| | | import com.ruoyi.common.log.filter.PropertyPreExcludeFilter;
|
|---|
| | | import com.ruoyi.common.log.service.AsyncLogService;
|
|---|
| | | import com.ruoyi.common.security.utils.SecurityUtils;
|
|---|
| | | import com.ruoyi.system.api.domain.SysOperLog;
|
|---|
| | |
|
|---|
| | | /**
|
|---|
| | |
|---|
| | | public class LogAspect
|
|---|
| | | {
|
|---|
| | | private static final Logger log = LoggerFactory.getLogger(LogAspect.class);
|
|---|
| | | |
|---|
| | |
|
|---|
| | | /** 排除敏感属性字段 */
|
|---|
| | | public static final String[] EXCLUDE_PROPERTIES = { "password", "oldPassword", "newPassword", "confirmPassword" };
|
|---|
| | |
|
|---|
| | | /** 计算操作消耗时间 */
|
|---|
| | | private static final ThreadLocal<Long> TIME_THREADLOCAL = new NamedThreadLocal<Long>("Cost Time");
|
|---|
| | |
|
|---|
| | | /** 参数最大长度限制 */
|
|---|
| | | private static final int PARAM_MAX_LENGTH = 2000;
|
|---|
| | |
|
|---|
| | | @Autowired
|
|---|
| | | private AsyncLogService asyncLogService;
|
|---|
| | |
|
|---|
| | | // 配置织入点
|
|---|
| | | @Pointcut("@annotation(com.ruoyi.common.log.annotation.Log)")
|
|---|
| | | public void logPointCut()
|
|---|
| | | /**
|
|---|
| | | * 处理请求前执行
|
|---|
| | | */
|
|---|
| | | @Before(value = "@annotation(controllerLog)")
|
|---|
| | | public void doBefore(JoinPoint joinPoint, Log controllerLog)
|
|---|
| | | {
|
|---|
| | | TIME_THREADLOCAL.set(System.currentTimeMillis());
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | /**
|
|---|
| | |
|---|
| | | *
|
|---|
| | | * @param joinPoint 切点
|
|---|
| | | */
|
|---|
| | | @AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
|
|---|
| | | public void doAfterReturning(JoinPoint joinPoint, Object jsonResult)
|
|---|
| | | @AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")
|
|---|
| | | public void doAfterReturning(JoinPoint joinPoint, Log controllerLog, Object jsonResult)
|
|---|
| | | {
|
|---|
| | | handleLog(joinPoint, null, jsonResult);
|
|---|
| | | handleLog(joinPoint, controllerLog, null, jsonResult);
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | /**
|
|---|
| | |
|---|
| | | * @param joinPoint 切点
|
|---|
| | | * @param e 异常
|
|---|
| | | */
|
|---|
| | | @AfterThrowing(value = "logPointCut()", throwing = "e")
|
|---|
| | | public void doAfterThrowing(JoinPoint joinPoint, Exception e)
|
|---|
| | | @AfterThrowing(value = "@annotation(controllerLog)", throwing = "e")
|
|---|
| | | public void doAfterThrowing(JoinPoint joinPoint, Log controllerLog, Exception e)
|
|---|
| | | {
|
|---|
| | | handleLog(joinPoint, e, null);
|
|---|
| | | handleLog(joinPoint, controllerLog, e, null);
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult)
|
|---|
| | | protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult)
|
|---|
| | | {
|
|---|
| | | try
|
|---|
| | | {
|
|---|
| | | // 获得注解
|
|---|
| | | Log controllerLog = getAnnotationLog(joinPoint);
|
|---|
| | | if (controllerLog == null)
|
|---|
| | | {
|
|---|
| | | return;
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | // *========数据库日志=========*//
|
|---|
| | | SysOperLog operLog = new SysOperLog();
|
|---|
| | | operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
|
|---|
| | | // 请求的地址
|
|---|
| | | String ip = IpUtils.getIpAddr(ServletUtils.getRequest());
|
|---|
| | | String ip = IpUtils.getIpAddr();
|
|---|
| | | operLog.setOperIp(ip);
|
|---|
| | | operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
|
|---|
| | | operLog.setOperUrl(StringUtils.substring(ServletUtils.getRequest().getRequestURI(), 0, 255));
|
|---|
| | | String username = SecurityUtils.getUsername();
|
|---|
| | | if (StringUtils.isNotBlank(username))
|
|---|
| | | {
|
|---|
| | |
|---|
| | | if (e != null)
|
|---|
| | | {
|
|---|
| | | operLog.setStatus(BusinessStatus.FAIL.ordinal());
|
|---|
| | | operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
|
|---|
| | | operLog.setErrorMsg(StringUtils.substring(Convert.toStr(e.getMessage(), ExceptionUtil.getExceptionMessage(e)), 0, 2000));
|
|---|
| | | }
|
|---|
| | | // 设置方法名称
|
|---|
| | | String className = joinPoint.getTarget().getClass().getName();
|
|---|
| | |
|---|
| | | operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
|
|---|
| | | // 处理设置注解上的参数
|
|---|
| | | getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
|
|---|
| | | // 设置消耗时间
|
|---|
| | | operLog.setCostTime(System.currentTimeMillis() - TIME_THREADLOCAL.get());
|
|---|
| | | // 保存数据库
|
|---|
| | | asyncLogService.saveSysLog(operLog);
|
|---|
| | | }
|
|---|
| | | catch (Exception exp)
|
|---|
| | | {
|
|---|
| | | // 记录本地异常日志
|
|---|
| | | log.error("==前置通知异常==");
|
|---|
| | | log.error("异常信息:{}", exp.getMessage());
|
|---|
| | | exp.printStackTrace();
|
|---|
| | | }
|
|---|
| | | finally
|
|---|
| | | {
|
|---|
| | | TIME_THREADLOCAL.remove();
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | |
|---|
| | | if (log.isSaveRequestData())
|
|---|
| | | {
|
|---|
| | | // 获取参数的信息，传入到数据库中。
|
|---|
| | | setRequestValue(joinPoint, operLog);
|
|---|
| | | setRequestValue(joinPoint, operLog, log.excludeParamNames());
|
|---|
| | | }
|
|---|
| | | // 是否需要保存response，参数和值
|
|---|
| | | if (log.isSaveResponseData() && StringUtils.isNotNull(jsonResult))
|
|---|
| | |
|---|
| | | * @param operLog 操作日志
|
|---|
| | | * @throws Exception 异常
|
|---|
| | | */
|
|---|
| | | private void setRequestValue(JoinPoint joinPoint, SysOperLog operLog) throws Exception
|
|---|
| | | private void setRequestValue(JoinPoint joinPoint, SysOperLog operLog, String[] excludeParamNames) throws Exception
|
|---|
| | | {
|
|---|
| | | String requestMethod = operLog.getRequestMethod();
|
|---|
| | | if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod))
|
|---|
| | | Map<?, ?> paramsMap = ServletUtils.getParamMap(ServletUtils.getRequest());
|
|---|
| | | if (StringUtils.isEmpty(paramsMap) && StringUtils.equalsAny(requestMethod, HttpMethod.PUT.name(), HttpMethod.POST.name(), HttpMethod.DELETE.name()))
|
|---|
| | | {
|
|---|
| | | String params = argsArrayToString(joinPoint.getArgs());
|
|---|
| | | operLog.setOperParam(StringUtils.substring(params, 0, 2000));
|
|---|
| | | String params = argsArrayToString(joinPoint.getArgs(), excludeParamNames);
|
|---|
| | | operLog.setOperParam(params);
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | /**
|
|---|
| | | * 是否存在注解，如果存在就获取
|
|---|
| | | */
|
|---|
| | | private Log getAnnotationLog(JoinPoint joinPoint) throws Exception
|
|---|
| | | {
|
|---|
| | | Signature signature = joinPoint.getSignature();
|
|---|
| | | MethodSignature methodSignature = (MethodSignature) signature;
|
|---|
| | | Method method = methodSignature.getMethod();
|
|---|
| | |
|
|---|
| | | if (method != null)
|
|---|
| | | else
|
|---|
| | | {
|
|---|
| | | return method.getAnnotation(Log.class);
|
|---|
| | | operLog.setOperParam(StringUtils.substring(JSON.toJSONString(paramsMap, excludePropertyPreFilter(excludeParamNames)), 0, PARAM_MAX_LENGTH));
|
|---|
| | | }
|
|---|
| | | return null;
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | /**
|
|---|
| | | * 参数拼装
|
|---|
| | | */
|
|---|
| | | private String argsArrayToString(Object[] paramsArray)
|
|---|
| | | private String argsArrayToString(Object[] paramsArray, String[] excludeParamNames)
|
|---|
| | | {
|
|---|
| | | String params = "";
|
|---|
| | | StringBuilder params = new StringBuilder();
|
|---|
| | | if (paramsArray != null && paramsArray.length > 0)
|
|---|
| | | {
|
|---|
| | | for (int i = 0; i < paramsArray.length; i++)
|
|---|
| | | for (Object o : paramsArray)
|
|---|
| | | {
|
|---|
| | | if (StringUtils.isNotNull(paramsArray[i]) && !isFilterObject(paramsArray[i]))
|
|---|
| | | if (StringUtils.isNotNull(o) && !isFilterObject(o))
|
|---|
| | | {
|
|---|
| | | try
|
|---|
| | | {
|
|---|
| | | Object jsonObj = JSON.toJSON(paramsArray[i]);
|
|---|
| | | params += jsonObj.toString() + " ";
|
|---|
| | | String jsonObj = JSON.toJSONString(o, excludePropertyPreFilter(excludeParamNames));
|
|---|
| | | params.append(jsonObj).append(" ");
|
|---|
| | | if (params.length() >= PARAM_MAX_LENGTH)
|
|---|
| | | {
|
|---|
| | | return StringUtils.substring(params.toString(), 0, PARAM_MAX_LENGTH);
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | catch (Exception e)
|
|---|
| | | {
|
|---|
| | | log.error("请求参数拼装异常 msg:{}, 参数:{}", e.getMessage(), paramsArray, e);
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | return params.trim();
|
|---|
| | | return params.toString();
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | /**
|
|---|
| | | * 忽略敏感属性
|
|---|
| | | */
|
|---|
| | | public PropertyPreExcludeFilter excludePropertyPreFilter(String[] excludeParamNames)
|
|---|
| | | {
|
|---|
| | | return new PropertyPreExcludeFilter().addExcludes(ArrayUtils.addAll(EXCLUDE_PROPERTIES, excludeParamNames));
|
|---|
| | | }
|
|---|
| | |
|
|---|
| | | /**
|
|---|
| | |
|---|
| | | else if (Collection.class.isAssignableFrom(clazz))
|
|---|
| | | {
|
|---|
| | | Collection collection = (Collection) o;
|
|---|
| | | for (Iterator iter = collection.iterator(); iter.hasNext();)
|
|---|
| | | for (Object value : collection)
|
|---|
| | | {
|
|---|
| | | return iter.next() instanceof MultipartFile;
|
|---|
| | | return value instanceof MultipartFile;
|
|---|
| | | }
|
|---|
| | | }
|
|---|
| | | else if (Map.class.isAssignableFrom(clazz))
|
|---|
| | | {
|
|---|
| | | Map map = (Map) o;
|
|---|
| | | for (Iterator iter = map.entrySet().iterator(); iter.hasNext();)
|
|---|
| | | for (Object value : map.entrySet())
|
|---|
| | | {
|
|---|
| | | Map.Entry entry = (Map.Entry) iter.next();
|
|---|
| | | Map.Entry entry = (Map.Entry) value;
|
|---|
| | | return entry.getValue() instanceof MultipartFile;
|
|---|
| | | }
|
|---|
| | | }
|
|---|
