Spring AOP 基于注解的声明式AspectJ详解

在 Spring 中 AOP 是一个非常非常重要的概念,那么什么是AOP呢?

AOP 即面向切面编程,也可以叫做面向方向编程,AOP不是一个新东西,它是OOP,即面向对象编程的一种补充,在当前已经成为一种成熟的编程方式。

为啥要使用 AOP

在学习AOP 之前,我们先了解下为啥我们要使用AOP?

那么,在传统的业务处理代码中,比如你要操作数据库,会进行事务的处理或者打印一些日志。虽然通过OOP 也可以实现,比如通过继承或组合的方式来达到代码的复用,但是如果实现某些功能,比如日志记录,相同的代码会分散到各个方法中,如果后面要想关闭某个功能或进行修改就必须要修改所有的方法,非常的不方便。

那么为了解决为了解决这个问题,AOP的思想随之产生。它采取了横向抽取机制。将分散在各个方法中的重复代码提取出来,然后在程序编译或运行时,再将这些提取出来的代码应用到需要执行的地方。这种采用横向提取机制的方式。是采用传统的AOP方式下无法办到的。因为传统的面向对象思想只能实现父子关系的纵向重用。

在AOP思想中,通过aspect(切面)可以分别在不同的类的方法中加入,例如事务日志权限和异常处理等功能。

使用切面这种横向方式。能够使开发人员在编写业务逻辑时专注于核心业务逻辑,而不用过度的关注与其他业务逻辑的实现。这样可以提高开发效率,同时还增强了代码的可维护性。

目前主流的AOP 框架有2个,分别是spring aop 和aspectJ,前者是纯Java 实现的,不需要专门的编译过程和类加载器,在运行期间可以通过代理的方式向目标内植入增强的代码。而AspectJ是一个基于Java语言的AOP框架。在Spring 2.0 开始,引入了对AspectJ 的支持,并提供了一个专门的编译器在编译时提供横向代码的植入。

相关术语

在了解AOP之前,首先要了解一下它的专业术语。这些术语包括Aspect、Joinpiont、Pointcut、Advice、Target Object、Proxy 和Weaving,对于这些专业术语具体的解释如下:

  • Aspect,切面在实际的应用中,切面通常是指封装的用于横向插入系统功能,比如事务日志的类,该类被spring容器识别为切面,需要在配置文件中通过<bean>来指定。
  • Joinpiont,连接点,在程序执行过程中的某个阶段点。它实际上是对象的一个操作,例如方法的调用或异常的抛出。在spring AOP中连接点就是指方法的调用。
  • Pointcut,切入点,切入点是指切面与程序流程的交叉点,即那些需要处理的连接点,通常在程序中切入点是指。类或者是方法名,比如说某个通知要应用到所有的以add开头的方法中。那么所有满足这一规则的方法都是切入点。
  • Adivce,通知增强处理,AOP 框架在特定的切入点执行增强处理,即在定义好的切入点处理所需要执行的程序代码,你可以理解其为切面类中的方法,它是切面的具体实现。
  • Target Object ,目标对象,是指所有通知的对象。也称为北增强对象。如果AOP框架采用的是动态的AOP实现,那么该对象就是一个被代理对象。
  • Proxy ,代理,将通知应用到目标对象之后被动态创建的对象。
  • Weaving, 织入,将切面代码插入目标对象上,从而生成代理对象的过程。

AspectJ 开发

使用AspectJ 实现AOP 的方式有

  • XML 声明
  • 注解

XML 声明

这种方式是通过XML文件来定义切面、切入点以及通知等,所有的切面、切入点和通知都必须定义在<aop:config> 元素中,在<beans>元素中可以包含多个<aop:config> 元素,一个<aop:config> 中又可以包含子元素和属性,其子元素包含<aop:pointcut<aop:advisor<aop:aspect>,在配置时,需要严格按照顺序来定义,在<aop:aspect> 下,同样包含属性和多个子元素,通过使用<aop:aspect>元素以及其子元素 可以在XML中配置切面、切入点和通知。如下所示

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<?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-4.3.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.3.xsd">
<!-- 1 目标类 -->
<bean id="userDao" class="com.ssm.aspectj.UserDaoImpl" />
<!-- 2 切面 -->
<bean id="myAspect" class="com.ssm.aspectj.xml.MyAspect" />
<!-- 3 aop编程 -->
<aop:config>
<!-- 1.配置切面 -->
<aop:aspect id="aspect" ref="myAspect">
<!-- 2.配置切入点 -->
<aop:pointcut expression="execution(* com.ssm.aspectj.*.*(..))" id="myPointCut" />
<!-- 3.配置通知 -->
<!-- 前置通知 -->
<aop:before method="myBefore" pointcut-ref="myPointCut" />
<!--后置通知-->
<aop:after-returning method="myAfterReturning" pointcut-ref="myPointCut" returning="returnVal"/>
<!--环绕通知 -->
<aop:around method="myAround" pointcut-ref="myPointCut" />
<!--异常通知 -->
<aop:after-throwing method="myAfterThrowing" pointcut-ref="myPointCut" throwing="e" />
<!--最终通知 -->
<aop:after method="myAfter" pointcut-ref="myPointCut" />
</aop:aspect>
</aop:config>
</beans>

但是 XML 的配置过于复杂,因为日常开发过程中,我们更倾向于使用注解的方式来进行AOP的开发

为了在应用中使用@AspectJ支持,Spring需要添加三个库:

  • aspectjweaver.jar
  • aspectjrt.jar
  • aopalliance.jar

因此,我们需要配置maven,如下所示

1
2
3
4
5
6
7
8
9
10
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.6.12</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.6.12</version>
</dependency>

新建一个app.xml ,我们需要在Spring配置文件中做如下配置:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?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-4.3.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.3.xsd">
<!-- 指定需要扫描的包,使注解生效 -->
<context:component-scan base-package="com.ssm.aspectj" />
<!-- 启动基于注解的声明式AspectJ支持 -->
<aop:aspectj-autoproxy />
</beans>

然后,我们创建一个UserDao 的接口,如下所示

1
2
3
4
5
6
7
8
9
package com.ssm.aspectj;

public interface UserDao {
// add user
public void addUser();

//delete user
public void delUser();
}

将 UserDao 实例化,并加上注解@Repository(“userDao”),方便后续进行调用具体的方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
package com.ssm.aspectj;

import org.springframework.stereotype.Repository;

@Repository("userDao")
public class UserDaoImpl implements UserDao{
@Override
public void addUser() {
System.out.println("add user");
}

@Override
public void delUser() {
System.out.println("delete user");

}
}

定义一个切面类,在该类中编写各种通知

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package com.ssm.aspectj.xml;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
/**
* 切面类,在此类中编写通知
*/
@Aspect
@Component
public class MyAspect {
//定义切入点表达式
@Pointcut("execution(* com.ssm.aspectj.*.*(..))")
//使用一个返回值为void、方法体为空的方法来命名切入点
private void myPointCut(){}
//前置通知
@Before("myPointCut()")
public void myBefore(JoinPoint joinPoint){
System.out.print("前置通知:模拟执行权限检查..,");
System.out.print("目标类是:"+joinPoint.getTarget());
System.out.println(",被植入增强处理的目标方法为:"+joinPoint.getSignature().getName());
}
//后置通知
@AfterReturning(value="myPointCut()")
public void myAfterReturning(JoinPoint joinPoint) {
System.out.print("后置通知:模拟记录日志..,");
System.out.println("被植入增强处理的目标方法为:" + joinPoint.getSignature().getName());
}
/**
* 环绕通知
* ProceedingJoinPoint是JoinPoint的子接口,表示可执行目标方法
* 1.必须是Object类型的返回值
* 2.必须接收一个参数,类型为ProceedingJoinPoint
* 3.必须throws Throwable
*/
@Around("myPointCut()")
public Object myAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable{
//开始
System.out.println("环绕开始:执行目标方法之前,模拟开启事务..,");
//执行当前目标方法
Object obj=proceedingJoinPoint.proceed();
//结束
System.out.println("环绕结束:执行目标方法之后,模拟关闭事务..,");
return obj;
}
//异常通知
@AfterThrowing(value="myPointCut()",throwing="e")
public void myAfterThrowing(JoinPoint joinPoint,Throwable e){
System.out.println("异常通知:出错了"+e.getMessage());
}
//最终通知
@After("myPointCut()")
public void myAfter(){
System.out.println("最终通知:模拟方法结束后释放资源..");
}
}

srping 的通知包括五种通知工作:

通知 描述
前置通知 在一个方法执行之前,执行通知。
后置通知 在一个方法执行之后,不考虑其结果,执行通知。
返回后通知 在一个方法执行之后,只有在方法成功完成时,才能执行通知。
抛出异常后通知 在一个方法执行之后,只有在方法退出抛出异常时,才能执行通知。
环绕通知 在建议方法调用之前和之后,执行通知。

在上述代码中,其中 @Pointcut(“execution(* com.ssm.aspectj..(..))”) 表示定义切入点,使用注解@Pointcut 后面的execution(* com.ssm.aspectj..(..)) 表示匹配所有目标类的所有方法。 第一个代表返回类型,第二个代表方法名,而..代表任意入参的方法,他的格式如下

语法:execution(修饰符 返回值 包.类.方法(参数) throws 异常)

最后编写个测试类从ClassPathXmlApplicationContext 读取xml 文件,然后调用getBean 获取userDao并执行addUser方法。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.ssm.aspectj;

import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class TestXmlAspectJ {
@Test
public void testAnnotation() {
ApplicationContext applicationContext=new ClassPathXmlApplicationContext("app.xml");
//从容器中获得内容
UserDao userDao= (UserDao) applicationContext.getBean("userDao");
//执行方法
userDao.addUser();
}
}

结果如下