SpringBoot使用AOP统一处理日志

港控/mmm° 2021-09-21 02:36 361阅读 0赞

我们已经学会了如何使用日志输出，可是如果在controller的类中每个方法名都写一个log输出肯定是不明智的选择。使用spring的AOP功能即可完成。

1. 在pom.xml中添加aspect依赖包。

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

2. 添加全局的WebLogAspect类。

@Aspect
    @Component
    public class WebLogAspect {
        private Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
        @Pointcut("execution(public * com.xmr.controller..*.*(..))")
        public void webLog(){        
        }
        
        @Before("webLog()")
        public void doBefore(JoinPoint joinPoint){
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
            // 记录下请求内容
            logger.info("URL : " + request.getRequestURL().toString());
            logger.info("HTTP_METHOD : " + request.getMethod());
            logger.info("IP : " + request.getRemoteAddr());
            Enumeration<String> enu = request.getParameterNames();
            while (enu.hasMoreElements()) {
                String name = (String) enu.nextElement();
                logger.info("name:{},value:{}", name, request.getParameter(name));
            }        
        }
        
        @AfterReturning(returning = "ret", pointcut = "webLog()")
        public void doAfterReturning(Object ret) throws Throwable {
            // 处理完请求，返回内容
            logger.info("RESPONSE : " + ret);
        }
    }

@Pointcut("execution(public \* com.xmr.controller..\*.\*(..))")

上面这段注解的意思如下：

1) execution(): 表达式主体

2) 第一个public \*号：表示返回类型， \*号表示所有的类型。

3) 包名：表示需要拦截的包名，后面的两个句点表示当前包和当前包的所有子包，com.xmr.controller包、子包下所有类的方法。

4) 第二个\*号：表示类名，\*号表示所有的类。

5) \*(..):最后这个星号表示方法名，\*号表示所有的方法，后面括弧里面表示方法的参数，两个句点表示任何参数

运行代码，调用controller类中的方法，我们可以看到控制台输出：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3h1ZW1lbmdydWkxMg_size_16_color_FFFFFF_t_70][]

小弟才疏学浅，如有不当之处，还望不吝赐教

参考：

[https://www.cnblogs.com/30go/p/8443522.html][https_www.cnblogs.com_30go_p_8443522.html]

[https://www.jb51.net/article/133420.htm][https_www.jb51.net_article_133420.htm]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3h1ZW1lbmdydWkxMg_size_16_color_FFFFFF_t_70]: /images/20210920/c345e84a595147fcaa2df12d06b4ad8c.png
[https_www.cnblogs.com_30go_p_8443522.html]: https://www.cnblogs.com/30go/p/8443522.html
[https_www.jb51.net_article_133420.htm]: https://www.jb51.net/article/133420.htm