SpringBoot 整合 AOP

一、什么是AOP

AOP：Aspect-OrientedProgramming 面向切面编程
aop采用横向抽取机制，将散落在各个方法中的重复代码提取出来，然后再程序编译或运行时，再将这些提取出来的代码应用到需要执行的地方

• Aspect (切面) 值封装的用于横向插入到系统功能(事务、日志)的类，该类要被Spring容器识别为切面
• Joinpoint (连接点）程序执行过程中的某个阶段点，实际上是对象的一个操作，。如方法的调用或异常的抛出。在Spring AOP中，连接端指方法的调用
• Pointcut（切入点）指切面与程序流程的交叉点，即哪些需要处理的连接点。通常指类名或方法名，及其匹配方式
• Advice（通知/增强处理）在定义好的切入点处要执行的程序代码，可理解为切面类中的方法，它是切面的具体实现

二、 与SpringBoot结合：依赖

• maven

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

• gradle

compile group: 'org.springframework.boot', name: 'spring-boot-starter-aop', version: '2.1.4.RELEASE'

三、切面类：WebLogAcpect

package com.example.fileupload.aop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
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 WebLogAcpect {

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

    /**
     * 定义切入点，切入点为com.example.fileupload.controller下的所有函数
     */
    @Pointcut("execution(public * com.example.fileupload.controller.*.*(..))")
    
    /*
    * 定义连接点
    */
    public void webLog() {
    }

    /**
     * 前置通知：在连接点之前执行的通知
     *
     * @param joinPoint
     * @throws Throwable
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 记录下请求内容
        logger.info("记录Controller日志");
        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()));
    }

    // 后置最终通知（目标方法只要执行完了就会执行后置通知方法） 
    @After("webLog()")
    public void doAfterAdvice(JoinPoint joinPoint){
        logger.info("后置通知执行了!!!!");
    }

    // 后置返回通知 
    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容
        logger.info("RESPONSE : " + ret);
    }

    // 后置异常通知 
    @AfterThrowing(pointcut = "webLog()",throwing = "exception")
    public void doAfterThrowingAdvice(JoinPoint joinPoint,Throwable exception){
        //目标方法名：
        logger.info(joinPoint.getSignature().getName());
        if(exception instanceof NullPointerException){
            logger.info("发生了空指针异常!!!!!");
        }
    }

    // 环绕通知 
    @Around("webLog()")
    public Object doAroundAdvice(ProceedingJoinPoint proceedingJoinPoint){
        logger.info("环绕通知的目标方法名："+proceedingJoinPoint.getSignature().getName());
        try {
            Object obj = proceedingJoinPoint.proceed();
            return obj;
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        return null;
    }
}

参考：https://blog.csdn.net/lmb55/article/details/82470388