aop log

pom.xml

@@ -99,6 +99,10 @@
             <artifactId>h2</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-aop</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/com/zhangshu/chat/demo/config/WebLogAspect.java

@@ -0,0 +1,85 @@
+package com.zhangshu.chat.demo.config;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import lombok.extern.slf4j.Slf4j;
+import org.aspectj.lang.JoinPoint;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.*;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+
+import javax.servlet.http.HttpServletRequest;
+
+@Slf4j
+@Aspect
+@Component
+public class WebLogAspect {
+
+    @Autowired
+    ObjectMapper objectMapper;
+
+    /**
+     * 以 controller 包下定义的所有请求为切入点
+     */
+    @Pointcut("execution(public * com.zhangshu.chat.demo.controller..*.*(..))")
+    public void webLog() {
+    }
+
+    /**
+     * 在切点之前织入
+     *
+     * @param joinPoint
+     * @throws Throwable
+     */
+    @Before("webLog()")
+    public void doBefore(JoinPoint joinPoint) throws Throwable {
+        // 开始打印请求日志
+        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
+        HttpServletRequest request = attributes.getRequest();
+
+        // 打印请求相关参数
+        log.info("========================================== Start ==========================================");
+        // 打印请求 url
+        log.info("URL            : {}", request.getRequestURL().toString());
+        // 打印 Http method
+        log.info("HTTP Method    : {}", request.getMethod());
+        // 打印调用 controller 的全路径以及执行方法
+        log.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
+        // 打印请求的 IP
+        log.info("IP             : {}", request.getRemoteAddr());
+        // 打印请求入参
+        log.info("Request Args   : {}", objectMapper.writeValueAsString(joinPoint.getArgs()));
+    }
+
+    /**
+     * 在切点之后织入
+     *
+     * @throws Throwable
+     */
+    @After("webLog()")
+    public void doAfter() throws Throwable {
+        log.info("=========================================== End ===========================================");
+        // 每个请求之间空一行
+        log.info("");
+    }
+
+    /**
+     * 环绕
+     *
+     * @param proceedingJoinPoint
+     * @return
+     * @throws Throwable
+     */
+    @Around("webLog()")
+    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
+        long startTime = System.currentTimeMillis();
+        Object result = proceedingJoinPoint.proceed();
+        // 打印出参
+        log.info("Response Args  : {}", objectMapper.writeValueAsString(result));
+        // 执行耗时
+        log.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
+        return result;
+    }
+}