Spring Boot电商项目11：数据库设计与项目初始化六：使用【AOP】来实现【打印，请求与响应的，日志信息】的需求；（遇到了RequestContextHolder来获取请求与响应对象）

86 阅读 0 评论 57 点赞

我是靠谱客的博主坦率草莓，最近开发中收集的这篇文章主要介绍Spring Boot电商项目11：数据库设计与项目初始化六：使用【AOP】来实现【打印，请求与响应的，日志信息】的需求；（遇到了RequestContextHolder来获取请求与响应对象），觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

说明：

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

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

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

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

● 有关【J2EE中的过滤器】、【Spring 中的AOP】、【Spring MVC中的拦截器】三者区别的内容；可以参考【Spring 过滤器拦截器 AOP区别】，【附加：【J2EE中的过滤器】、【Spring 中的AOP】、【Spring MVC中的拦截器】的区别；（不要看，没写完……）】；

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

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

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

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

1.引入【AOP】依赖；

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

3.启动项目，观察效果；

1.引入【AOP】依赖；
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
说明：

（1）有关AOP的内容，可以参考【Spring AOP面向切面编程2：初识AOP二：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的内容，如果忘记了可以参考【（15）Spring基础：IoC；AOP；JDBC；】专栏中的内容；

（1）这儿的AOP我们采用的注解方式开发的；可以参考【Spring AOP面向切面编程8：基于注解开发Spring AOP；（@Aspect，@Around）】;

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

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

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

● 问：

● 答：

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

（6）有关打印日志的内容：【Logger log = LoggerFactory.getLogger(WebLogAspect.class);】使用指定类初始化日志对象，在日志输出的时候，可以打印出日志信息所在类；【log.info()】把info级别的日志信息输出；

这在以前遇到多，如果需要可以参考：

【【logger.error()】介绍；（只是将日志打印在Console控制台）】；

【OA系统十八：请假申请四：【请假申请】这个内嵌界面中【提交请假表单数据】的Controller层；】；

【Spring MVC拦截器3：拦截器案例：开发【获取“用户流量信息”的拦截器】；（logback日志组件：把日志存储到日志文件中；）】；

（7）处理【Before Advice：前置通知】的方法说明：获取请求中信息，打印到日志中；

（8）【After Returning Advice：返回后通知】：获取响应中的信息，打印到日志中；