（一）AOP 概要

1. 什么是 AOP ？

AOP是Aspect Oriented Programming的缩写，意为面向切面编程。
这是一种通过预编译方式和运行期间动态代理实现程序功能统一维护的技术。
相比传统的面向对象编程（OOP），AOP更关注于将系统中的公共功能（如日志记录、安全控制、事务处理、异常处理等）从业务逻辑中分离出来，形成独立的模块，以便在不影响业务逻辑代码的情况下，对这些公共功能进行集中管理和维护。

2. 为什么要用 AOP？

1. 降低耦合度：通过将公共功能从业务逻辑中分离出来，AOP可以显著降低系统各模块之间的耦合度，提高系统的可维护性和可扩展性。
2. 提高代码复用性：公共功能的独立化使得这些功能可以在多个地方重复使用，而无需在每个业务逻辑中都重复编写相同的代码。
3. 便于集中管理：AOP允许开发者将系统中的公共功能集中管理，便于统一维护和升级。
4. 提高开发效率：通过使用AOP，开发者可以更加专注于业务逻辑的实现，而无需花费过多时间在公共功能的编写和维护上。

3. AOP一般用来干什么？

1. 日志记录：在方法调用前后记录日志信息，帮助开发者进行性能分析和故障排查。
2. 安全控制：在方法调用前进行权限检查，确保只有具有相应权限的用户才能执行该方法。
3. 事务管理：在方法调用前后管理事务的开启、提交和回滚，确保数据的一致性和完整性。
4. 异常处理：在方法调用过程中捕获并处理异常，提供友好的错误消息给用户。
5. 性能监控：对方法调用的性能进行监控和分析，帮助开发者优化系统性能。
6. 缓存优化：通过缓存方法调用的结果来提高系统性能，减少不必要的计算和资源消耗。

4. AOP 的核心概念

名词	概念	理解
通知（Advice）	拦截到连接点之后所要执行的代码，通知分为前置、后置、异常、最终、环绕通知五类	我们要实现的功能，如日志记录，性能统计，安全控制，事务处理，异常处理等等，说明什么时候要干什么
连接点（Joint Point）	被拦截到的点，如被拦截的方法、对类成员的访问以及异常处理程序块的执行等等，自身还能嵌套其他的 Joint Point	Spring 允许你用通知的地方，方法有关的前前后后（包括抛出异常）
切入点（Pointcut）	对连接点进行拦截的定义	指定通知到哪个方法，说明在哪干
切面（Aspect）	切面类的定义，里面包含了切入点（Pointcut）和通知（Advice）的定义	切面就是通知和切入点的结合
目标对象（Target Object）	切入点选择的对象，也就是需要被通知的对象；由于 Spring AOP 通过代理模式实现，所以该对象永远是被代理对象	业务逻辑本身
织入（Weaving）	把切面应用到目标对象从而创建出 AOP 代理对象的过程。织入可以在编译期、类装载期、运行期进行，而 Spring 采用在运行期完成	切点定义了哪些连接点会得到通知
引入（Introduction ）	可以在运行期为类动态添加方法和字段，Spring 允许引入新的接口到所有目标对象	引入就是在一个接口/类的基础上引入新的接口增强功能
AOP 代理（AOP Proxy ）	Spring AOP 可以使用 JDK 动态代理或者 CGLIB 代理，前者基于接口，后者基于类	通过代理来对目标对象应用切面

（二）Spring AOP

1. 简述

AOP 是 Spring 框架中的一个核心内容。在 Spring 中，AOP 代理可以用 JDK 动态代理或者 CGLIB 代理 CglibAopProxy 实现。Spring 中 AOP 代理由 Spring 的 IOC 容器负责生成和管理，其依赖关系也由 IOC 容器负责管理。

2. 相关注解

注解	说明
@Aspect	将一个 java 类定义为切面类
@Pointcut	定义一个切入点，可以是一个规则表达式，比如下例中某个 package 下的所有函数， 也可以是一个注解等
@Before	在切入点开始处切入内容
@After	在切入点结尾处切入内容
@AfterReturning	在切入点 return 内容之后处理逻辑
@Around	在切入点前后切入内容，并自己控制何时执行切入点自身的内容
@AfterThrowing	用来处理当切入内容部分抛出异常之后的处理逻辑
@Order(100)	AOP 切面执行顺序， @Before 数值越小越先执行，@After 和 @AfterReturning 数值越大越先执行

其中 @Before、@After、@AfterReturning、@Around、@AfterThrowing 都属于通知（Advice）。

3. @Pointcut 切入点的不同表达式 示例

当然，以下是一些不同类型的切入点表达式（Pointcut Expressions）的示例，这些示例通常用于AOP（面向切面编程）框架中，如Spring AOP。

1. execution 表达式

这是最常用的切入点表达式，用于匹配方法执行的连接点。

// 匹配com.example.service包及其子包中所有类的所有方法
execution(* com.example.service..*.*(..))

// 匹配com.example.service.UserService类中所有的public方法
execution(public * com.example.service.UserService.*(..))

// 匹配所有返回类型为String，且方法名以find开头的public方法
execution(public String com.example..*.find*(..))

2. within 表达式

用于匹配连接点所在的Java类或包。

// 匹配com.example.service包及其子包中所有类的所有方法
within(com.example.service..*)

// 精确匹配com.example.service.UserService类中的所有方法
within(com.example.service.UserService)

注意：within表达式通常用于类型匹配，而不是方法签名匹配。

3. this 和 target 表达式

this和target表达式用于匹配代理对象或目标对象。它们通常用于基于对象类型的过滤，而不是方法签名。

// 匹配代理对象实现了MyInterface接口的所有连接点
this(com.example.MyInterface)

// 匹配目标对象实现了MyInterface接口的所有连接点
target(com.example.MyInterface)

注意：这些表达式在Spring AOP中可能不直接支持，因为Spring AOP是基于代理的，并且this和target的区分在JDK动态代理和CGLIB代理中可能有所不同。但在AspectJ等更强大的AOP框架中，这些表达式是支持的。

4. args 表达式

args表达式用于匹配方法参数。

// 匹配所有第一个参数为String类型的方法
args(String, ..)

// 匹配所有参数中包含至少一个String类型的方法
args(.., String, ..)

// 精确匹配第一个参数为特定类型的方法
args(com.example.MyType, ..)

注意：args表达式中的参数类型是按顺序匹配的，但可以使用..来匹配任意数量的额外参数。

5. @annotation、@within、@target 和 @args 表达式

这些表达式基于注解来匹配连接点。

// 匹配所有被@Transactional注解标注的方法
@annotation(org.springframework.transaction.annotation.Transactional)

// 匹配所有在类级别被@Transactional注解标注的类中的方法
@within(org.springframework.transaction.annotation.Transactional)

// 匹配所有目标对象（不是代理对象）被@Service注解标注的类中的方法
@target(org.springframework.stereotype.Service)

// 匹配所有至少有一个参数被@Valid注解标注的方法
@args(javax.validation.Valid, ..)

这些表达式提供了强大的灵活性，允许开发者基于注解来定义切面的应用范围。

请注意，具体的语法和支持程度可能会根据你所使用的AOP框架（如Spring AOP、AspectJ等）而有所不同。上述示例主要基于Spring AOP和AspectJ的通用语法。

（三）开始使用

1. 引入AOP依赖

在Spring Boot中引入AOP就跟引入其他模块一样，非常简单，只需要在pom.xml中加入如下依赖：

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

2. 自定义注解

由于面向切面的切入点（Pointcut）支持多种写法，
我这边也用了注解形式的写法，因此就自定义了以下这个注解，供后面测试使用

package com.example.reactboot.aop;

import java.lang.annotation.*;

/**
 * 自定义注解类
 */
@Target(ElementType.METHOD) //注解放置的目标位置,METHOD是可注解在方法级别上
@Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行
@Documented //生成文档

public @interface  Aoplog {
    String value() default "";
}

3. 切面类

package com.example.reactboot.aop;


import com.google.gson.Gson;
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.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

/**
 * 系统日志：切面处理类
 *
 * @Aspect：声明该类为一个注解类；
 * @Pointcut：定义一个切点，后面跟随一个表达式，表达式可以定义为某个 package 下的方法，也可以是自定义注解等；
 * <p>
 * 切点定义好后，就是围绕这个切点做文章了：
 * @Before: 在切点之前，织入相关代码；
 * @After: 在切点之后，织入相关代码;
 * @AfterReturning: 在切点返回内容后，织入相关代码，一般用于对返回值做些加工处理的场景；
 * @AfterThrowing: 用来处理当织入的代码抛出异常后的逻辑处理;
 * @Around: 在切入点前后织入代码，并且可以自由的控制何时执行切点；
 */
@Aspect
@Component
@Order(1)
public class WebLogAspect {

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

    /**
     * execution 表达式
     * 可以基于方法的返回类型、包名、类名、方法名以及参数类型等信息来精确地匹配方法.
     * 以下这个例子：匹配了 com.example.reactboot 包及其子包中所有类的所有方法。
     */
    //@Pointcut("execution(* com.example.reactboot.*.*(..))")
    @Pointcut("execution(public * com.example.reactboot.controller..*.*(..))")
    public void webLog() {
    }

    /**
     * @annotation 表达式
     * 用于匹配被指定注解标注的方法。
     * 以下这个例子：匹配了所有被 com.example.reactboot.aop.Aoplog 注解标注的方法。
     */
    @Pointcut("@annotation(com.example.reactboot.aop.Aoplog)")
    public void aopLog() {
    }


    /**
     * 在切点之前织入
     * @param joinPoint
     * @throws Throwable
     *
     * 以下这个例子：使用了execution 的内容
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 打印请求相关参数
        logger.info("========== Start ==========");
        // 打印请求 url
        logger.info("请求URL: {}", request.getRequestURL().toString());
        // 打印 Http method
        logger.info("请求方法: {}", request.getMethod());
        // 打印调用 controller 的全路径以及执行方法
        logger.info("全路径以及执行方法 Class Method: {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
        // 打印请求的 IP
        logger.info("请求IP: {}", request.getRemoteAddr());
        // 打印请求入参
        logger.info("入参Request Args: {}", new Gson().toJson(joinPoint.getArgs()));
    }

    /**
     * 在切点之后织入
     *
     * @throws Throwable
     */
    @After("webLog()")
    public void doAfter() throws Throwable {
        logger.info("========== End ==========");
        // 每个请求之间空一行
        logger.info("");
    }

    /**
     * 环绕
     *
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        // 打印出参
        logger.info("出参Response Args  : {}", result);
        // 执行耗时
        logger.info("执行耗时Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
        return result;
    }
}

4. 测试一（切入点用execution 表达式）

以上的切面处理类，使用的 webLog 方法，用的为execution 表达式

控制层 代码

package com.example.reactboot.controller;

import com.example.reactboot.aop.Aoplog;
import com.example.reactboot.aop.WebLogAspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 单纯的@Controller,请求的资源面向的就是页面
 * 而 @RestController,请求的资源面向的是对象或者字符串
 */
@RestController
public class HelloController {

    private final static Logger logger = LoggerFactory.getLogger(HelloController.class);

    @RequestMapping("/index")
    public String sayHello(){
        logger.info("我是index接口");
        return "index";
    }
}

请求该接口后，控制台显示打印如下操作
是有切面日志输出的

5. 测试二（切入点用自定义注解方式）

先把以上切面类（WebLogAspect ）里面的webLog()全部换成aopLog() 再进行测试

控制层 代码

我新写了一个 xiaoming 的接口，在它上面加上了@Aoplog注解

package com.example.reactboot.controller;

import com.example.reactboot.aop.Aoplog;
import com.example.reactboot.aop.WebLogAspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 单纯的@Controller,请求的资源面向的就是页面
 * 而 @RestController,请求的资源面向的是对象或者字符串
 */
@RestController
public class HelloController {

    private final static Logger logger = LoggerFactory.getLogger(HelloController.class);


    @RequestMapping("/index")
    public String sayHello(){
        logger.info("我是index接口");
        return "index";
    }

    @Aoplog(value = "xiaoming")
    @RequestMapping("/xiaoming")
    public String xiaoming(){
        logger.info("我是xiaoming接口");
        return "xiaoming";
    }
}

两个接口都请求后，控制台显示打印如下操作
只有加了注解的才会有切面日志输出

参考文章
【1】Spring Boot AOP 切面统一打印请求与响应日志
【2】Spring Boot 2.X(八)：Spring AOP 实现简单的日志切面
【3】在IDEA 、springboot中使用切面aop实现日志信息的记录到数据库
【4】springboot项目使用切面记录用户操作日志
【5】Spring Boot中使用AOP统一处理Web请求日志