关于Spring——AOP

Posted 2020-12-15 战狂粗人张

基于@AspectJ的AOP

Spring除了支持Schema方式配置AOP，还支持注解方式：使用@AspectJ风格的切面声明。

一.启用对@AspectJ的支持

Spring默认不支持@AspectJ风格的切面声明，为了支持需要使用如下配置：

<aop:aspectj-autoproxy/>

这样Spring就能发现@AspectJ风格的切面并且将切面应用到目标对象。

二.声明切面

@AspectJ风格的声明切面非常简单，使用@Aspect注解进行声明：

@Aspect()
Public class Aspect{
……
}

然后将该切面在配置文件中声明为Bean后，Spring就能自动识别并进行AOP方面的配置：

<bean id="aspect" class="……Aspect"/>

该切面就是一个POJO，可以在该切面中进行切入点及通知定义，接着往下看。

 

三.声明切入点

@AspectJ风格的命名切入点使用org.aspectj.lang.annotation包下的@Pointcut+方法（方法必须是返回void类型）实现。

@Pointcut(value="切入点表达式", argNames = "参数名列表")
public void pointcutName(……) {}

value：指定切入点表达式；

argNames：指定命名切入点方法参数列表参数名字，可以有多个用“，”分隔，这些参数将传递给通知方法同名的参数，

                     同时比如切入点表达式“args(param)”将匹配参数类型为命名切入点方法同名参数指定的参数类型。

pointcutName：切入点名字，可以使用该名字进行引用该切入点表达式。

@Pointcut(value="execution(* cn.javass..*.sayAdvisorBefore(..)) && args(param)", argNames = "param")
public void beforePointcut(String param) {

}

定义了一个切入点，名字为“beforePointcut”，该切入点将匹配目标方法的第一个参数类型为通知方法实现中参数名为“param”的参数类型。

 

四.声明通知

@AspectJ风格的声明通知也支持5种通知类型：

1、前置通知：使用org.aspectj.lang.annotation 包下的@Before注解声明；

@Before(value = "切入点表达式或命名切入点", argNames = "参数列表参数名")

value：指定切入点表达式或命名切入点；

argNames：与Schema方式配置中的同义。

接下来示例一下吧：

（1）定义接口和实现，在此我们就使用Schema风格时的定义；

（2）定义切面：

package cn.javass.spring.chapter6.aop;
import org.aspectj.lang.annotation.Aspect;
@Aspect
public class HelloWorldAspect2 {

}

（3）定义切入点：

@Pointcut(value="execution(* cn.javass..*.sayAdvisorBefore(..)) && args(param)", 
argNames = "param")
public void beforePointcut(String param) {}

（4）定义通知：

@Before(value = "beforePointcut(param)", argNames = "param")
public void beforeAdvice(String param) {
　　System.out.println("===========before advice param:" + param);
}

（5）在chapter6/advice2.xml配置文件中进行如下配置：

<?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-3.0.xsd
           http://www.springframework.org/schema/aop

@Test
public void testAnnotationBeforeAdvice() {
　　System.out.println("======================================");
　　ApplicationContext ctx = new ClassPathXmlApplicationContext("chapter6/advice2.xml");
　　IHelloWorldService helloworldService = ctx.getBean("helloWorldService", IHelloWorldService.class);
　　helloworldService.sayBefore("before");    System.out.println("======================================");
}

将输出：

==========================================
===========before advice param:before
============say before
==========================================

切面、切入点、通知全部使用注解完成：

1）使用@Aspect将POJO声明为切面；

2）使用@Pointcut进行命名切入点声明，同时指定目标方法第一个参数类型必须是java.lang.String，对于其他匹配的方法但参数类型不一致的将也是不匹配的，

      通过argNames = "param"指定了将把该匹配的目标方法参数传递给通知同名的参数上；

3）使用@Before进行前置通知声明，其中value用于定义切入点表达式或引用命名切入点；

4）配置文件需要使用<aop:aspectj-autoproxy/>来开启注解风格的@AspectJ支持；

5）需要将切面注册为Bean，如“aspect”Bean；

6）测试代码完全一样。

 

2、后置返回通知：使用org.aspectj.lang.annotation 包下的@AfterReturning注解声明；

@AfterReturning(
　　value="切入点表达式或命名切入点", 
　　pointcut="切入点表达式或命名切入点", 
　　argNames="参数列表参数名", 
　　returning="返回值对应参数名")

value：指定切入点表达式或命名切入点；

pointcut：同样是指定切入点表达式或命名切入点，如果指定了将覆盖value属性指定的，pointcut具有高优先级；

argNames：与Schema方式配置中的同义；

returning：与Schema方式配置中的同义。

@AfterReturning(
value="execution(* cn.javass..*.sayBefore(..))",pointcut="execution(* cn.javass..*.sayAfterReturning(..))", argNames="retVal", returning="retVal")
public void afterReturningAdvice(Object retVal) {
    System.out.println("===========after returning advice retVal:" + retVal);
}

其中测试代码与Schema方式几乎一样，在此就不演示了，如果需要请参考AopTest.java中的testAnnotationAfterReturningAdvice测试方法。

 

3、后置异常通知：使用org.aspectj.lang.annotation 包下的@AfterThrowing注解声明；

@AfterThrowing (
　　value="切入点表达式或命名切入点", 
　　pointcut="切入点表达式或命名切入点", 
　　argNames="参数列表参数名", 
　　throwing="异常对应参数名")

value：指定切入点表达式或命名切入点；

pointcut：同样是指定切入点表达式或命名切入点，如果指定了将覆盖value属性指定的，pointcut具有高优先级；

argNames：与Schema方式配置中的同义；

throwing：与Schema方式配置中的同义。

@AfterThrowing(
value="execution(* cn.javass..*.sayAfterThrowing(..))",argNames="exception", throwing="exception")
public void afterThrowingAdvice(Exception exception) {
  System.out.println("===========after throwing advice exception:" + exception);
}

其中测试代码与Schema方式几乎一样，在此就不演示了，如果需要请参考AopTest.java中的testAnnotationAfterThrowingAdvice测试方法。

 

4、后置最终通知：使用org.aspectj.lang.annotation 包下的@After注解声明；

@After (
　　value="切入点表达式或命名切入点", 
　　argNames="参数列表参数名")

value：指定切入点表达式或命名切入点；

argNames：与Schema方式配置中的同义；

@After(value="execution(* cn.javass..*.sayAfterFinally(..))")
public void afterFinallyAdvice() {
    System.out.println("===========after finally advice");
}

其中测试代码与Schema方式几乎一样，在此就不演示了，如果需要请参考AopTest.java中的testAnnotationAfterFinallyAdvice测试方法。

 

5、环绕通知：使用org.aspectj.lang.annotation 包下的@Around注解声明；

@Around (
　　value="切入点表达式或命名切入点", 
　　argNames="参数列表参数名")

value：指定切入点表达式或命名切入点；

argNames：与Schema方式配置中的同义；

@Around(value="execution(* cn.javass..*.sayAround(..))")
public Object aroundAdvice(ProceedingJoinPoint pjp) throws Throwable {
    System.out.println("===========around before advice");
    Object retVal = pjp.proceed(new Object[] {"replace"});
    System.out.println("===========around after advice");
    return retVal;
}

其中测试代码与Schema方式几乎一样，在此就不演示了，如果需要请参考AopTest.java中的annotationAroundAdviceTest测试方法。

 

五.引入

@AspectJ风格的引入声明在切面中使用org.aspectj.lang.annotation包下的@DeclareParents声明：

@DeclareParents(
　　value=" AspectJ语法类型表达式",
　　defaultImpl=引入接口的默认实现类)
private Interface interface;

value：匹配需要引入接口的目标对象的AspectJ语法类型表达式；与Schema方式中的types-matching属性同义；

private Interface interface：指定需要引入的接口；

defaultImpl：指定引入接口的默认实现类，没有与Schema方式中的delegate-ref属性同义的定义方式；

@DeclareParents(
value="cn.javass..*.IHelloWorldService+", defaultImpl=cn.javass.spring.chapter6.service.impl.IntroductiondService.class)
private IIntroductionService introductionService;

其中测试代码与Schema方式几乎一样，在此就不演示了，如果需要请参考AopTest.java中的testAnnotationIntroduction测试方法。

 

六.AspectJ切入点语法详解

Spring AOP支持的AspectJ切入点指示符

切入点指示符用来指示切入点表达式目的，，在Spring AOP中目前只有执行方法这一个连接点，Spring AOP支持的AspectJ切入点指示符如下：

execution：用于匹配方法执行的连接点；

within：用于匹配指定类型内的方法执行；

this：用于匹配当前AOP代理对象类型的执行方法；注意是AOP代理对象的类型匹配，这样就可能包括引入接口也类型匹配；

target：用于匹配当前目标对象类型的执行方法；注意是目标对象的类型匹配，这样就不包括引入接口也类型匹配；

args：用于匹配当前执行的方法传入的参数为指定类型的执行方法；

@within：用于匹配所以持有指定注解类型内的方法；

@target：用于匹配当前目标对象类型的执行方法，其中目标对象持有指定的注解；

@args：用于匹配当前执行的方法传入的参数持有指定注解的执行；

@annotation：用于匹配当前执行方法持有指定注解的方法；

bean：Spring AOP扩展的，AspectJ没有对于指示符，用于匹配特定名称的Bean对象的执行方法；

reference pointcut：表示引用其他命名切入点，只有@ApectJ风格支持，Schema风格不支持。

AspectJ切入点支持的切入点指示符还有： call、get、set、preinitialization、staticinitialization、initialization、handler、adviceexecution、withincode、cflow、

cflowbelow、if、@this、@withincode；但Spring AOP目前不支持这些指示符，使用这些指示符将抛出IllegalArgumentException异常。这些指示符Spring AOP可能会在以后进行扩展。

 

1.命名及匿名切入点

命名切入点可以被其他切入点引用，而匿名切入点是不可以的。

只有@AspectJ支持命名切入点，而Schema风格不支持命名切入点。

如下所示，@AspectJ使用如下方式引用命名切入点：

@Pointcut(
value="execution(* cn.javass..*.sayBefore(java.lang.String)) && args(param)", 
argNames = "param")
public void beforePointcut(String param) {}
                      引用命名切入点
@Before(value = "beforePointcut(param)", argNames = "param")
public void beforeAdvice(String param) {
    System.out.println("===========before advice param:" + param);
}

2.类型匹配语法

首先让我们来了解下AspectJ类型匹配的通配符：

*：匹配任何数量字符；

 ..：匹配任何数量字符的重复，如在类型模式中匹配任何数量子包；而在方法参数模式中匹配任何数量参数。

+：匹配指定类型的子类型；仅能作为后缀放在类型模式后边。

java.lang.String    匹配String类型；
java.*.String       匹配java包下的任何“一级子包”下的String类型；
                    如匹配java.lang.String，但不匹配java.lang.ss.String
java..*             匹配java包及任何子包下的任何类型;
                    如匹配java.lang.String、java.lang.annotation.Annotation
java.lang.*ing      匹配任何java.lang包下的以ing结尾的类型；
java.lang.Number+   匹配java.lang包下的任何Number的自类型；
                    如匹配java.lang.Integer，也匹配java.math.BigInteger

接下来再看一下具体的匹配表达式类型吧：

匹配类型：使用如下方式匹配

注解？ 类的全限定名字

注解：可选，类型上持有的注解，如@Deprecated；

类的全限定名：必填，可以是任何类全限定名。

匹配方法执行：使用如下方式匹配：

注解？ 修饰符? 返回值类型 类型声明?方法名(参数列表) 异常列表？

注解：可选，方法上持有的注解，如@Deprecated；
修饰符：可选，如public、protected；
返回值类型：必填，可以是任何类型模式；“*”表示所有类型；
类型声明：可选，可以是任何类型模式；
方法名：必填，可以使用“*”进行模式匹配；
参数列表：“()”表示方法没有任何参数；“(..)”表示匹配接受任意个参数的方法，“(..,java.lang.String)”表示匹配接受java.lang.String类型的参数结束，
        且其前边可以接受有任意个参数的方法；“(java.lang.String,..)” 表示匹配接受java.lang.String类型的参数开始，
        且其后边可以接受任意个参数的方法；“(*,java.lang.String)” 表示匹配接受java.lang.String类型的参数结束，且其前边接受有一个任意类型参数的方法；
异常列表：可选，以“throws 异常全限定名列表”声明，异常全限定名列表如有多个以“，”分割，如throws java.lang.IllegalArgumentException, java.lang.ArrayIndexOutOfBoundsException。

匹配Bean名称：可以使用Bean的id或name进行匹配，并且可使用通配符“*”；

 

3.组合切入点表达式

AspectJ使用 且（&&）、或（||）、非（！）来组合切入点表达式。

在Schema风格下，由于在XML中使用“&&”需要使用转义字符“&amp;&amp;”来代替之，所以很不方便，因此Spring ASP 提供了and、or、not来代替&&、||、！。

 

 

六.通知参数

前边章节已经介绍了声明通知，但如果想获取被被通知方法参数并传递给通知方法，该如何实现呢？接下来我们将介绍两种获取通知参数的方式。

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

当然第一个参数位置也可以是JoinPoint.StaticPart类型，这个只返回连接点的静态部分。

1) JoinPoint：提供访问当前被通知方法的目标对象、代理对象、方法参数等数据：

package org.aspectj.lang;
import org.aspectj.lang.reflect.SourceLocation;
public interface JoinPoint {
    String toString();         //连接点所在位置的相关信息
    String toShortString();     //连接点所在位置的简短相关信息
    String toLongString();     //连接点所在位置的全部相关信息
    Object getThis();         //返回AOP代理对象
    Object getTarget();       //返回目标对象
    Object[] getArgs();       //返回被通知方法参数列表
    Signature getSignature();  //返回当前连接点签名
    SourceLocation getSourceLocation();//返回连接点方法所在类文件中的位置
    String getKind();        //连接点类型
    StaticPart getStaticPart(); //返回连接点静态部分
}

2）ProceedingJoinPoint：用于环绕通知，使用proceed()方法来执行目标方法：

public interface ProceedingJoinPoint extends JoinPoint {
    public Object proceed() throws Throwable;
    public Object proceed(Object[] args) throws Throwable;
}

3) JoinPoint.StaticPart：提供访问连接点的静态部分，如被通知方法签名、连接点类型等：

public interface StaticPart {
Signature getSignature();    //返回当前连接点签名
String getKind();          //连接点类型
    int getId();               //唯一标识
String toString();         //连接点所在位置的相关信息
    String toShortString();     //连接点所在位置的简短相关信息
    String toLongString();     //连接点所在位置的全部相关信息
}

使用如下方式在通知方法上声明，必须是在第一个参数，然后使用jp.getArgs()就能获取到被通知方法参数：

@Before(value="execution(* sayBefore(*))")
public void before(JoinPoint jp) {}

@Before(value="execution(* sayBefore(*))")
public void before(JoinPoint.StaticPart jp) {}

 

自动获取：通过切入点表达式可以将相应的参数自动传递给通知方法，例如前边章节讲过的返回值和异常是如何传递给通知方法的。

在Spring AOP中，除了execution和bean指示符不能传递参数给通知方法，其他指示符都可以将匹配的相应参数或对象自动传递给通知方法。

@Before(value="execution(* test(*)) && args(param)", argNames="param")
public void before1(String param) {
    System.out.println("===param:" + param);
}

切入点表达式execution(* test(*)) && args(param) ：

1）首先execution(* test(*))匹配任何方法名为test，且有一个任何类型的参数；

2）args(param)将首先查找通知方法上同名的参数，并在方法执行时（运行时）匹配传入的参数是使用该同名参数类型，即java.lang.String；

     如果匹配将把该被通知参数传递给通知方法上同名参数。其他指示符（除了execution和bean指示符）都可以使用这种方式进行参数绑定。

在此有一个问题，即前边提到的类似于【3.1.2 构造器注入】中的参数名注入限制：在class文件中没生成变量调试信息是获取不到方法参数名字的。

所以我们可以使用策略来确定参数名：

1）如果我们通过“argNames”属性指定了参数名，那么就是要我们指定的；

@Before(value=" args(param)", argNames="param") //明确指定了
public void before1(String param) {
    System.out.println("===param:" + param);
}

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

@Before(value=" args(param)", argNames="param") //明确指定了
public void before1(JoinPoint jp, String param) {
    System.out.println("===param:" + param);
}

3）如果“class文件中含有变量调试信息”将使用这些方法签名中的参数名来确定参数名；

@Before(value=" args(param)") //不需要argNames了
public void before1(JoinPoint jp, String param) {
    System.out.println("===param:" + param);
}

4）如果没有“class文件中含有变量调试信息”，将尝试自己的参数匹配算法，如果发现参数绑定有二义性将抛出AmbiguousBindingException异常；对于只有一个绑定变量的切入点表达式，而通知方法只接受一个参数，说明绑定参数是明确的，从而能配对成功。

@Before(value=" args(param)") 
public void before1(JoinPoint jp, String param) {
    System.out.println("===param:" + param);
}

5）以上策略失败将抛出IllegalArgumentException。

接下来让我们示例一下组合情况吧：

@Before(args(param) && target(bean) && @annotation(secure)", argNames="jp,param,bean,secure")
public void before5(JoinPoint jp, String param, IPointcutService pointcutService, Secure secure) {
……
}

 除了上边介绍的普通方式，也可以对使用命名切入点自动获取参数：

@Pointcut(value="args(param)", argNames="param")
private void pointcut1(String param){ 

}

@Pointcut(value="@annotation(secure)", argNames="secure")
private void pointcut2(Secure secure){

}
    
@Before(value = "pointcut1(param) && pointcut2(secure)",argNames="param, secure")
public void before6(JoinPoint jp, String param, Secure secure) {
……
}

自此给通知传递参数已经介绍完了，示例代码在cn.javass.spring.chapter6.ParameterTest文件中。

 

七.通知顺序

如果我们有多个通知想要在同一连接点执行，那执行顺序如何确定呢？Spring AOP使用AspectJ的优先级规则来确定通知执行顺序。

总共有两种情况：同一切面中通知执行顺序、不同切面中的通知执行顺序。

首先让我们看下

1）同一切面中通知执行顺序：如图所示

而如果在同一切面中定义两个相同类型通知（如同是前置通知或环绕通知（proceed之前））并在同一连接点执行时，

其执行顺序是未知的，如果确实需要指定执行顺序需要将通知重构到两个切面，然后定义切面的执行顺序。

错误“Advice precedence circularity error”：说明AspectJ无法决定通知的执行顺序，只要将通知方法分类并按照顺序排列即可解决。

不同切面中的通知执行顺序：当定义在不同切面的相同类型的通知需要在同一个连接点执行，如果没指定切面的执行顺序，这两个通知的执行顺序将是未知的。

如果需要他们顺序执行，可以通过指定切面的优先级来控制通知的执行顺序。

Spring中可以通过在切面实现类上实现org.springframework.core.Ordered接口或使用Order注解来指定切面优先级。

在多个切面中，Ordered.getValue()方法返回值（或者注解值）较小值的那个切面拥有较高优先级，如图所示：

对于@AspectJ风格和注解风格可分别用以下形式指定优先级：

@Aspect
@Order(2)
public class OrderAspect2 {

}

<aop:aspect ref="aspect1" order="1">
……
</aop:aspect>

在此我们不推荐使用实现Ordered接口方法。

 

八.切面实例化模型

所谓切面实例化模型指何时实例化切面。

Spring AOP支持AspectJ的singleton、perthis、pertarget实例化模型（目前不支持percflow、percflowbelow 和pertypewithin）。

singleton：即切面只会有一个实例；

perthis：每个切入点表达式匹配的连接点对应的AOP对象都会创建一个新切面实例；

pertarget：每个切入点表达式匹配的连接点对应的目标对象都会创建一个新的切面实例；

默认是singleton实例化模型，Schema风格只支持singleton实例化模型，而@AspectJ风格支持这三种实例化模型。

singleton：使用@Aspect()指定，即默认就是单例实例化模式，在此就不演示示例了。

 

perthis：每个切入点表达式匹配的连接点对应的AOP对象都会创建一个新的切面实例，使用@Aspect("perthis(切入点表达式)")指定切入点表达式；

如@Aspect("perthis(this(cn.javass.spring.chapter6.service.IIntroductionService))")将

对每个匹配“this(cn.javass.spring.chapter6.service.IIntroductionService)”切入点表达式的AOP代理对象创建一个切面实例，注意“IIntroductionService”可能是引入接口。

 

pertarget：每个切入点表达式匹配的连接点对应的目标对象都会创建一个新的切面实例，使用@Aspect("pertarget(切入点表达式)")指定切入点表达式；

如@Aspect("pertarget(target(cn.javass.spring.chapter6. service.IPointcutService))")将

对每个匹配“target(cn.javass.spring.chapter6.service. IPointcutService)”切入点表达式的目标对象创建一个切面，注意“IPointcutService”不可能是引入接口。

在进行切面定义时必须将切面scope定义为“prototype”，如“<bean class="……Aspect" scope="prototype"/>”，否则不能为每个匹配的连接点的目标对象或AOP代理对象创建一个切面。

  

九.代理机制

Spring AOP通过代理模式实现，目前支持两种代理：JDK动态代理、CGLIB代理来创建AOP代理，Spring建议优先使用JDK动态代理。

1.JDK动态代理：使用java.lang.reflect.Proxy动态代理实现，即提取目标对象的接口，然后对接口创建AOP代理。

2.CGLIB代理：CGLIB代理不仅能进行接口代理，也能进行类代理，CGLIB代理需要注意以下问题：

不能通知final方法，因为final方法不能被覆盖（CGLIB通过生成子类来创建代理）。

会产生两次构造器调用，第一次是目标类的构造器调用，第二次是CGLIB生成的代理类的构造器调用。如果需要CGLIB代理方法，请确保两次构造器调用不影响应用。

Spring AOP默认首先使用JDK动态代理来代理目标对象，如果目标对象没有实现任何接口将使用CGLIB代理，如果需要强制使用CGLIB代理，请使用如下方式指定：

对于Schema风格配置切面使用如下方式来指定使用CGLIB代理：

<aop:config proxy-target-class="true">
</aop:config>

而如果使用@AspectJ风格使用如下方式来指定使用CGLIB代理：

<aop:aspectj-autoproxy proxy-target-class="true"/>

 

十.总结

代理知识总结：

1.Spring在运行期，生成动态代理对象，不需要特殊的编译器；

2.Spring AOP的底层就是通过JDK动态代理或CGLib动态代理技术 为目标Bean执行横向织入；

3.若目标对象实现了若干接口，spring使用JDK的java.lang.reflect.Proxy类代理；

4.若目标对象没有实现任何接口，spring使用CGLIB库生成目标对象的子类；

5.程序中应优先对接口创建代理，便于程序解耦维护；

6.标记为final的方法，不能被代理，因为无法进行覆盖；

7.JDK动态代理，是针对接口生成子类，接口中方法不能使用final修饰；

8.CGLib 是针对目标类生产子类，因此类或方法 不能使final的；

9.Spring只支持方法连接点，不提供属性连接；