RequestLogAspect.java 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. package com.persagy.aspects;
  2. import cn.hutool.core.util.ArrayUtil;
  3. import cn.hutool.core.util.IdUtil;
  4. import cn.hutool.core.util.StrUtil;
  5. import cn.hutool.extra.servlet.ServletUtil;
  6. import com.persagy.dmp.common.model.response.CommonResult;
  7. import com.persagy.dmp.common.utils.JsonHelper;
  8. import lombok.extern.slf4j.Slf4j;
  9. import org.aspectj.lang.JoinPoint;
  10. import org.aspectj.lang.annotation.*;
  11. import org.springframework.context.annotation.EnableAspectJAutoProxy;
  12. import org.springframework.stereotype.Component;
  13. import org.springframework.web.context.request.RequestContextHolder;
  14. import org.springframework.web.context.request.ServletRequestAttributes;
  15. import org.springframework.web.multipart.MultipartFile;
  16. import javax.servlet.ServletRequest;
  17. import javax.servlet.ServletResponse;
  18. import javax.servlet.http.HttpServletRequest;
  19. import java.util.LinkedList;
  20. import java.util.List;
  21. /**
  22. * @author: yaoll
  23. * @date: 2020-09-22
  24. * @verison: 1.0
  25. */
  26. @Slf4j
  27. @Aspect
  28. @Component
  29. @EnableAspectJAutoProxy
  30. public class RequestLogAspect {
  31. private static final ThreadLocal<LogData> dataStorage = new ThreadLocal<>();
  32. @Pointcut("execution(public * com.persagy.dmp..*.controller.*.*(..))")
  33. //@Pointcut("execution(* *(..))")
  34. public void controllerPoint() {
  35. }
  36. @Before("controllerPoint()")
  37. public void doBefore(JoinPoint joinPoint) {
  38. ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  39. if (null == attributes) {
  40. log.warn("获取请求参数失败!!");
  41. return;
  42. }
  43. HttpServletRequest request = attributes.getRequest();
  44. LogData data = initFlag(request);
  45. dataStorage.set(data);
  46. log.info("{} REQUEST URL : {} {} {} {}", data.intFlag, data.method, data.url, data.remoteIp, data.remotePort);
  47. log.info("{} REQUEST ARGS : {} ", data.intFlag, JsonHelper.toJsonStrQuietly(prepare(joinPoint)));
  48. }
  49. /**
  50. * 准备数据
  51. * @param joinPoint
  52. * @return
  53. */
  54. public static List<Object> prepare(JoinPoint joinPoint) {
  55. Object[] args = joinPoint.getArgs();
  56. List<Object> list = new LinkedList<>();
  57. if(ArrayUtil.isEmpty(args)) {
  58. return list;
  59. }
  60. for (Object arg : args) {
  61. if (arg instanceof ServletRequest ||
  62. arg instanceof ServletResponse ||
  63. arg instanceof MultipartFile) {
  64. continue;
  65. }
  66. list.add(arg);
  67. }
  68. return list;
  69. }
  70. @AfterReturning(returning = "ret", pointcut = "controllerPoint()")
  71. public void doAfterReturning(Object ret) {
  72. LogData data = dataStorage.get();
  73. String result = null;
  74. if (ret != null) {
  75. if (ret instanceof CommonResult) {
  76. result = ((CommonResult) ret).getResult();
  77. } else {
  78. result = ret.getClass().getName();
  79. }
  80. }
  81. log.info("{} REQUEST DURATION : {} {} {}", data.intFlag, System.currentTimeMillis() - data.timestamp, result, data.url);
  82. dataStorage.remove();
  83. }
  84. @AfterThrowing(throwing = "ex", pointcut = "controllerPoint()")
  85. public void doAfterThrowing(Throwable ex) {
  86. LogData data = dataStorage.get();
  87. log.error("{} REQUEST EXCEPTION: {} {} {}", data.intFlag, System.currentTimeMillis() - data.timestamp, data.url, ex);
  88. dataStorage.remove();
  89. }
  90. /**
  91. * 初始化日志记录
  92. * @param request
  93. * @return
  94. */
  95. private static LogData initFlag(HttpServletRequest request) {
  96. LogData data = new LogData();
  97. // 请求IP
  98. data.remoteIp = ServletUtil.getClientIP(request, null);
  99. // 请求端口
  100. data.remotePort = request.getRemotePort();
  101. data.timestamp = System.currentTimeMillis();
  102. data.method = request.getMethod();
  103. String requestURI = request.getRequestURI();
  104. String queryString = request.getQueryString();
  105. data.url = StrUtil.isBlank(queryString) ? requestURI : StrUtil.concat(true, requestURI, "?", queryString);
  106. data.intFlag = IdUtil.fastSimpleUUID();
  107. dataStorage.set(data);
  108. return data;
  109. }
  110. /***
  111. * Description: 日志数据实体
  112. * @author : lijie
  113. * @date :2021/8/18 10:36
  114. * Update By lijie 2021/8/18 10:36
  115. */
  116. private static class LogData {
  117. private String intFlag;
  118. private Long timestamp;
  119. private String url;
  120. private String method;
  121. private String remoteIp;
  122. private Integer remotePort;
  123. }
  124. }