Spring Boot使用【AOP】来实现需求

说明：

（1） 一个问题自己要明白：【J2EE中的过滤器】、【Spring 中的AOP】、【Spring MVC中的拦截器】；这三个东西看着挺类似的，但这三者是不同的东西；只是，有时在面对同一个需求时，使用这三个东西貌似都可以解决，而已；简单说明如下：

●【过滤器】是在J2EE的标准；这个组件的主要作用就是以url为抓手，来处理请求与响应；可以参考【常用功能与过滤器内容概述】中的内容；

●【AOP】是在Spring中定义的；其主要作用是以目标类/目标方法为抓手，来给目标类增加功能；可以参考【Spring】中的内容；自然，因为通过【RequestContextHolder】可以获取当前的request对象；所以，如果我们的【AOP】处理的目标类/目标方法是Controller中处理请求与响应的方法的话，那么使用【AOP】技术也可以来处理请求与响应；这也是为什么本篇博客使用【AOP】技术来实现【打印请求与响应信息的日志】这个需求的原因；

●【拦截器】是Spring MVC的标准组件；这个组件也是以url为抓手，来处理请求与响应的；【拦截器】和【过滤器】功能类似，但二者是两个不同的东西；同时【拦截器】底层最基本的实现，就是依赖于Spring AOP理念的；可以参考【SpringMVC】中的内容；

● 有关【J2EE中的过滤器】、【Spring 中的AOP】、【Spring MVC中的拦截器】三者区别的内容；可以参考【Spring 过滤器拦截器 AOP区别】，【附加J2EE中的过滤器Spring中的AOPSpringMVC中的拦截器的区别】；

（2） 这儿在使用AOP注解开发方式时，第一次介绍了【@Pointcut】注解，以及【@Before(“webLog()”)】和【@AfterReturning(returning = “res”, pointcut = “webLog()”)】；积累下来就行；

（3） 本篇博客介绍了【RequestContextHolder】，其可以获取当前的request对象；关于【RequestContextHolder】的详细内容，可以参考【附加RequestContextHolder可以实现在非Controller的方法中获取HttpServletRequest】；

问题： 为什么要使用AOP统一处理web请求日志？

使用AOP去统一处理web请求日志，这样的系统会更加健壮、简洁、效率高。

1.引入【AOP】依赖；

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

说明：

（1） 有关AOP的内容，可以参考【【Spring AOP面向切面编程】的一个引入案例】及附近相关文章；

（2） 同样，我们在SpringBoot项目中，引入aop依赖时，也不用自己去设置版本（Spring Boot已经设置了默认对应的版本）；

（3） 当我们引入aop依赖后，aop依赖会被添加进来，对应的【 aspectjweaver模块 】也会被引入进来；

2.创建WebLogAspect切面类，去实现【拦截请求与响应】，以打印请求与响应的信息；（核心重点！！！）

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() {
 
        }
 
        /**
         * 处理请求的信息
         * @param joinPoint
         */
        @Before("webLog()")
        public void doBefore(JoinPoint joinPoint) {
            //收到请求，记录请求内容
            ServletRequestAttributes attributes =(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
 
            log.info("URL :" + request.getRequestURL().toString());//请求的url信息
            log.info("HTTP_METHOD :" + request.getMethod());//请求的类型
            log.info("IP :" + request.getRemoteAddr());//请求的ip地址
            //目标类/目标方法的：类和方法名
            log.info("CLASS_METHOD" +  joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
            //请求的参数
            log.info("ARGS :" + Arrays.toString(joinPoint.getArgs()));
        }
 
        /**
         * 处理响应的信息
         * @param res
         * @throws JsonProcessingException
         */
        @AfterReturning(returning = "res", pointcut = "webLog()")
        public void doAfterReturning(Object res) throws JsonProcessingException {
            //处理完请求，返回内容
            log.info("RESPONSE :" + new  ObjectMapper().writeValueAsString(res));
 
        }
    }

说明：

（0） 有关AOP的内容，如果忘记了可以参考【📁MK Spring】专栏中的内容；

（1） 这儿的AOP我们采用的注解方式开发的；可以参考【基于注解开发Spring AOP】;

（2） 在类上使用的@Component注解的作用是把这个类对象用IoC管理起来；@Aspect注解的作用是说明这个类是一个切面类；这些内容在【基于注解开发Spring AOP】中有详细介绍；

（3） 因为这儿的需求是：拦截请求与响应，获取其中的信息，打印到日志中；所以，这儿我们使用的是【 Before Advice： 前置通知】和【 After Returning Advice： 返回后通知】来实现这个需求；

（4） 但是，可以看到这儿的写法和【基于注解开发Spring AOP】中的写法，看起来好像不一样；对此，请看以下说明：（这儿也第一次看到了AOP注解开发方式中的@Pointcut注解）

● 问：

● 答：

（5） 这儿使用到了【RequestContextHolder】去获取当前的request对象；这是一个新内容，有关【RequestContextHolder】的内容，可以参考【附加RequestContextHolder可以实现在非Controller的方法中获取HttpServletRequest】；