使用AOP统一处理WEB请求日志

蔚落 2023-09-28 16:50 1阅读 0赞

在实际开发中，我们可能会经常用到log.info(),这句代码会出现多次，使代码比较[冗余][Link 1]，通过aop原理可以帮助我们减少冗余代码。这是为了系统健壮性的一种保证，用filter把每一个请求都打印出来，可以提高调试开发的效率

首先在pom.[xml][]里面配置依赖

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-aop</artifactId>
    		</dependency>

然后建一个过滤器，对我们的请求进行拦截和打印

创建一个文件夹filter类WebLogAspect

package com.imooc.mall.filter;
    
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.annotation.AfterReturning;
    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;
    
    import javax.servlet.http.HttpServletRequest;
    import java.util.Arrays;
    
    /**
     * 描述： 打印请求和响应信息
     */
    @Aspect
    @Component
    public class WebLogAspect {
        private final Logger log= LoggerFactory.getLogger(WebLogAspect.class);
    
        @Pointcut("execution(public * com.imooc.mall.controller.*.*(..))")
        public void webLog(){
    
        }
    
        @Before("webLog()")
        public void doBefore(JoinPoint joinPoint){
            //收到记录，记录请求信息
            ServletRequestAttributes attributes=(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
            HttpServletRequest request=attributes.getRequest();
    
            log.info("URL:"+request.getRequestURL().toString());
            log.info("HTTP_METHOD:"+request.getMethod());
            log.info("IP:"+request.getRemoteAddr());
            log.info(joinPoint.getSignature().getDeclaringTypeName()+"."+joinPoint.getSignature().getName());
            log.info("ARGS:"+ Arrays.toString(joinPoint.getArgs()));
        }
    
        @AfterReturning(returning = "res",pointcut = "webLog()")
        public void doAfterReturning(Object res) throws JsonProcessingException {
            //处理完请求，返回内容
            log.info("RESPONSE:"+new ObjectMapper().writeValueAsString(res));
        }
    }

在运行测试时，发现已经可以实现打印功能了

![b7c9365bfc304c59900b45f377b1e5f6.png][]

[Link 1]: https://so.csdn.net/so/search?q=%E5%86%97%E4%BD%99&spm=1001.2101.3001.7020
[xml]: https://so.csdn.net/so/search?q=xml&spm=1001.2101.3001.7020
[b7c9365bfc304c59900b45f377b1e5f6.png]: https://img-blog.csdnimg.cn/b7c9365bfc304c59900b45f377b1e5f6.png