Spring: AOP
Aspect Oriented Programming(⾯向切⾯编程)
什么是⾯向切⾯编程呢? 切⾯就是指某⼀类特定问题, 所以AOP也可以理解为⾯向特定⽅法编程.
AOP是⼀种思想, 拦截器是AOP思想的⼀种实现. Spring框架实现了这种思想, 提供了拦截器技术的相关接⼝.简单来说: AOP是⼀种思想, 是对某⼀类事情的集中处理
在pom.xml⽂件中添加配置
1<dependency>
2<groupId>org.springframework.boot</groupId>
3<artifactId>spring-boot-starter-aop</artifactId>
4</dependency>
记录Controller中每个⽅法的执⾏时间
1importlombok.extern.slf4j.Slf4j;
2importorg.aspectj.lang.ProceedingJoinPoint;
3importorg.aspectj.lang.annotation.Around;
4importorg.aspectj.lang.annotation.Aspect;
5importorg.springframework.stereotype.Component;
6
7@Slf4j
8@Aspect
9@Component
10public classTimeAspect{
11/**
12*记录⽅法耗时
13*/
14@Around("execution(* com.example.demo.controller.*.*(..))")
15publicObjectrecordTime(ProceedingJoinPoint pjp)throwsThrowable {
16//记录⽅法执⾏开始时间
17long begin= System.currentTimeMillis();
18//执⾏原始⽅法
19Object result= pjp.proceed();
20//记录⽅法执⾏结束时间
21long end= System.currentTimeMillis();
22//记录⽅法执⾏耗时
23log.info(pjp.getSignature() +"执⾏耗时: {}ms", end - begin);
24returnresult;
25}
26}
运⾏程序, 观察⽇志
1.@Aspect: 标识这是⼀个切⾯类
2.@Around: 环绕通知, 在⽬标⽅法的前后都会被执⾏. 后⾯的表达式表⽰对哪些⽅法进⾏增强.
3.ProceedingJoinPoint.proceed() 让原始⽅法执⾏
整个代码划分为三部分
我们通过AOP⼊⻔程序完成了业务接⼝执⾏耗时的统计.
通过上⾯的程序, 我们也可以感受到AOP⾯向切⾯编程的⼀些优势:
•代码⽆侵⼊: 不修改原始的业务⽅法, 就可以对原始的业务⽅法进⾏了功能的增强或者是功能的改变
•减少了重复代码
•提⾼开发效率
•维护⽅便
切点(Pointcut), 也称之为"切⼊点"
Pointcut 的作⽤就是提供⼀组规则 (使⽤ AspectJ pointcut expression language 来描述), 告诉程序对哪些⽅法来进⾏功能增强.
上⾯的表达式execution(* com.example.demo.controller.*.*(..))就是切点表达式.
满⾜切点表达式规则的⽅法, 就是连接点. 也就是可以被AOP控制的⽅法
以⼊⻔程序举例, 所有com.example.demo.controller路径下的⽅法, 都是连接点.
在AOP⾯向切⾯编程当中, 我们把这部分重复的代码逻辑抽取出来单独定义, 这部分代码就是通知的内容
切⾯(Aspect) = 切点(Pointcut) + 通知(Advice)
通过切⾯就能够描述当前AOP程序需要针对于哪些⽅法, 在什么时候执⾏什么样的操作.
切⾯既包含了通知逻辑的定义, 也包括了连接点的定义.
切⾯所在的类, 我们⼀般称为切⾯类(被@Aspect注解标识的类)
上⾯我们讲了什么是通知, 接下来学习通知的类型.@Around就是其中⼀种通知类型, 表⽰环绕通知.Spring中AOP的通知类型有以下⼏种:
•@Around: 环绕通知, 此注解标注的通知⽅法在⽬标⽅法前, 后都被执⾏
•@Before: 前置通知, 此注解标注的通知⽅法在⽬标⽅法前被执⾏
•@After: 后置通知, 此注解标注的通知⽅法在⽬标⽅法后被执⾏, ⽆论是否有异常都会执⾏
•@AfterReturning: 返回后通知, 此注解标注的通知⽅法在⽬标⽅法后被执⾏, 有异常不会执⾏
•@AfterThrowing: 异常后通知, 此注解标注的通知⽅法发⽣异常后执⾏
注意事项:
•@Around 环绕通知需要调⽤ProceedingJoinPoint.proceed()来让原始⽅法执⾏, 其他
通知不需要考虑⽬标⽅法执⾏.
•@Around 环绕通知⽅法的返回值, 必须指定为Object, 来接收原始⽅法的返回值, 否则原始⽅法执
⾏完毕, 是获取不到返回值的.
•⼀个切⾯类可以有多个切点.
上⾯代码存在⼀个问题, 就是存在⼤量重复的切点表达execution(*com.example.demo.controller.*.*(..)) , Spring提供了@PointCut注解, 把公共的切点表达式提取出来, 需要⽤到时引⽤该切⼊点表达式即可.
当切点定义使⽤private修饰时, 仅能在当前切⾯类中使⽤, 当其他切⾯类也要使⽤当前切点定义时, 就需要把private改为public. 引⽤⽅式为: 全限定类名.⽅法名()
1@Slf4j
2@Aspect
3@Component
4public classAspectDemo2{
5//前置通知
6@Before("com.example.demo.aspect.AspectDemo.pt()")
7public voiddoBefore() {
8log.info("执⾏AspectDemo2 -> Before⽅法");
9}
10}
当我们在⼀个项⽬中, 定义了多个切⾯类时, 并且这些切⾯类的多个切⼊点都匹配到了同⼀个⽬标⽅法.当⽬标⽅法运⾏的时候, 这些切⾯类中的通知⽅法都会执⾏, 那么这⼏个通知⽅法的执⾏顺序是什么样的呢?
存在多个切⾯类时, 默认按照切⾯类的类名字⺟排序:
•@Before 通知:字⺟排名靠前的先执⾏
•@After 通知:字⺟排名靠前的后执⾏
但这种⽅式不⽅便管理, 我们的类名更多还是具备⼀定含义的.
Spring 给我们提供了⼀个新的注解, 来控制这些切⾯通知的执⾏顺序:@Order
@Aspect
@Component
@Order(2)
public classAspectDemo2{
//...代码省略
}
@Aspect
@Component
@Order(1)
public classAspectDemo3{
//...代码省略
}
@Aspect
@Component
@Order(3)
public classAspectDemo4{
//...代码省略
}
@Order 注解标识的切⾯类, 执⾏顺序如下:
•@Before 通知:数字越⼩先执⾏
•@After 通知:数字越⼤先执⾏
@Order控制切⾯的优先级, 先执⾏优先级较⾼的切⾯, 再执⾏优先级较低的切⾯, 最终执⾏⽬标⽅法.
上⾯的代码中, 我们⼀直在使⽤切点表达式来描述切点. 下⾯我们来介绍⼀下切点表达式的语法.
切点表达式常⻅有两种表达⽅式
1.execution(R ):根据⽅法的签名来匹配
2.@annotation(R ) :根据注解匹配
execution() 是最常⽤的切点表达式, ⽤来匹配⽅法, 语法为:
execution(<访问修饰符> <返回类型> <包名.类名.⽅法(⽅法参数)> <异常>)
其中: 访问修饰符和异常可以省略
切点表达式⽀持通配符表达:
1.*:匹配任意字符,只匹配⼀个元素(返回类型, 包, 类名, ⽅法或者⽅法参数)
a.包名使⽤*表⽰任意包(⼀层包使⽤⼀个*)
b.类名使⽤*表⽰任意类
c.返回值使⽤*表⽰任意返回值类型
d.⽅法名使⽤*表⽰任意⽅法
e.参数使⽤*表⽰⼀个任意类型的参数
2...:匹配多个连续的任意符号, 可以通配任意层级的包, 或任意类型, 任意个数的参数
a.使⽤..配置包名,标识此包以及此包下的所有⼦包
b.可以使⽤..配置参数,任意个任意类型的参数
execution表达式更适⽤有规则的, 如果我们要匹配多个⽆规则的⽅法呢,![]()
![]()
![]()
这个时候我们使⽤execution这种切点表达式来描述就不是很⽅便了.
我们可以借助⾃定义注解的⽅式以及另⼀种切点表达式@annotation来描述这⼀类的切点
准备测试代码:
1@RequestMapping("/test")
2@RestController
3public classTestController{
4@RequestMapping("/t1")
5publicStringt1() {
6return"t1";
7}
8
9@RequestMapping("/t2")
10publicbooleant2() {
11returntrue;
12}
13}
创建⼀个注解类(和创建Class⽂件⼀样的流程, 选择Annotation就可以了)
1importjava.lang.annotation.ElementType;
2importjava.lang.annotation.Retention;
3importjava.lang.annotation.RetentionPolicy;
4importjava.lang.annotation.Target;
5
6@Target(ElementType.METHOD)
7@Retention(RetentionPolicy.RUNTIME)
8public@interfaceMyAspect {
9
10}
1.@Target标识了Annotation所修饰的对象范围, 即该注解可以⽤在什么地⽅.
常⽤取值:
ElementType.TYPE: ⽤于描述类、接⼝(包括注解类型) 或enum声明
ElementType.METHOD: 描述⽅法
ElementType.PARAMETER: 描述参数
ElementType.TYPE_USE: 可以标注任意类型
2.@Retention指Annotation被保留的时间⻓短, 标明注解的⽣命周期
@Retention 的取值有三种:
2.1RetentionPolicy.SOURCE:表⽰注解仅存在于源代码中, 编译成字节码后会被丢弃. 这意味着
在运⾏时⽆法获取到该注解的信息, 只能在编译时使⽤. ⽐如@SuppressWarnings, 以及lombok提供的注解 @Data,@Slf4j
2.2RetentionPolicy.CLASS:编译时注解. 表⽰注解存在于源代码和字节码中, 但在运⾏时会被丢
弃. 这意味着在编译时和字节码中可以通过反射获取到该注解的信息, 但在实际运⾏时⽆法获
取. 通常⽤于⼀些框架和⼯具的注解.
2.3RetentionPolicy.RUNTIME:运⾏时注解. 表⽰注解存在于源代码, 字节码和运⾏时中. 这意味
着在编译时, 字节码中和实际运⾏时都可以通过反射获取到该注解的信息. 通常⽤于⼀些需要
在运⾏时处理的注解, 如Spring的@Controller @ResponseBody
使⽤@annotation切点表达式定义切点, 只对@MyAspect⽣效
1@Slf4j
2@Component
3@Aspect
4public classMyAspectDemo{
5//前置通知
6@Before("@annotation(com.example.demo.aspect.MyAspect)")
7public voidbefore(){
8log.info("MyAspect -> before ...");
9}
10
11//后置通知12@After("@annotation(com.example.demo.aspect.MyAspect)")
13public voidafter(){
14log.info("MyAspect -> after ...");
15}
16}
在TestController中的t1()这个⽅法上添加⾃定义注解@MyAspect, 其他⽅法不添加
1@MyAspect
2@RequestMapping("/t1")
3publicStringt1() {
4return"t1";
5}
运⾏程序, 测试接⼝
http://127.0.0.1:8080/test/t1
可以看到, 切⾯通知被执⾏了.
继续测试:
http://127.0.0.1:8080/test/t2,切⾯通知未执⾏
代理模式, 也叫委托模式.
定义:为其他对象提供⼀种代理以控制对这个对象的访问. 它的作⽤就是通过提供⼀个代理类, 让我们在调⽤⽬标⽅法的时候, 不再是直接对⽬标⽅法进⾏调⽤, ⽽是通过代理类间接调⽤.
在某些情况下, ⼀个对象不适合或者不能直接引⽤另⼀个对象, ⽽代理对象可以在客⼾端和⽬标对象之间起到中介的作⽤.
⽣活中的代理
•艺⼈经纪⼈: ⼴告商找艺⼈拍⼴告, 需要经过经纪⼈,由经纪⼈来和艺⼈进⾏沟通.
•房屋中介: 房屋进⾏租赁时, 卖⽅会把房屋授权给中介, 由中介来代理看房, 房屋咨询等服务.
•经销商: ⼚商不直接对外销售产品, 由经销商负责代理销售.
•秘书/助理: 合作伙伴找⽼板谈合作, 需要先经过秘书/助理预约.
代理模式的主要⻆⾊
1.Subject: 业务接⼝类. 可以是抽象类或者接⼝(不⼀定有)
2.RealSubject: 业务实现类. 具体的业务执⾏, 也就是被代理对象.
3.Proxy: 代理类. RealSubject的代理.
UML类图如下:
代理模式可以在不修改被代理对象的基础上, 通过扩展代理类, 进⾏⼀些功能的附加与增强.
根据代理的创建时期, 代理模式分为静态代理和动态代理
•静态代理: 由程序员创建代理类或特定⼯具⾃动⽣成源代码再对其编译, 在程序运⾏前代理类的
.class ⽂件就已经存在了.
•动态代理: 在程序运⾏时, 运⽤反射机制动态创建⽽成.
1.AOP是⼀种思想, 是对某⼀类事情的集中处理. Spring框架实现了AOP, 称之为SpringAOP
2.Spring AOP常⻅实现⽅式有两种: 1. 基于注解@Aspect来实现 2. 基于⾃定义注解来实现, 还有⼀些更原始的⽅式,⽐如基于代理, 基于xml配置的⽅式, 但⽬标⽐较少⻅
3.Spring AOP 是基于动态代理实现的, 有两种⽅式: 1. 基本JDK动态代理实现 2. 基于CGLIB动态代理实现. 运⾏时使⽤哪种⽅式与项⽬配置和代理的对象有关.
RELATED READING
延伸阅读
更多一线实战笔记与深度复盘,助您持续精进