ToB企服应用市场:ToB评测及商务社交产业平台

标题: Spring Boot学习随笔- 实现AOP（JoinPoint、ProceedingJoinPoint、自定义注 [打印本页]

---

作者: 伤心客    时间: 2024-2-26 03:10
标题: Spring Boot学习随笔- 实现AOP（JoinPoint、ProceedingJoinPoint、自定义注

学习视频：【编程不良人】2021年SpringBoot最新最全教程

第十一章、AOP

11.1 为什么要使用AOP

• 问题
  
  
  
  • 现有业务层开发存在问题
    
    
    • 额外功能代码存在大量冗余
      
    • 每个方法都需要书写一遍额外功能代码不利于项目维护
      
    
    
  
  
• Spring中的AOP
  AOP：Aspect 切面 + Oriented 面向  Programmaing 面向切面编程
  Aspect（切面） = Advice（通知） + Pointcut（切入点）
  Advice 通知：业务逻辑中的一些附加操作称之通知
  Pointcut 切入点：配置通知应用于项目中那些业务操作
  
• Advice通知就是附加操作的代码，Advice通知类型都有不同的执行策略和用途。
  @Before在目标方法执行之前执行的通知。它不能阻止方法的执行，但可以在方法执行前添加额外的功能。@AfterReturning在目标方法正常返回后执行的通知。例如，如果一个方法正常返回而没有抛出异常，就会执行这个通知。@AfterThrowing在目标方法抛出异常后执行的通知。如果一个方法抛出异常，就会执行这个通知。@After在目标方法执行之后执行的通知。无论目标方法如何退出（正常返回或抛出异常），都会执行的通知。@Around包围目标方法的通知，可以在目标方法执行前后添加额外的功能，并决定是否继续执行目标方法。
  
• Pointcut 是切入点，决定了Advice加在哪个具体方法代码上，具体使用方式：
  1. 1.切入点直接写在附加操作里面
  2. @Around(value="execution(* login(..))")
  3. 2.通过@Pointcut注解 声明切入点，实现复用
  4. @Pointcut("execution(* login(..))") // 复用切入点，解耦合
  5.     public void myPointcut(){}
  7. @Around("myPointcut()")
  8. @After("myPointcut()")
  9. @Before("myPointcut()")

  复制代码

11.2 AOP的实现

• 引入依赖
  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-aop</artifactId>
  4. </dependency>

  复制代码
• 目前UserServiceImp存在的问题
  以log日志这种额外功能为例，这样的重复操作存在冗余代码和耦合
  1. @Service
  2. public class UserServiceImpl implements UserService {
  3.     @Override
  4.     public void save(String name) {
  5.         System.out.println("========log========");
  6.         System.out.println("UserServiceImpl.save");
  7.     }
  9.     @Override
  10.     public void delete(Integer id) {
  11.         System.out.println("========log========");
  12.         System.out.println("UserServiceImpl.delete");
  13.     }
  15.     @Override
  16.     public void update(String name) {
  17.         System.out.println("========log========");
  18.         System.out.println("UserServiceImpl.update");
  19.     }
  21.     @Override
  22.     public String find(String name) {
  23.         System.out.println("========log========");
  24.         System.out.println("UserServiceImpl.find");
  25.         return "name";
  26.     }
  27. }

  复制代码
• 我们通过一个切面配置类来解耦合
  1. /**
  2. * 自定义切面配置类
  3. */
  4. @Configuration  // 指定当前类为配置类
  5. @Aspect // 代表这个类是一个切面配置类
  6. public class MyAspectConfig {
  8.     @Before("execution(* com.example.service.*.*(..))") // @Before代表在业务逻辑执行前运行 value代表切入点
  9.     public void before() {
  10.         System.out.println(" =====前置附加操作：log====== ");
  11.     }
  12. }

  复制代码
• 通过切入点，完成整个业务的额外功能覆盖，运行效果
  
  

11.3 JoinPoint 参数详解

JoinPoint参数可以在通知体内声明，用于获取有关方法执行的信息。JoinPoint参数提供了许多有用的方法，例如getSignature()可以获取方法的签名，getArgs()可以获取方法的参数列表，getTarget()可以获取目标对象等。通过JoinPoint参数，我们可以在通知中访问和操作方法执行时的上下文信息。
JoinPoint参数通常用于以下几种情况：

• 记录日志：获取方法的签名和参数列表，从而记录方法的执行情况，包括方法名、参数值等。
  
• 异常处理：获取方法执行时抛出的异常信息，从而进行相应的异常处理。
  
• 性能监控：获取方法的执行时间、参数值等信息，用于性能监控和优化。
  

1. 获取执行方法的信息
2. @Before("execution(* com.example.service.*.*(..))") //
3. public void before(JoinPoint joinPoint) {
4.     String methodName = joinPoint.getSignature().getName();
5.     String className = joinPoint.getTarget().getClass().getName();
6.     Object[] args = joinPoint.getArgs();
7.     System.out.println("Before 执行方法： " + methodName + " 在类：" + className);
8.     System.out.println("方法参数 = " + Arrays.toString(args));
9. }

复制代码

11.4 @Around 环绕附加操作

使用@Around注解的方法，参数必须声明ProceedingJoinPoint，这个参数可以控制目标方法的执行

1. @Around("execution(* com.example.service.*.*(..))")
2. public Object around(ProceedingJoinPoint pjp) throws Throwable {
3.     System.out.println("======进入环绕的前置操作======");
4.     System.out.println("当前执行类 = " + pjp.getSignature().getName());
5.     System.out.println("方法名 = " + pjp.getTarget().getClass().getSimpleName());
6.     //放行目标方法执行
7.     Object proceed = pjp.proceed(); // 目标方法继续执行
8.     System.out.println(" =====进入环绕的后置操作========= ");
9.     return proceed;
10. }

复制代码

• 运行效果
  
  

11.5 自定义注解方式的切入点表达式@annotation

通过自定义注解@annotation实现切面的好处在于可以使切面的定义更加灵活和可重用。使用自定义注解可以将切面的逻辑和配置信息封装在注解中，使得切面的使用和配置变得更加简单和直观。

• MyAdvice 自定义注解
  1. @Retention(RetentionPolicy.RUNTIME) // 指定运行时保留
  2. @Target(ElementType.METHOD) //指定修饰 方法
  3. public @interface MyAdvice {
  4. }

  复制代码
• 放在通知里的@annotation属性使用，代表只有被@MyAdvice修饰的方法才会被加入额外功能
  1. **@Around("@annotation(com.example.config.MyAdvice)")**
  2. public Object around(ProceedingJoinPoint pjp) throws Throwable {
  3.                        
  4. }

  复制代码
• 通过将注解加在业务逻辑上，实现给目标方法加上额外功能的目的
  1. UserServiceImpl       
  2. @Override
  3. @MyAdvice
  4. public String find(String name) {
  5. //        System.out.println("========log========");
  6.     System.out.println("UserServiceImpl.find");
  7.     return "name";
  8. }

  复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4