一、AOP概述
- 在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续,是软件开发中的一个热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。
- 通俗描述:不通过修改源代码的方式实现在主干功能里面添加新功能(例如我想增强已写好的登录功能,不去修改已有的登录代码,而是使用AOP增强)
二、AOP底层原理
AOP 底层使用了动态代理,动态代理的代理对象是动态生成的,而静态代理每个被代理类就需要写一个对应的代理类,代码冗余,不灵活。
有以下两种情况的动态代理:
- 第一种:有接口情况,使用 JDK 动态代理(创建接口实现类的代理对象,增强类的方法)
- 第二种:没有接口情况,使用 CGLIB 动态代理(创建子类的代理对象,增强类的方法)
(一)JDK动态代理
- JDK代理是不需要第三方库支持的,只需要JDK环境就可以进行代理,使用条件:
(1)被代理的类必须要实现接口;
(2)必须实现 InvocationHandler 接口;
(3)使用 lang 包下的 Proxy 类里面的newProxyInstance()
方法创建代理对象 newProxyInstance()
方法有三个参数:
第一个参数,类加载器
第二个参数,被增强方法所在的类所实现的接口(支持多个接口)
第三个参数,实现接口 InvocationHandler 的类,这个类用于写增强逻辑。InvocationHandler直译是调用处理器,它的对象本质是 Proxy 类的代理,也就是真实对象的代理的代理。Proxy类实现了真实对象的接口,所以它的对象可以调用真实对象的方法,调用时是指派invocationHandler 去实际执行系统增强业务(即日志、事务等) 和真实业务。
案例:不修改add()代码的情况下增强add()方法
创建接口UserDao,定义方法:
public interface UserDao {
public int add(int a,int b);
}
创建接口实现类UserDaoImpl,实现方法:
public class UserDaoImpl implements UserDao {
@Override
public int add(int a, int b) {
System.out.println("add方法执行了");
return a+b;
}
}
创建实现 InvocationHandler 接口的类:
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.util.Arrays;
public class UserDaoProxy implements InvocationHandler {
//创建的是谁的代理对象,就把谁传递过来
//用有参构造传递
//用Object更加通用
private Object obj;
public UserDaoProxy(Object obj) {
this.obj = obj;
}
/**
* 增强的逻辑
* @param proxy:真实的代理对象 com.sun.proxy.$Proxy0
* @param method:被增强的方法(即add())
* @param args:被增强方法里的参数
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//方法之前
System.out.println("此处是增强逻辑代码(方法之前执行)");
//执行被增强的方法,result是方法返回结果,即add结果
Object result = method.invoke(obj, args);
System.out.println("被增强方法:"+method.getName()+" 传递的参数:"+ Arrays.toString(args)+" 代理谁:"+obj);
//方法之后
System.out.println("此处是增强逻辑代码(方法之后执行)");
return result;
}
}
测试类:使用Proxy类的方法创建代理对象
import com.fox.dao.UserDao;
import com.fox.dao.UserDaoImpl;
import com.fox.proxy.UserDaoProxy;
import java.lang.reflect.Proxy;
public class MyTest {
public static void main(String[] args) {
//被增强方法所在的类所实现的接口的数组
Class[] interfaces = {UserDao.class};
//创建需要被代理的类的对象
UserDaoImpl userDao = new UserDaoImpl();
//创建代理对象
UserDao dao = (UserDao) Proxy.newProxyInstance(MyTest.class.getClassLoader(), interfaces, new UserDaoProxy(userDao));
int result = dao.add(1, 2);//这里的result等于UserDaoProxy的invoke方法返回的result
System.out.println("结果:"+result);
}
}
- 当代理对象生成后,最后由InvocationHandler的
invoke()
方法调用目标方法 - 在动态代理中InvocationHandler是核心,每个代理实例都具有一个关联的调用处理程序(InvocationHandler)。
- 对代理实例调用方法时,将对方法调用进行编码并将其指派到它的调用处理程序(InvocationHandler)的
invoke()
方法。 - 所以对代理方法的调用都是通过InvocationHadler的
invoke()
来实现,而invoke()
方法根据传入的代理对象,方法和参数来决定调用代理的哪个方法。 invoke()
方法的第一个参数proxy是代理类的真实代理对象,我们可以使用反射获取该代理对象的信息(也就是proxy.getClass().getName()
),也可以将代理对象返回以进行连续调用,这就是proxy存在的目的。 为什么不用this替代这个proxy? 因为this代表的是InvocationHandler接口实现类本身,并不是真实的代理对象。
(二)CGLIB动态代理
- JDK代理要求被代理的类必须实现接口,有很强的局限性。而CGLIB动态代理则没有此类强制性要求。简单的说,CGLIB会让生成的代理类继承被代理类,并在代理类中对代理方法进行强化处理(前置处理、后置处理等)。
- 如果被代理类被final修饰,那么它不可被继承,即不可被代理;同样,如果被代理类中存在final修饰的方法,那么该方法也不可被代理。
- 需要实现MethodInterceptor接口,其中有一个
intercept()
方法,有四个参数:- Object o:代理对象本身
- Method method: 被代理对象的方法
- Object[] args:被代理对象的方法的参数
- MethodProxy methodProxy:被代理对象的方法的代理
- CGLIB动态代理需要第三方库支持:
CGLIB包的底层是通过使用一个小而快的字节码处理框架ASM(Java字节码操控框架)来转换字节码并生成新的类。所以CGLIB包要依赖于ASM包,需要一起导入。
案例:不修改add()代码的情况下增强add()方法
导入包:
创建User类:
public class User {
public int add(int a,int b){
System.out.println("add方法执行了");
return a+b;
}
}
创建MethodInterceptor的实现类:
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
import java.util.Arrays;
public class UserMethodInterceptor implements MethodInterceptor {
@Override
public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
//方法之前
System.out.println("此处是增强逻辑代码(方法之前执行)");
//执行被增强的方法,result是方法返回结果,即add结果
Object result = methodProxy.invokeSuper(o, args);
System.out.println("被增强方法:"+method.getName()+",传递的参数:"+ Arrays.toString(args)+
",代理对象:"+o.getClass().getName()+",方法的代理:"+methodProxy.getClass().getName());
//方法之后
System.out.println("此处是增强逻辑代码(方法之后执行)");
return result;
}
}
测试类:
import com.fox.dao.User;
import com.fox.proxy.UserMethodInterceptor;
import net.sf.cglib.proxy.Enhancer;
public class Test {
public static void main(String[] args) {
User user = new User();
UserMethodInterceptor userMethodInterceptor = new UserMethodInterceptor();
Enhancer enhancer = new Enhancer();
// 设置enhancer对象的父类
enhancer.setSuperclass(user.getClass());
// 设置enhancer的回调对象
enhancer.setCallback(userMethodInterceptor);
// 创建代理对象
User proxy= (User)enhancer.create();
// 通过代理对象调用目标方法
int add = proxy.add(1, 2);
System.out.println("结果:"+add);
}
}
三、AOP术语
- 连接点
类里面哪些方法可以被增强,这些方法称为连接点 - 切入点
在类中可以有很多的方法被增强,但是在实际开发中,只是增强类里面的某些方法,那么实际被增强的方法就称之为切入点。
切入点和连接点不是一对一的关系,一个切入点可以匹配多个连接点。
连接点是客观存在的,可简单理解为切入点的集合,他只是对应用程序的所有需要进行插入切面的一个统称。 - 通知(增强)
实际增强的逻辑部分称为通知(增强),通知有多种类型:- 前置通知:写在被增强方法前的增强逻辑
- 后置通知:写在被增强方法后的增强逻辑
- 环绕通知:写在被增强方法前和后的增强逻辑
- 异常通知:当被增强方法出现异常才会执行的增强逻辑
- 最终通知:类似finallly,异常通知是有异常才会执行,而最终通知无论如何都会执行
- 切面
是一种动作,是把通知应用到切入点的过程
四、AOP操作
(一)知识准备
1.AspectJ
- Spring 框架一般都是基于 AspectJ 实现 AOP 操作
- AspectJ 不是 Spring 的组成部分,是一个独立的 AOP 框架,一般把 AspectJ 和 Spring 框架一起使用,进行 AOP 操作
- 基于 AspectJ 实现 AOP 操作有两种方法:
- 基于 xml 配置文件实现
- 基于注解方式实现(使用)
2.导入依赖
在项目工程里面引入 AOP 相关依赖:
3.切入点表达式
- 切入点表达式作用:知道对哪个类里面的哪个方法进行增强
- 语法结构:
execution(权限修饰符 【返回类型】 类全路径.方法名称(参数列表))
举例 1:对 com.fox.dao.BookDao 类里面的 add() 进行增强
execution(* com.fox.dao.BookDao.add(..))
举例 2:对 com.fox.dao.BookDao 类里面的所有的方法进行增强
execution(* com.fox.dao.BookDao.*(..))
。
举例 3:对 com.fox.dao 包里面所有类,类里面所有方法进行增强
execution(* com.fox.dao.*.*(..))
(二)基于xml配置文件实现 AOP 操作
创建两个类,增强类和被增强类,创建方法:
//被增强类
public class Book {
//切入点(被增强方法)
public void add(){
System.out.println("add方法执行了");
}
}
//增强类
public class BookProxy {
//假如我想配置个前置通知:
public void beforeAdd(){
System.out.println("beforeAdd方法执行了");
}
}
在 spring 配置文件中创建两个类对象并配置切入点(注意需要写aop名称空间):
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
<!--创建对象-->
<bean id="book" class="com.fox.aopxml.Book"></bean>
<bean id="bookProxy" class="com.fox.aopxml.BookProxy"></bean>
<!--配置 aop-->
<aop:config>
<!--配置切入点。 id:标识、别名。expression:切入点表达式-->
<aop:pointcut id="pc" expression="execution(* com.fox.aopxml.Book.add(..))"/>
<!--配置切面。 ref:增强类bean的id-->
<aop:aspect ref="bookProxy">
<!-- <aop:before>是配置前置通知。method:增强方法。 pointcut-ref:切入点id-->
<aop:before method="beforeAdd" pointcut-ref="pc"/>
</aop:aspect>
</aop:config>
</beans>
测试类:
import com.fox.aopxml.Book;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class MyTest {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("bean1.xml");
Book book = context.getBean("book", Book.class);
book.add();
}
}
(三)基于注解实现 AOP 操作
1.基本实现
创建两个类,增强类和被增强类,创建方法,并使用注解(创建对象的注解和增强类上面添加@Aspect注解):
import org.springframework.stereotype.Component;
//被增强类
@Component
public class Book {
//切入点(被增强方法)
public void add(){
System.out.println("add方法执行了");
}
}
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
//增强类
@Component
@Aspect
public class BookProxy {
//假如我想配置个前置通知:
public void beforeAdd(){
System.out.println("beforeAdd方法执行了");
}
}
在 spring 配置文件中开启注解扫描并开启生成代理对象(注意需要写aop和context名称空间):
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
<!-- 开启注解扫描 -->
<context:component-scan base-package="com.fox"></context:component-scan>
<!-- 开启 Aspect 生成代理对象-->
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>
在增强类的通知方法上面添加通知类型注解,使用切入点表达式配置:
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
//增强类
@Component
@Aspect
public class BookProxy {
@Before(value = "execution(* com.fox.aopxml.Book.add(..))")
public void beforeAdd(){
System.out.println("beforeAdd方法执行了");
}
}
测试类:
import com.fox.aopxml.Book;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class MyTest {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("bean1.xml");
Book book = context.getBean("book", Book.class);
book.add();
}
}
2.五种通知的实现
以注解方式为例,实现五种通知,xml方式同理:
还是用上面的BookProxy为例:
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
//增强类
@Component
@Aspect
public class BookProxy {
//前置通知
@Before(value = "execution(* com.fox.aopxml.Book.add(..))")
public void beforeAdd(){
System.out.println("前置通知执行了");
}
//后置通知(被增强方法成功返回结果后才执行)
@AfterReturning(value = "execution(* com.fox.aopxml.Book.add(..))")
public void afterReturning() {
System.out.println("后置通知执行了");
}
//最终通知(无论被增强方法是否成功返回结果都执行)
@After(value = "execution(* com.fox.aopxml.Book.add(..))")
public void after() {
System.out.println("最终通知执行了");
}
//异常通知(被增强方法有异常时才执行)
@AfterThrowing(value = "execution(* com.fox.aopxml.Book.add(..))")
public void afterThrowing() {
System.out.println("异常通知执行了");
}
//环绕通知=前置通知+目标方法执行+后置通知
//ProceedingJoinPoint 负责继续处理原始的连接点。
//proceed方法就是用于启动切入点方法执行的
@Around(value = "execution(* com.fox.aopxml.Book.add(..))")
public void around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
System.out.println("环绕之前");
//被增强的方法执行
proceedingJoinPoint.proceed();
System.out.println("环绕之后");
}
}
我们发现异常通知没执行,因为被增强方法还没有异常,我们加个异常:
import org.springframework.stereotype.Component;
//被增强类
@Component
public class Book {
//切入点(被增强方法)
public void add(){
int i=1/0;
System.out.println("add方法执行了");
}
}
我们发现,有异常后,环绕之后和后置通知都没执行,而最终通知无论如何都执行了。
3.相同切入点抽取
通过上面的例子我们发现,假如增强类中有多个通知,并且切入点都相同,那么假如想修改切入点的时候就要在每一个切入点表达式上都做修改,十分麻烦。因此我们可以将相同的切入点抽取出来(@Pointcut注解):
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
//增强类
@Component
@Aspect
public class BookProxy {
//相同切入点抽取
@Pointcut(value = "execution(* com.fox.aopxml.Book.add(..))")
public void pointCut1(){
}
//前置通知
@Before(value = "pointCut1()")
public void beforeAdd(){
System.out.println("前置通知执行了");
}
//后置通知(被增强方法成功返回结果后才执行)
@AfterReturning(value = "pointCut1()")
public void afterReturning() {
System.out.println("后置通知执行了");
}
//最终通知(无论被增强方法是否成功返回结果都执行)
@After(value = "pointCut1()")
public void after() {
System.out.println("最终通知执行了");
}
//异常通知(被增强方法有异常时才执行)
@AfterThrowing(value = "pointCut1()")
public void afterThrowing() {
System.out.println("异常通知执行了");
}
//环绕通知=前置通知+目标方法执行+后置通知
//ProceedingJoinPoint 负责继续处理原始的连接点。
//proceed方法就是用于启动切入点方法执行的
@Around(value = "pointCut1()")
public void around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
System.out.println("环绕之前");
//被增强的方法执行
proceedingJoinPoint.proceed();
System.out.println("环绕之后");
}
}
4.设置增强类优先级
假设有多个增强类都对被增强类的同一个方法进行增强,我们希望按照我们的想法按顺序增强,那么我们就可以设置优先级。在增强类上面添加注解 @Order(数字类型值),数字类型值越小优先级越高
增强类:
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
//增强类
@Component
@Aspect
@Order(3)
public class BookProxy {
//前置通知
@Before(value = "execution(* com.fox.aopxml.Book.add(..))")
public void beforeAdd(){
System.out.println("前置通知执行了");
}
}
另外一个增强类:
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
//新增强类
@Component
@Aspect
@Order(1)
public class NewBookProxy {
//前置通知
@Before(value = "execution(* com.fox.aopxml.Book.add(..))")
public void beforeAdd(){
System.out.println("新的前置通知执行了");
}
}
5.完全注解开发
上面的例子还是使用了spring的xml配置文件,下面演示实现完全注解开发:
被增强类:
import org.springframework.stereotype.Component;
//被增强类
@Component
public class Book {
//切入点(被增强方法)
public void add(){
System.out.println("add方法执行了");
}
}
增强类:
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
//增强类
@Component
@Aspect
public class BookProxy {
//前置通知
@Before(value = "execution(* com.fox.aopxml.Book.add(..))")
public void beforeAdd(){
System.out.println("前置通知执行了");
}
}
创建配置类,替代 xml 配置文件:
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
@Configuration//声明将此类作为配置类,替代 xml 配置文件
@ComponentScan(basePackages = {"com.fox"})//用于扫描指定包
@EnableAspectJAutoProxy(proxyTargetClass = true)//开启生成代理对象
public class MySpringConfig {
}
编写测试类(注意要使用AnnotationConfigApplicationContext):
import com.fox.aopxml.Book;
import com.fox.config.MySpringConfig;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class MyTest {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(MySpringConfig.class);
Book book = context.getBean("book", Book.class);
book.add();
}
}