SpringBoot 使用面向切面编程AOP

原创
2021/04/09 01:28
阅读数 718

一、什么是AOP?

AOP,面向切面编程,一句话说明,把一些公共的、和业务无关的功能性代码抽取出来,在运行的时候动态的往业务方法上植入。利用 AOP 可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。

 

二、AOP常用场景:

  1. 事务开启关闭控制
  2. 日志记录
  3. 权限校验

 

三、AOP 相关概念介绍:

  • Joinpoint(连接点):类里面可以被增强的方法即为连接点。例如,想要修改哪个方法的功能,那么该方法就是一个链接点。
  • Target(目标对象):要增强的类成为 Target。
  • Pointcut(切入点):对 Jointpoint 进行拦截的定义即为切入点。例如,拦截所有以 insert 开始的方法,这个定义即为切入点。
  • Advice(通知):拦截到 Jointpoint 之后要做的事情就是通知。通知分为前置通知、后置通知、异常通知、最终通知和环绕通知。例如,前面说到的打印日志监控就是通知。
  • Aspect(切面):即 Pointcut 和 Advice 的结合。

 

通知方法的几种类型:

  • 前置通知(Before advice):在某个连接点(Join point)之前执行的通知,但这个通知不能阻止连接点的执行(除非它抛出一个异常)。
  • 后置通知(After(finally)advice):当某个连接点(Join point)退出的时候执行的通知(不论是正常返回还是发生异常退出)。
  • 返回通知(After returning advice):在某个连接点(Join point)正常完成后执行的通知。例如,一个方法没有抛出任何异常正常返回。
  • 异常通知(After throwing advice):在方法抛出异常后执行的通知。
  • 环绕通知(Around advice):包围一个连接点(Join point)的通知,如方法调用。这是最强大的一种通知类型。环绕通知可以在方法前后完成自定义的行为。它也会选择是否继续执行连接点或直接返回它们自己的返回值或抛出异常来结束执行。

执行顺利如下图:

 

四、安装配置

Spring Boot 在 Spring 的基础上对 AOP 的配置提供了自动化配置解决方案,我们只需要修改 pom.xml 文件,添加 spring-boot-starter-aop 依赖即可。

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

 

五、编写代码

1、编写controller

@RestController
public class DemoController {
 
    @Autowired
    UserService userService;
 
    @GetMapping("/demo")
    public String demo(Integer id) {
        return userService.getUserById(id);
    }
}

 

2、编写service

@Service
public class UserService {

   public String getUserById(Integer id) {
       System.out.println("getUserById(" + id + ")...");
       // 等待2秒
       try {
           Thread.sleep(2000);
       }
       catch(InterruptedException e) {
           e.printStackTrace();
       }
       return "piao";
   }

}

 

3、编写切面

注解说明:

(1)@Aspect 注解:表明这是一个切面类。

(2)@Pointcut 注解:表明这是一个切入点。

  • execution 中的第一个 * 表示方法返回任意值
  • 第二个 * 表示 service 包下的任意类
  • 第三个 * 表示类中的任意方法,括号中的两个点表示方法参数任意,即这里描述的切入点为 service 包下所有类中的所有方法。

(3)@Before 注解:表示这是一个前置通知,该方法在目标方法之前执行。

  • 通过 JoinPoint 参数可以获取目标方法的方法名、修饰符等信息。

(4)@After 注解:表示这是一个后置通知,该方法在目标执行之后执行。

(5)@AfterReturning 注解:表示这是一个返回通知,在该方法中可以获取目标方法的返回值。

  • returning 参数是指返回值的变量名,对应方法的参数。
  • 注意:本样例在方法参数中定义 result 的类型为 Object,表示目标方法的返回值可以是任意类型。若 result 参数的类型为 Long,则该方法只能处理目标方法返回值为 Long 的情况。

(6)@AfterThrowing 注解:表示这是一个异常通知,即当目标方法发生异常,该方法会被调用。

  • 样例中设置的异常类型为 Exception 表示所有的异常都会进入该方法中执行。
  • 若异常类型为 ArithmeticException 则表示只有目标方法抛出的 ArithmeticException 异常才会进入该方法的处理。

(7) @Around 注解:表示这是一个环绕通知。环绕通知是所有通知里功能最为强大的通知,可以实现前置通知、后置通知、异常通知以及返回通知的功能。

  • 目标方法进入环绕通知后,通过调用 ProceedingJointPoint 对象的 proceed 方法使目标方法继续执行,开发者可以在次修改目标方法的执行参数、返回值值,并且可以在此目标方法的异常。
@Aspect
@Component
public class LogAspect {

    // 定义一个切入点
    @Pointcut("execution(* com.example.demo.service.*.*(..))")
    public void pc1(){
 
    }
 
    // 前置通知
    @Before(value = "pc1()")
    public void before(JoinPoint jp) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法开始执行...");
    }
 
    // 后置通知
    @After(value = "pc1()")
    public void after(JoinPoint jp) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法执行结束...");
    }
 
    // 返回通知
    @AfterReturning(value = "pc1()", returning = "result")
    public void afterReturning(JoinPoint jp, Object result) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法返回值为:" + result);
    }
 
    // 异常通知
    @AfterThrowing(value = "pc1()", throwing = "e")
    public void afterThrowing(JoinPoint jp, Exception e) {
        String name = jp.getSignature().getName();
        System.out.println(name + "方法抛异常了,异常是:" + e.getMessage());
    }
 
    // 环绕通知
    @Around("pc1()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        String name = pjp.getSignature().getName();
        // 统计方法执行时间
        long start = System.currentTimeMillis();
        Object result = pjp.proceed();
        long end = System.currentTimeMillis();
        System.out.println(name + "方法执行时间为:" + (end - start) + " ms");
        return result;
    }

}

 

六、验证结果

1、请求接口:http://127.0.0.1:8086/demo

2、查看控制台信息:

展开阅读全文
加载中
点击引领话题📣 发布并加入讨论🔥
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部