转载

Springboot AOP的使用详解

要了解** AOP(Aspect Oriented Programming)面向方面编程 ，我们往往将其和另一个名词即 OOP(Object Oriented Programming)面向对象编程**放一起来比较和理解。

在OOP的模式下，当多个不具有继承关系的对象需引用同一个公共行为时，就会产生大量重复冗余代码。最好理解就是我们的日志模块或者安全监测等。要在函数的调用处打出日志，我们则需要引入日志对象来调用，然而这个日志对象并非业务类所需要的。

AOP所关注的方向是横向的，是OOP的有益补充。为了能让业务类更专注于具体的物业开发，而其他模块功能的增加不修改到目标函数，可通过配置切面来实现达到功能解耦。

AOP术语

连接点（join point）：对应的是具体被拦截的对象，因为Spring只支持方法，所以被拦截的对象往往就是指特定的方法。
切点（point cut）：有时候，我们的切面不单单应用于单个方法，也可以是多个类的不同方法，这时，可以通过正则表达式和指示器的规则去定义。
通知（advice）：
1. 前置通知（before advice）
2. 后置通知（after advice）
3. 环绕通知（around advice）
4. 事后返回通知（afterReturning advice）
5. 异常通知（afterThrowingadvice）
目标对象（target）：即被代理对象。
引入（introduction）：是指引入新的类和方法，增强现有Bean的功能。
织入（weaving）：它是一个通过动态代理技术，为原有服务对象生成动态对象，然后将与切点定义匹配的连接点拦截，并按约定将各类通知织入约定流程的过程。
切面（aspect）：是一个可以定义切点、各类通知和引入的内容。

了解了大致概念之后，我们直接动手看究竟怎么来执行一个切面。

AOP使用

业务类代码TestController。

@RestController
@RequestMapping("/test")
public class TestController {

    public void testFunc(String userName) {
        //do something
        System.out.println("Hello " + userName);
    }
    
}
复制代码

定义简单切面

@Aspect
@Component
public class MyAspect {

  @Pointcut("execution(public * com.test.TestController.testFunc(..))")
  public void pointCut() {}

  @Before("pointCut()")
  public void before() {
      log.info("MyAspect before ...");
  }

  @After("pointCut()")
  public void after() {
      log.info("MyAspect after ...");
  }

  @AfterReturning("pointCut()")
  public void afterReturning() {
      log.info("MyAspect after returning ...");
  }

  @AfterThrowing("pointCut()")
  public void afterThrowing() {
      log.info("MyAspect after throwing ...");
  }

  @Around("pointCut()")
  public void around(ProceedingJoinPoint joinPoint) throws Throwable {
      log.info("MyAspect around before ...");
      joinPoint.proceed();
      log.info("MyAspect around after ...");
  }
}
复制代码

上面的例子就是对业务方法testFunc进行一个简单的切面定义实现。到这里，一个最基本的切面类已经实现了。下面我们继续了解AOP的更多内容。

切面注解要点说明

使用@Aspect注解将一个java类定义为切面类，如例子中的MyAspect。
使用@Pointcut定义一个切入点，可以是一个规则表达式，也可以是一个注解等。
根据需要在切入点不同位置的切入内容
- 使用@Before在切入点开始处切入内容
- 使用@After在切入点结尾处切入内容
- 使用@AfterReturning在切入点return内容之后切入内容（可以用来对处理返回值做一些加工处理）
- 使用@Around在切入点前后切入内容，并自己控制何时执行切入点自身的内容
- 使用@AfterThrowing用来处理当切入内容部分抛出异常之后的处理逻辑

定义处理参数的切面

Spring AOP提供使用org.aspectj.lang.JoinPoint类型获取连接点数据，任何通知方法的第一个参数都可以是JoinPoint(环绕通知是ProceedingJoinPoint，JoinPoint子类)。

JoinPoint：提供访问当前被通知方法的目标对象、代理对象、方法参数等数据
ProceedingJoinPoint：只用于环绕通知，使用proceed()方法来执行目标方法

如参数类型是JoinPoint、ProceedingJoinPoint类型，可以从“argNames”属性省略掉该参数名（可选，写上也对），这些类型对象会自动传入的，但必须作为第一个参数。

@Aspect
@Component
public class MyAspect {

  @Pointcut("execution(public * com.test.TestController.testFunc(..))")
  public void pointCut() {}

  @Before("pointCut()")
  public void before(JoinPoint joinPoint) {
      String method = joinPoint.getSignature().getName();
      log.info("MyAspect before Method：{}::{}", joinPoint.getSignature().getDeclaringTypeName(), method);
      ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
      HttpServletRequest request = attributes.getRequest();
      log.info("ClientIP：{}", request.getRemoteAddr());
  }

  @After("pointCut()")
  public void after(JoinPoint joinPoint) {
      String method = joinPoint.getSignature().getName();
      log.info("MyAspect after Method：{}::{}", joinPoint.getSignature().getDeclaringTypeName(), method);
  }

  @AfterReturning("pointCut()")
  public void afterReturning(JoinPoint joinPoint) {
      String method = joinPoint.getSignature().getName();
      log.info("MyAspect after returning Method：{}::{}", joinPoint.getSignature().getDeclaringTypeName(), method);
  }

  @AfterThrowing("pointCut()")
  public void afterThrowing(JoinPoint joinPoint) {
      log.info("MyAspect after throwing ...");
  }

  @Around("pointCut()")
  public void around(ProceedingJoinPoint joinPoint) throws Throwable {
      log.info("MyAspect around before ...");
      joinPoint.proceed();
      log.info("MyAspect around after ...");
  }
}
复制代码

定义具有执行优先级切面

通过注解@Order来配置执行优先级，order数字越小越优先执行。

@Aspect
@Component
@Order(-1)
public class MyAspect2 {
    //和上面例子一样，省略
}
复制代码

通过实现org.springframework.core.Ordered接口

@Component
@Aspect
public class MyAspect2 implements Ordered { 
    @Override
    public int getOrder() {
        //do something to gen order.
        return 2;
    }
}
复制代码

AOP切点详解

PointCut的定义包括两个部分：Pointcut表示式(expression)和Pointcut签名(signature)。

//Pointcut表示式
@Pointcut("execution(public * com.test.TestController.testFunc(..))")

//Pointcut签名
public void pointCut() {}
复制代码

execution表示式的格式：

execution(
modifier-pattern?
ret-type-pattern
declaring-type-pattern?
name-pattern(param-pattern)
throws-pattern?)
复制代码

括号中各个pattern分别表示

修饰符匹配（modifier-pattern?）
返回值匹配（ret-type-pattern）
类路径匹配（declaring-type-pattern?）
方法名匹配（name-pattern）
参数匹配（(param-pattern)）
异常类型匹配（throws-pattern?），其中后面跟着“?”的是可选项。

现在来看看几个例子。

execution(* *(..))
execution(public * com.test.TestController.*(..))
execution(* com.test..*.*(..))

先介绍到这里，欢迎留言讨论分享~

原文 https://juejin.im/post/5d7dff876fb9a06aca384d42

正文到此结束

所属分类： Spring

本文标签： ip App IO spring map Java类 servlet 代码 bean 正则表达式安全开发专注 IDE http tar 参数 id remote 数据 core https REST AOP java 配置 client
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

Springboot AOP的使用详解

AOP术语

AOP使用

定义简单切面

切面注解要点说明

定义处理参数的切面

定义具有执行优先级切面

AOP切点详解

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流