SpringBoot AOP 记录WEB请求日志

野性酷女 2022-06-16 08:22 184阅读 0赞

接上一篇文章：  
[http://blog.csdn.net/catoop/article/details/71541612][http_blog.csdn.net_catoop_article_details_71541612]

实现AOP的切面主要有以下几个要素：

使用@Aspect注解将一个java类定义为切面类  
使用@Pointcut定义一个切入点，可以是一个规则表达式，比如下例中某个package下的所有函数，也可以是一个注解等。  
根据需要在切入点不同位置的切入内容  
使用@Before在切入点开始处切入内容  
使用@After在切入点结尾处切入内容  
使用@AfterReturning在切入点return内容之后切入内容（可以用来对处理返回值做一些加工处理）  
使用@Around在切入点前后切入内容，并自己控制何时执行切入点自身的内容  
使用@AfterThrowing用来处理当切入内容部分抛出异常之后的处理逻辑

下面附上代码，我觉得真没有必要啰嗦的去解释了，看一下就明了

package com.shanhy.sboot.aoplog;
    
    import java.util.Arrays;
    
    import javax.servlet.http.HttpServletRequest;
    
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.AfterReturning;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.aspectj.lang.annotation.Pointcut;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    import org.springframework.web.context.request.RequestContextHolder;
    import org.springframework.web.context.request.ServletRequestAttributes;
    
    @Aspect
    @Component
    public class WebLogAspect {
    
        private static final Logger LOG = LoggerFactory.getLogger(WebLogAspect.class);
    
        @Pointcut("execution(public * com.shanhy.sboot..controller.*.*(..))")//两个..代表所有子目录，最后括号里的两个..代表所有参数
        public void logPointCut() {
        }
    
        @Before("logPointCut()")
        public void doBefore(JoinPoint joinPoint) throws Throwable {
            // 接收到请求，记录请求内容
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
    
            // 记录下请求内容
            LOG.info("请求地址 : " + request.getRequestURL().toString());
            LOG.info("HTTP METHOD : " + request.getMethod());
            LOG.info("IP : " + request.getRemoteAddr());
            LOG.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
                    + joinPoint.getSignature().getName());
            LOG.info("参数 : " + Arrays.toString(joinPoint.getArgs()));
    
        }
    
        @AfterReturning(returning = "ret", pointcut = "logPointCut()")// returning的值和doAfterReturning的参数名一致
        public void doAfterReturning(Object ret) throws Throwable {
            // 处理完请求，返回内容
            LOG.info("返回值 : " + ret);
        }
    
        @Around("logPointCut()")
        public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
            long startTime = System.currentTimeMillis();
            Object ob = pjp.proceed();// ob 为方法的返回值
            LOG.info("耗时 : " + (System.currentTimeMillis() - startTime));
            return ob;
        }
    
    }

package com.shanhy.sboot.demo.controller;
    
    import java.util.concurrent.TimeUnit;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @RequestMapping("/log")
    public class WebLogTestController {
    
        @RequestMapping("/test")
        public String test() {
            try {
                TimeUnit.SECONDS.sleep(5);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            return "TEST";
        }
    
    }

结束。

[http_blog.csdn.net_catoop_article_details_71541612]: http://blog.csdn.net/catoop/article/details/71541612