Spring Boot使用AOP方式实现统一的Web请求日志记录？

AOP简介

AOP(Aspect Oriented Programming)，面相切面编程，是通过代码预编译与运行时动态代理的方式来实现程序的统一功能维护的方案。AOP作为Spring框架的核心内容，通过对程序设置一个切入点，然后在这个切入点上接入不同的执行内容来完成不同的操作。

例如在数据库事务管理方面，用来开启和提交和关闭事务，在记录日志方面，可以在不同的业务处理逻辑中切入日志记录操作。

由于AOP技术只是在切入点上进行工作，并不会破坏原有的程序执行逻辑，所以他对于业务逻辑的影响超级低，从而使得业务逻辑之间的耦合度较低，提升了程序代码的可复用性，同时也提高了开发效率。

下面我们就来介绍一下如何在Spring Boot引入AOP功能并且，通过AOP功能来实现一个Web请求日志处理功能。

准备工作

由于需要用到关于Web请求相关的内容，所以需要在项目中引入Web模块。

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

其次需要实现一个简单的Get请求处理器，如下所示。

@RestController
public class TestController {

    @GetMapping("/test")
    public String test(@RequestParam String name){
        return "Hello World!";
    }
}

引入AOP相关依赖

在做好上面的准备工作之后，接下来就是需要引入AOP模块，如下所示。

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

引入了AOP的依赖之后，并不需要去做一些其他的配置，由于Spring Boot主打的就是自动依赖，自动配置。所以接下来就是需要实现Web层的日志切面。

实现Web层日志切面

在实现AOP切面之前需要知道AOP的几个实现要素

使用@Aspect注解将一个类定义为切面类
使用@Pointcut注解来定义一个切点，并且这里可以指定一个规则表达式，用来匹配某个函数方法，或者是某个包路径等。
根据不同的切点引入不同的切入内容，例如@Before、@After、@AfterReturning、@Around、@AfterThrowing等注解。分别是在前，后、返回前、环绕、报错之后进行操作处理。

编写测试类

@Aspect
@Component
public class WebLogAspect {

    private Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * com.example.demo..*.*(..))")
    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());
        logger.info("CLASS_METHOD :"+joinPoint.getSignature().getDeclaringTypeName()
                +"."+joinPoint.getSignature().getName());
        logger.info("ARGS :"+ Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "ret",pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable{
        logger.info("请求处理完成");
        logger.info("RESPONS :"+ret);
    }
}