Spring AOP

什么是AOP?

Aspect Oriented Programming(⾯向切⾯编程)

什么是⾯向切⾯编程呢? 切⾯就是指某⼀类特定问题, 所以AOP也可以理解为⾯向特定⽅法编程.

什么是⾯向特定⽅法编程呢?比如拦截器. AOP是⼀种思想, 拦截器是AOP思想的⼀种实现. Spring框架实现了这种思想, 提供了拦截器技术的相关接⼝.

同样的, 统⼀数据返回格式和统⼀异常处理, 也是AOP思想的⼀种实现.

简单来说: AOP是⼀种思想, 是对某⼀类事情的集中处理.

什么是Spring AOP?

AOP是⼀种思想, 它的实现⽅法有很多, 有Spring AOP,也有AspectJ、CGLIB等.

Spring AOP是其中的⼀种实现⽅式

Spring AOP快速⼊⻔

引⼊AOP依赖

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

编写AOP程序

记录Controller中每个⽅法的执⾏时间

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
@Slf4j
@Aspect
@Component
public class TimeAspect {
 /**
 * 记录⽅法耗时
 */
 @Around("execution(* com.example.demo.controller.*.*(..))")
 public Object recordTime(ProceedingJoinPoint pjp) throws Throwable {
 //记录⽅法执⾏开始时间
 long begin = System.currentTimeMillis();
 //执⾏原始⽅法
 Object result = pjp.proceed();
 //记录⽅法执⾏结束时间
 long end = System.currentTimeMillis();
 //记录⽅法执⾏耗时
 log.info(pjp.getSignature() + "执⾏耗时: {}ms", end - begin);
 return result;
 }
}

对程序进⾏简单的讲解:
1. @Aspect: 标识这是⼀个切⾯类
2. @Around: 环绕通知, 在⽬标⽅法的前后都会被执⾏. 后⾯的表达式表⽰对哪些⽅法进⾏增强.
3. ProceedingJoinPoint.proceed() 让原始⽅法执⾏

我们通过AOP⼊⻔程序完成了业务接⼝执⾏耗时的统计.

通过上⾯的程序, 我们也可以感受到AOP⾯向切⾯编程的⼀些优势:

代码⽆侵⼊: 不修改原始的业务⽅法, 就可以对原始的业务⽅法进⾏了功能的增强或者是功能的改

减少了重复代码

提⾼开发效率

维护⽅便

Spring AOP 详解

Spring AOP核⼼概念

切点(Pointcut)

切点(Pointcut), 也称之为"切⼊点"

Pointcut 的作⽤就是提供⼀组规则 (使⽤ AspectJ pointcut expression language 来描述), 告诉程序对哪些⽅法来进⾏功能增强.

上⾯的表达式 execution(* com.example.demo.controller.*.*(..)) 就是切点表达式

连接点(Join Point)

满⾜切点表达式规则的⽅法, 就是连接点. 也就是可以被AOP控制的⽅法
以⼊⻔程序举例, 所有 com.example.demo.controller 路径下的⽅法, 都是连接点.
package com.example.demo.controller;
@RequestMapping("/book")
@RestController
public class BookController {
 @RequestMapping("/addBook")
 public Result addBook(BookInfo bookInfo) {
 //...代码省略
 }
 @RequestMapping("/queryBookById")
 public BookInfo queryBookById(Integer bookId){
 //...代码省略
 }
 @RequestMapping("/updateBook")
 public Result updateBook(BookInfo bookInfo) {
 //...代码省略
 }
}

通知(Advice)

通知就是具体要做的⼯作, 指哪些重复的逻辑,也就是共性功能(最终体现为⼀个⽅法)
⽐如上述程序中记录业务⽅法的耗时时间, 就是通知

在AOP⾯向切⾯编程当中, 我们把这部分重复的代码逻辑抽取出来单独定义, 这部分代码就是通知的内容.

切⾯(Aspect)

切⾯(Aspect) = 切点(Pointcut) + 通知(Advice)

通过切⾯就能够描述当前AOP程序需要针对于哪些⽅法, 在什么时候执⾏什么样的操作.

切⾯既包含了通知逻辑的定义, 也包括了连接点的定义.

切⾯所在的类, 我们⼀般称为切⾯类(被@Aspect注解标识的类)

通知类型

上⾯我们讲了什么是通知, 接下来学习通知的类型. @Around 就是其中⼀种通知类型, 表⽰环绕通知.

Spring中AOP的通知类型有以下⼏种:

@Around: 环绕通知, 此注解标注的通知⽅法在⽬标⽅法前, 后都被执⾏

@Before: 前置通知, 此注解标注的通知⽅法在⽬标⽅法前被执⾏

@After: 后置通知, 此注解标注的通知⽅法在⽬标⽅法后被执⾏, ⽆论是否有异常都会执⾏

@AfterReturning: 返回后通知, 此注解标注的通知⽅法在⽬标⽅法后被执⾏, 有异常不会执⾏

@AfterThrowing: 异常后通知, 此注解标注的通知⽅法发⽣异常后执⾏

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

@Slf4j
@Aspect
@Component
public class AspectDemo {
 //前置通知
 @Before("execution(* com.example.demo.controller.*.*(..))")
 public void doBefore() {
 log.info("执⾏ Before ⽅法");
 }
 //后置通知
 @After("execution(* com.example.demo.controller.*.*(..))")
 public void doAfter() {
 log.info("执⾏ After ⽅法");
 }
 //返回后通知
 @AfterReturning("execution(* com.example.demo.controller.*.*(..))")
 public void doAfterReturning() {
 log.info("执⾏ AfterReturning ⽅法");
 }
 //抛出异常后通知
 @AfterThrowing("execution(* com.example.demo.controller.*.*(..))")
 public void doAfterThrowing() {
 log.info("执⾏ doAfterThrowing ⽅法");
 }
 //添加环绕通知
 @Around("execution(* com.example.demo.controller.*.*(..))")
 public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
 log.info("Around ⽅法开始执⾏");
 Object result = joinPoint.proceed();
 log.info("Around ⽅法结束执⾏");
 return result;
 }
}

写⼀些测试程序

package com.example.demo.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/test")
@RestController
public class TestController {
 @RequestMapping("/t1")
 public String t1() {
 return "t1";
 }
 @RequestMapping("/t2")
 public boolean t2() {
 int a = 10 / 0;
 return true;
 }
}

程序正常运⾏的情况下, @AfterThrowing 标识的通知⽅法不会执⾏

从上图也可以看出来, @Around 标识的通知⽅法包含两部分, ⼀个"前置逻辑", ⼀个"后置逻辑".其

中"前置逻辑" 会先于 @Before 标识的通知⽅法执⾏, "后置逻辑" 会晚于 @After 标识的通知⽅法执

异常时的情况

程序发⽣异常的情况下:

@AfterReturning 标识的通知⽅法不会执⾏, @AfterThrowing 标识的通知⽅法执⾏了

@Around 环绕通知中原始⽅法调⽤时有异常,通知中的环绕后的代码逻辑也不会在执⾏了(因为

原始⽅法调⽤出异常了)

注意事项:

@Around 环绕通知需要调⽤ ProceedingJoinPoint.proceed() 来让原始⽅法执⾏, 其他

通知不需要考虑⽬标⽅法执⾏.

@Around 环绕通知⽅法的返回值, 必须指定为Object, 来接收原始⽅法的返回值, 否则原始⽅法执

⾏完毕, 是获取不到返回值的.

⼀个切⾯类可以有多个切点.

@PointCut

上⾯代码存在⼀个问题, 就是存在⼤量重复的切点表达式 execution(*
com.example.demo.controller.*.*(..)) , Spring提供了 @PointCut 注解, 把公共的切点
表达式提取出来, 需要⽤到时引⽤该切⼊点表达式即可
@Slf4j
@Aspect
@Component
public class AspectDemo {
 //定义切点(公共的切点表达式)
 @Pointcut("execution(* com.example.demo.controller.*.*(..))")
 private void pt(){}
 //前置通知
 @Before("pt()")
 public void doBefore() {
 //...代码省略
 }
 //后置通知
 @After("pt()")
 public void doAfter() {
 //...代码省略
 }
 //返回后通知
 @AfterReturning("pt()")
 public void doAfterReturning() {
 //...代码省略
 }
 //抛出异常后通知
 @AfterThrowing("pt()")
 public void doAfterThrowing() {
 //...代码省略
 }
 //添加环绕通知
 @Around("pt()")
 public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
 //...代码省略
 }
}
当切点定义使⽤private修饰时, 仅能在当前切⾯类中使⽤, 当其他切⾯类也要使⽤当前切点定义时, 就需要把private改为public. 引⽤⽅式为: 全限定类名.⽅法名()
@Slf4j
@Aspect
@Component
public class AspectDemo2 {
 //前置通知
 @Before("com.example.demo.aspect.AspectDemo.pt()")
 public void doBefore() {
 log.info("执⾏ AspectDemo2 -> Before ⽅法");
 }
}

切⾯优先级 @Order

存在多个切⾯类时, 默认按照切⾯类的类名字⺟排序:

@Before 通知:字⺟排名靠前的先执⾏

@After 通知:字⺟排名靠前的后执⾏

但这种⽅式不⽅便管理, 我们的类名更多还是具备⼀定含义的.

Spring 给我们提供了⼀个新的注解, 来控制这些切⾯通知的执⾏顺序: @Order

@Aspect
@Component
@Order(2)
public class AspectDemo2 {
 //...代码省略
}

@Aspect
@Component
@Order(1)
public class AspectDemo3 {
 //...代码省略
}

@Aspect
@Component
@Order(3)
public class AspectDemo4 {
 //...代码省略
}

@Order 控制切⾯的优先级, 先执⾏优先级较⾼的切⾯, 再执⾏优先级较低的切⾯, 最终执⾏⽬标⽅法.

切点表达式

execution表达式

execution() 是最常⽤的切点表达式, ⽤来匹配⽅法, 语法为:

切点表达式⽀持通配符表达:

1. * :匹配任意字符,只匹配⼀个元素(返回类型, 包, 类名, ⽅法或者⽅法参数)

a. 包名使⽤ * 表⽰任意包(⼀层包使⽤⼀个*)

b. 类名使⽤ * 表⽰任意类

c. 返回值使⽤ * 表⽰任意返回值类型

d. ⽅法名使⽤ * 表⽰任意⽅法

e. 参数使⽤ * 表⽰⼀个任意类型的参数

2. .. :匹配多个连续的任意符号, 可以通配任意层级的包, 或任意类型, 任意个数的参数

a. 使⽤ .. 配置包名,标识此包以及此包下的所有⼦包

b. 可以使⽤ .. 配置参数,任意个任意类型的参数

@annotation

execution表达式更适⽤有规则的, 如果我们要匹配多个⽆规则的⽅法呢

这个时候我们使⽤execution这种切点表达式来描述就不是很⽅便了.

我们可以借助⾃定义注解的⽅式以及另⼀种切点表达式 @annotation 来描述这⼀类的切点.

实现步骤:

1. 编写⾃定义注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAspect {

}

1. @Target 标识了 Annotation 所修饰的对象范围, 即该注解可以⽤在什么地⽅.

常⽤取值:

ElementType.TYPE: ⽤于描述类、接⼝(包括注解类型) 或enum声明

ElementType.METHOD: 描述⽅法

ElementType.PARAMETER: 描述参数

ElementType.TYPE_USE: 可以标注任意类型

2. @Retention 指Annotation被保留的时间⻓短, 标明注解的⽣命周期

@Retention 的取值有三种:

1. RetentionPolicy.SOURCE:表⽰注解仅存在于源代码中, 编译成字节码后会被丢弃. 这意味着

在运⾏时⽆法获取到该注解的信息, 只能在编译时使⽤. ⽐如 @SuppressWarnings , 以及

lombok提供的注解 @Data , @Slf4j

2. RetentionPolicy.CLASS:编译时注解. 表⽰注解存在于源代码和字节码中, 但在运⾏时会被丢

弃. 这意味着在编译时和字节码中可以通过反射获取到该注解的信息, 但在实际运⾏时⽆法获

取. 通常⽤于⼀些框架和⼯具的注解.

3. RetentionPolicy.RUNTIME:运⾏时注解. 表⽰注解存在于源代码, 字节码和运⾏时中. 这意味

着在编译时, 字节码中和实际运⾏时都可以通过反射获取到该注解的信息. 通常⽤于⼀些需要

在运⾏时处理的注解, 如Spring的 @Controller @ResponseBody

2. 使⽤ @annotation 表达式来描述切点

切⾯类代码如下:

@Slf4j
@Component
@Aspect
public class MyAspectDemo {
 //前置通知
 @Before("@annotation(com.example.demo.aspect.MyAspect)")
 public void before(){
 log.info("MyAspect -> before ...");
 }
 //后置通知
 @After("@annotation(com.example.demo.aspect.MyAspect)")
 public void after(){
 log.info("MyAspect -> after ...");
 }
}
3. 在连接点的⽅法上添加⾃定义注解
在TestController中的t1()和UserController中的u1()这两个⽅法上添加⾃定义注解 @MyAspect , 其
他⽅法不添加
@MyAspect
@RequestMapping("/t1")
public String t1() {
 return "t1";
}
@MyAspect
@RequestMapping("/u1")
public String u1(){
 return "u1";
}
Spring AOP的实现⽅式(常⻅⾯试题)
1. 基于注解 @Aspect 
2. 基于⾃定义注解 (参考⾃定义注解 @annotation 部分的内容)
3. 基于Spring API (通过xml配置的⽅式, ⾃从SpringBoot ⼴泛使⽤之后, 这种⽅法⼏乎看不到了)
4. 基于代理来实现(更加久远的⼀种实现⽅式, 写法笨重, 不建议使⽤)

Spring AOP 原理

代理模式

代理模式, 也叫委托模式.

定义:为其他对象提供⼀种代理以控制对这个对象的访问. 它的作⽤就是通过提供⼀个代理类, 让我们在调⽤⽬标⽅法的时候, 不再是直接对⽬标⽅法进⾏调⽤, ⽽是通过代理类间接调⽤.

在某些情况下, ⼀个对象不适合或者不能直接引⽤另⼀个对象, ⽽代理对象可以在客⼾端和⽬标对象之间起到中介的作⽤.

使⽤代理前:

使⽤代理后:

代理模式的主要⻆⾊

1. Subject: 业务接⼝类. 可以是抽象类或者接⼝(不⼀定有)

2. RealSubject: 业务实现类. 具体的业务执⾏, 也就是被代理对象.

3. Proxy: 代理类. RealSubject的代理

代理模式可以在不修改被代理对象的基础上, 通过扩展代理类, 进⾏⼀些功能的附加与增强.

根据代理的创建时期, 代理模式分为静态代理和动态代理

静态代理

由程序员创建代理类或特定⼯具⾃动⽣成源代码再对其编译, 在程序运⾏前代理类的

.class ⽂件就已经存在了

虽然静态代理也完成了对⽬标对象的代理, 但是由于代码都写死了, 对⽬标对象的

每个⽅法的增强都是⼿动完成的,⾮常不灵活. 所以⽇常开发⼏乎看不到静态代理的场景

动态代理

在程序运⾏时, 运⽤反射机制动态创建⽽成.

相⽐于静态代理来说,动态代理更加灵活.

我们不需要针对每个⽬标对象都单独创建⼀个代理对象, ⽽是把这个创建代理对象的⼯作推迟到程序运⾏时由JVM来实现. 也就是说动态代理在程序运⾏时, 根据需要动态创建⽣成.

JDK动态代理
JDK 动态代理类实现步骤

1. 定义⼀个接⼝及其实现类(静态代理中的 HouseSubject RealHouseSubject )

2. ⾃定义 InvocationHandler 并重写 invoke ⽅法,在 invoke ⽅法中我们会调⽤⽬标⽅

法(被代理类的⽅法)并⾃定义⼀些处理逻辑

3. 通过 Proxy.newProxyInstance(ClassLoader loader,Class<?>[]

interfaces,InvocationHandler h) ⽅法创建代理对象

定义JDK动态代理类

实现 InvocationHandler 接⼝

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
public class JDKInvocationHandler implements InvocationHandler {
 //⽬标对象即就是被代理对象
 private Object target;
 public JDKInvocationHandler(Object target) {
 this.target = target;
 }
 
 @Override
 public Object invoke(Object proxy, Method method, Object[] args) throws
Throwable {
 // 代理增强内容
 System.out.println("我是中介, 开始代理");
 //通过反射调⽤被代理类的⽅法
 Object retVal = method.invoke(target, args);
 //代理增强内容
 System.out.println("我是中介, 代理结束");
 return retVal;
 }
}
创建⼀个代理对象并使⽤
public class DynamicMain {
 public static void main(String[] args) {
 HouseSubject target= new RealHouseSubject();
 //创建⼀个代理类:通过被代理类、被代理实现的接⼝、⽅法调⽤处理器来创建
 HouseSubject proxy = (HouseSubject) Proxy.newProxyInstance(
 target.getClass().getClassLoader(),
 new Class[]{HouseSubject.class},
 new JDKInvocationHandler(target)
 );
 proxy.rentHouse();
 }
}
1. InvocationHandler
InvocationHandler 接⼝是Java动态代理的关键接⼝之⼀, 它定义了⼀个单⼀⽅法 invoke() , ⽤于
处理被代理对象的⽅法调⽤.
public interface InvocationHandler {
 /**
 * 参数说明
 * proxy:代理对象
 * method:代理对象需要实现的⽅法,即其中需要重写的⽅法
 * args:method所对应⽅法的参数
 */
 public Object invoke(Object proxy, Method method, Object[] args)
 throws Throwable;
}
通过实现 InvocationHandler 接⼝, 可以对被代理对象的⽅法进⾏功能增强
2. Proxy
Proxy 类中使⽤频率最⾼的⽅法是: newProxyInstance() , 这个⽅法主要⽤来⽣成⼀个代理
对象
public static Object newProxyInstance(ClassLoader loader,
 Class<?>[] interfaces,
 InvocationHandler h)
 throws IllegalArgumentException
 {
 //...代码省略
 }
这个⽅法⼀共有 3 个参数:
Loader: 类加载器, ⽤于加载代理对象.
interfaces : 被代理类实现的⼀些接⼝(这个参数的定义, 也决定了JDK动态代理只能代理实现了接⼝的
⼀些类)
h : 实现了 InvocationHandler 接⼝的对象

CGLIB动态代理

JDK 动态代理有⼀个最致命的问题是其只能代理实现了接⼝的类.

有些场景下, 我们的业务代码是直接实现的, 并没有接⼝定义. 为了解决这个问题, 我们可以⽤ CGLIB 动态代理机制来解决.

CGLIB 动态代理类实现步骤

添加依赖

<dependency>
 <groupId>cglib</groupId>
 <artifactId>cglib</artifactId>
 <version>3.3.0</version>
</dependency>

1. 定义⼀个类(被代理类)

2. ⾃定义 MethodInterceptor 并重写 intercept ⽅法, intercept ⽤于增强⽬标⽅

法,和 JDK 动态代理中的 invoke ⽅法类似

⾃定义 MethodInterceptor(⽅法拦截器)

import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class CGLIBInterceptor implements MethodInterceptor {
 //⽬标对象, 即被代理对象
 private Object target;
 public CGLIBInterceptor(Object target){
 this.target = target;
 }
 @Override
 public Object intercept(Object o, Method method, Object[] objects, 
MethodProxy methodProxy) throws Throwable {
 // 代理增强内容
 System.out.println("我是中介, 开始代理");
 //通过反射调⽤被代理类的⽅法
 Object retVal = methodProxy.invoke(target, objects);
 //代理增强内容
 System.out.println("我是中介, 代理结束");
 return retVal;
 }
}

3. 通过 Enhancer 类的 create()创建代理类

public class DynamicMain {
 public static void main(String[] args) {
 HouseSubject target= new RealHouseSubject();
 HouseSubject proxy= (HouseSubject) 
Enhancer.create(target.getClass(),new CGLIBInterceptor(target));
 proxy.rentHouse();
 }
}
1. MethodInterceptor
MethodInterceptor 和 JDK动态代理中的 InvocationHandler 类似, 它只定义了⼀个⽅
intercept() , ⽤于增强⽬标⽅法
public interface MethodInterceptor extends Callback {
 /**
 * 参数说明:
 * o: 被代理的对象
 * method: ⽬标⽅法(被拦截的⽅法, 也就是需要增强的⽅法)
 * objects: ⽅法⼊参
 * methodProxy: ⽤于调⽤原始⽅法
 */
 Object intercept(Object o, Method method, Object[] objects, MethodProxy 
methodProxy) throws Throwable;
}
2. Enhancer.create()

Enhancer.create() ⽤来⽣成⼀个代理对象

public static Object create(Class type, Callback callback) {
 //...代码省略
}

参数说明:

type: 被代理类的类型(类或接⼝)

callback: ⾃定义⽅法拦截器 MethodInterceptor

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值