浅谈Spring AOP 面向切面编程 最通俗易懂的画图理解AOP、AOP通知执行顺序~

简介

我们都知道，Spring 框架作为后端主流框架之一，最有特点的三部分就是IOC控制反转、依赖注入、以及AOP切面。当然AOP作为一个Spring

的重要组成模块，当然IOC是不依赖于Spring框架的，这就说明你有权选择是否要用AOP来完成一些业务。

AOP面向切面编程，通过另一种思考的方式，来弥补面向对象编程OOP当中的不足，OOP当中最重要的单元是类，所以万物皆对象，万物皆是

对象类。而在AOP的模块单元中，最基础的单元是切面，切面对切点进行模块化的管理。

最后再提一句：Spring当中的AOP是利用Java的代理模式实现的

AOP概念

让我们从一些基础的术语开始了解面向切面编程AOP,术语不是特别的直观，最好的方式就是通过文本理解+图像理解+代码实例理解

这样对于我们来说才是真正意义上的理解。

• 切面：（Aspect) 一个关注点的模块化，就比较笼统的一个概念，关注点可能横切多个对象。若不理解请往后看图片理解，对应的注解有@Aspect。
• 连接点：（Joinpoint) 在程序执行过程中某个特定的点，一个连接点总是代表一个方法的执行。
• 通知：（Advice) 通知表示在一个连接点执行的具体的动作，比如After Before 表明通知的具体动作
• 切入点：（Pointcut）通过一个表达式去表明我所定义的通知在那个地点具体执行。
• 前置通知：（Before advice）表明在连接点执行之前执行的动作。
• 后置通知：（After returning advice）在某个连接点完成后的通知，比如一个方法没有抛出任何异常，正常返回。
• 环绕通知：（Around Advice) 环绕可以看作是包含前置通知和后置通知的一个通知，先了解，后面具体理解。
• 异常通知：（After throwing advice) 在方法异常推出时候执行的通知。
• 最终通知：（After advice) 在连接点退出时候执行的通知。不论是正常退出还是异常退出。

说了这么多，都感觉迷迷糊糊的，我们首先来看一个例子吧，通过这个例子来理解AOP切面，通过例子在具体说明

Springboot AOP

版本信息：Springboot 2.1.6

添加依赖 Web AOP

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

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

写一个最简单的控制器

@RestController
@RequestMapping("/")
public class AuthController {

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

    @GetMapping("login")
    public String login(String user,String pass) {

        logger.info("login--->user",user);
        logger.info("login--->pass",pass);

        return "success";
    }

}

这样的控制器在SpringBoot的Web开发当中是很常见的，收到前端的请求，将参数进行校验，我们这里为了简单，不作校验，只是打印出来，为了配合我们后面的AOP的理解而

做的一个最简单的控制器，测试请求以下路径，控制台打印以下内容

http://localhost:8080/login?user=root&pass=root

2019-11-09 09:59:00.585  INFO 11100 --- [nio-8080-exec-1] c.e.demo.controller.AuthController       : login--->user
2019-11-09 09:59:00.588  INFO 11100 --- [nio-8080-exec-1] c.e.demo.controller.AuthController       : login--->pass

定义切面类

1、定义一个切面类，加入@Aspect注解和@Component注解

@Aspect
@Component
public class WebLogAsp {}

@Aspect 注解将找个类定义为一个切面对象，通过@Component注解将这个类对象注入到IOC容器，交给Spring来进行管理。

2、定义一个切入点 通过@Pointcut

    @Pointcut("execution(public * com.example.demo.controller.*.*(..))")
    public void controllerLog(){}

@Pointcut这个注解主要用来定义切入点，通过表达式的方式，来告诉Spring,我这个切点要切到什么位置，常用的就是execution去匹配连接点。

主要来说一下execution 匹配表达是的表达方法，我们按照以下的例子来说明：

@Pointcut("execution(public * com.example.demo.controller.*.*(..))")

语法：execution( [方法修饰符(可选)]__返回类型__类路径__方法名__(参数)__[异常模式(可选)] )

这里我用下划线来代替空格，比较直观的可以看出，我们这个例子里面，我将这个切点切入到com.example.demo.controller包下所有类的所有方法上面。

*就是通配符，（..）代表任意多个参数，也就说明我切入到的方法它的参数我是不限定的，可以有任意个参数。

3、定义通知项，@Before定义一个前置通知

@Before("controllerLog()")
public void beforeAdvice(JoinPoint joinPoint){}

@Before注解传入字符串方法名，也就是我们上面定义的切入点的方法名，告诉它这个通知是在切入点 controllerLog()上面执行的通知，它会在切入点方法执行之前率先执行

这个方法传入了一个JoinPoint 对象，也就是我们所说的连接点对象，连接点可以理解为切入点方法执行时候所产生的一个对象。

这里有几个具体的方法很重要，需要说明一下：

• Object[] getArgs();获取切入点方法执行时候传入的参数。

• Object getTarget();获取的是切入方法所在的类对象，简单理解例子里面的切入点是login（）方法，所以返回的对象就是AuthController对象

• Object getThis();返回AOP框架为目标对象生成的代理对象。

这里将详细代码举例，通过打印的方式进行输出，通过SpringMvc的RequestContextHolder获取线程的请求对象，这里我们可以拿到当前请求

的一些具体参数，比如访问人的IP信息，它所请求的URL以及请求所带的参数等待。

具体请参考：https://www.runoob.com/servlet/servlet-client-request.html

    @Before("controllerLog()")
    public void beforeAdvice(JoinPoint joinPoint){

        logger.info("前置通知开始--->");
        /*获取当前请求的HttpServletRequest*/
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();

        logger.info("URL-->"+request.getRequestURL().toString());
        logger.info("IP-->"+request.getRemoteAddr());
        logger.info("HTTP_Method-->"+request.getMethod());
        logger.info("Request_args-->"+ Arrays.toString(joinPoint.getArgs()));

        logger.info("前置通知结束--->");
    }

4、环绕通知方法 @Around

首先来看一部分代码，这里传递了一个 ProceedingJoinPoint 对象，它是JoinPoint 切点对象的一个子类，也可以为它是切点所在的方法执行时候所产生的一个对象

这里最重要的一个方法当属于 proceed() ；执行proceed()就表示执行切点所在的方法执行，它会返回一个Object对象，也就是目标方法所返回的对象。

    @Around("controllerLog()")
    public Object aroundAdvice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        logger.info("环绕通知开始-->");
        Object result = null;

        /*proceed()方法表示连接点方法执行 result 为连接点方法的返回值*/
        result = proceedingJoinPoint.proceed();
        logger.info("环绕通知返回值-->" + result);

        logger.info("环绕通知结束-->");
        return result;
    }

踩坑：环绕方法一定要将result对象返回出去，若定义为void 无返回值的话，将在后面的@AfterReturning 后置通知中无法取到值！！！！

5、后置通知 @AfterReturning 连接点正常执行完毕后的通知

    @AfterReturning(value = "controllerLog()",returning = "obj")
    public void afterReturning(JoinPoint joinPoint,Object obj){
        logger.info("后置通知正常返回-->"+obj);
    }

这里传递了两个参数，第一个参数还是指定切点，第二个参数指定的是返回值，这个返回值就是连接点所返回的参数值，需要在环绕通知里面将其返回出来才可以

取到值，不然返回的就是Null

6、异常通知 @AfterThrowing

    @AfterThrowing(value = "controllerLog()", throwing = "ex")
    public void afterThrowing(JoinPoint joinPoint,Exception ex){
        logger.info("异常通知-->"+ex.getMessage());
    }

这里和上面的后置通知差不多，不过第二个参数是一个异常类型对象，可以取出发生异常时候的异常信息。

7、最终通知 @After

这个和@Before一样，不再细说！

正常返回测试

这里可以很明确的看到，一个正常的返回路径，相信我不说大家都可以看的清楚，画图最清楚的，接收到请求后，首先工作的是环绕通知，

环绕通知里面执行proceed（）方法后，才会进入连接点方法执行，Before是在连接点方法执行之前所执行的，而后执行连接点方法内容，

正常执行完后，不发生异常情况，环绕通知结束，就会执行最终通知After After执行完毕后，才会执行后置通知AfterReturning

异常情况测试返回

我们在控制器里面模拟进行一个异常的抛出，看一下执行的顺序

        logger.info("将要抛出异常");
        int a = 1/0;

可以很明明显的看到，我们在控制器里面通过一个除0的操作，进行抛出一个异常，这里环绕通知是没有执行完毕的，因为抛出异常，停止了运行

从接收到请求开始，进入环绕通知，然后环绕通知里面调用了proceed()方法，其实就是让连接点的方法开始运行，这时候前置通知首先跑起来，可以看到

前置通知是完完全全走完的。前置通知完毕后，下来是连接点的方法运行起来了，这里因为抛出了异常，没有进行捕获，最终通知还是一样正常执行，不过最后执行的是异常的通知，

而不是像上面一样。这里不同的地方还是要多进行理解。

画图理解

1、理解切面、切入点、连接点、通知、目标对象

2、理解通知点正常与异常执行顺序

小结

通过对SpringAOP框架的研究，以及画图的理解，能够更深刻的理解里面运行时候的内层含义，以及AOP的一些应用，比如系统里面的日志系统，通过学习AOP

完完全全可以很轻松的通过切面，将需要记录的日志信息存到数据库， 节约大量时间。

参考：

https://docs.spring.io/spring/docs/3.0.x/spring-framework-reference/html/aop-api.html

http://shouce.jb51.net/spring/aop.html

https://www.cnblogs.com/wangshen31/p/9379197.html

代码：

https://gitee.com/mrc1999/Springboot-aop