Spring学习笔记整理——AOP

学习链接地址:http://www.iteye.com/blogs/subjects/spring3

第一部分 AOP基础

AOP是什么

面向方面编程(AOP):也可称为面向切面编程,是一种编程范式,提供从另一个角度来考虑程序结构从而完善面向对象编程(OOP)。

AOP为开发者提供一种进行横切关注点(比如日志关注点横切了支付关注点)分离并织入的机制,把横切关注点分离,然后通过某种技术织入到系统中,从而无耦合的完成了我们的功能。

能干什么

AOP主要用于横切关注点分离和织入,因此需要理解横切关注点和织入:

  • 关注点:可以认为是所关注的任何东西,比如上边的支付组件;
  • 关注点分离:将问题细化从而单独部分,即可以理解为不可再分割的组件,如上边的日志组件和支付组件;
  • 横切关注点:一个组件无法完成需要的功能,需要其他组件协作完成,如日志组件横切于支付组件;
  • 织入:横切关注点分离后,需要通过某种技术将横切关注点融合到系统中从而完成需要的功能,因此需要织入,织入可能在编译期、加载期、运行期等进行。

横切关注点可能包含很多,比如非业务的:日志、事务处理、缓存、性能统计、权限控制等等这些非业务的基础功能;还可能是业务的:如某个业务组件横切于多个模块。
Spring学习笔记整理——AOP_第1张图片
Spring学习笔记整理——AOP_第2张图片

AOP的基本概念

  • 连接点(Jointpoint):表示需要在程序中插入横切关注点的扩展点,连接点可能是类初始化、方法执行、方法调用、字段调用或处理异常等等,Spring只支持方法执行连接点,在AOP中表示为“在哪里干”
  • 切入点(Pointcut):选择一组相关连接点的模式,即可以认为连接点的集合,Spring支持perl5正则表达式和AspectJ切入点模式,Spring默认使用AspectJ语法,在AOP中表示为“在哪里干的集合”
  • 通知(Advice):在连接点上执行的行为,通知提供了在AOP中需要在切入点所选择的连接点处进行扩展现有行为的手段;包括前置通知(before advice)、后置通知(after advice)、环绕通知(around advice),在Spring中通过代理模式实现AOP,并通过拦截器模式以环绕连接点的拦截器链织入通知;在AOP中表示为“干什么”
  • 方面/切面(Aspect):横切关注点的模块化,比如上边提到的日志组件。可以认为是通知、引入和切入点的组合;在Spring中可以使用Schema和@AspectJ方式进行组织实现;在AOP中表示为“在哪干和干什么集合”
  • 引入(inter-type declaration):也称为内部类型声明,为已有的类添加额外新的字段或方法,Spring允许引入新的接口(必须对应一个实现)到所有被代理对象(目标对象),在AOP中表示为“干什么(引入什么)”
  • 目标对象(Target Object):需要被织入横切关注点的对象,即该对象是切入点选择的对象,需要被通知的对象,从而也可称为“被通知对象”;由于Spring AOP 通过代理模式实现,从而这个对象永远是被代理对象,在AOP中表示为“对谁干”
  • AOP代理(AOP Proxy):AOP框架使用代理模式创建的对象,从而实现在连接点处插入通知(即应用切面),就是通过代理来对目标对象应用切面。在Spring中,AOP代理可以用JDK动态代理或CGLIB代理实现,而通过拦截器模型应用切面。
  • 织入(Weaving):织入是一个过程,是将切面应用到目标对象从而创建出AOP代理对象的过程,织入可以在编译期、类装载期、运行期进行。
    Spring学习笔记整理——AOP_第3张图片

接下来再让我们具体看看Spring有哪些通知类型:

  • 前置通知(Before Advice):在切入点选择的连接点处的方法之前执行的通知,该通知不影响正常程序执行流程(除非该通知抛出异常,该异常将中断当前方法链的执行而返回)。
  • 后置通知(After Advice): 在切入点选择的连接点处的方法之后执行的通知,包括如下类型的后置通知:
    • 后置返回通知(After returning Advice):在切入点选择的连接点处的方法正常执行完毕时执行的通知,必须是连接点处的方法没抛出任何异常正常返回时才调用后置通知。
    • 后置异常通知(After throwing Advice): 在切入点选择的连接点处的方法抛出异常返回时执行的通知,必须是连接点处的方法抛出任何异常返回时才调用异常通知。
    • 后置最终通知(After finally Advice): 在切入点选择的连接点处的方法返回时执行的通知,不管抛没抛出异常都执行,类似于Java中的finally块。
  • 环绕通知(Around Advices):环绕着在切入点选择的连接点处的方法所执行的通知,环绕通知可以在方法调用之前和之后自定义任何行为,并且可以决定是否执行连接点处的方法、替换返回值、抛出异常等等。
    Spring学习笔记整理——AOP_第4张图片

AOP代理

AOP代理就是AOP框架通过代理模式创建的对象,Spring使用JDK动态代理或CGLIB代理来实现,Spring缺省使用JDK动态代理来实现,从而任何接口都可别代理,如果被代理的对象实现不是接口将默认使用CGLIB代理,不过CGLIB代理当然也可应用到接口。

AOP代理的目的就是将切面织入到目标对象。

第二部分 AOP的HelloWorld

/**
* 目标接口和实现类
*/

public interface IHelloWorldService {
    public void sayHello();
}

public class HelloWorldService implements IHelloWorldService {
    @Override
    public void sayHello() {
        System.out.println("============Hello World!");
    }
}
/**
* 切面支持类
*/

public class HelloWorldAspect {
    //前置通知
    public void beforeAdvice() {
        System.out.println("===========before advice");
    }
    //后置最终通知
    public void afterFinallyAdvice() {
        System.out.println("===========after finally advice");
    }
}

<bean id="helloWorldService" class="cn.javass.spring.chapter6.service.impl.HelloWorldService"/>


<bean id="aspect" class="cn.javass.spring.chapter6.aop.HelloWorldAspect"/>
<aop:config>
    <aop:pointcut id="pointcut" expression="execution(* cn.javass..*.*(..))"/>
    <aop:aspect ref="aspect">
        <aop:before pointcut-ref="pointcut" method="beforeAdvice"/>
        <aop:after pointcut="execution(* cn.javass..*.*(..))" method="afterFinallyAdvice"/>
    aop:aspect>
aop:config>
@Test
    public void testHelloworld() {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("chapter6/helloworld.xml");
        IHelloWorldService helloworldService = ctx.getBean("helloWorldService", IHelloWorldService.class);        helloworldService.sayHello();
}

===========before advice
============Hello World!
===========after finally advice

Spring AOP框架生成AOP代理过程
Spring学习笔记整理——AOP_第5张图片

第三部分 基于Schema的AOP

在Spring配置文件中,所以AOP相关定义必须放在< aop:config>标签下,该标签下可以有< aop:pointcut>、< aop:advisor>、< aop:aspect>标签,配置顺序不可变。

  • < aop:pointcut>:用来定义切入点,该切入点可以重用;
  • < aop:advisor>:用来定义只有一个通知和一个切入点的切面;
  • < aop:aspect>:用来定义切面,该切面可以包含多个切入点和通知,而且标签内部的通知和切入点定义是无序的;和advisor的区别就在此,advisor只包含一个通知和一个切入点。
    Spring学习笔记整理——AOP_第6张图片

声明切面

切面就是包含切入点和通知的对象,在Spring容器中将被定义为一个Bean,Schema方式的切面需要一个切面支持Bean,该支持Bean的字段和方法提供了切面的状态和行为信息,并通过配置方式来指定切入点和通知实现。

<bean id="aspectSupportBean" class="……"/>
<aop:config>
    <aop:aspect id="aspectId" ref="aspectSupportBean">
          ……
    aop:aspect>
aop:config>

声明切入点

切入点在Spring中也是一个Bean,Bean定义方式可以有很三种方式:

  • 在< aop:config>标签下使用< aop:pointcut>声明一个切入点Bean,该切入点可以被多个切面使用,对于需要共享使用的切入点最好使用该方式,该切入点使用id属性指定Bean名字,在通知定义时使用pointcut-ref属性通过该id引用切入点,expression属性指定切入点表达式:
<aop:config>
    <aop:pointcut id="pointcut" expression="execution(* cn.javass..*.*(..))"/>
    <aop:aspect ref="aspectSupportBean">
        <aop:before pointcut-ref="pointcut" method="before"/>
    aop:aspect>
aop:config>
  • 在< aop:aspect>标签下使用< aop:pointcut>声明一个切入点Bean,该切入点可以被多个切面使用,但一般该切入点只被该切面使用,当然也可以被其他切面使用,但最好不要那样使用,该切入点使用id属性指定Bean名字,在通知定义时使用pointcut-ref属性通过该id引用切入点,expression属性指定切入点表达式:
<aop:config>
    <aop:aspect ref="aspectSupportBean">
        <aop:pointcut id=" pointcut" expression="execution(* cn.javass..*.*(..))"/>
        <aop:before pointcut-ref="pointcut" method="before"/>
    aop:aspect>
aop:config>
  • 匿名切入点Bean,可以在声明通知时通过pointcut属性指定切入点表达式,该切入点是匿名切入点,只被该通知使用:
<aop:config>
    <aop:aspect ref="aspectSupportBean">
        <aop:after pointcut="execution(* cn.javass..*.*(..))" method="afterFinallyAdvice"/>
    aop:aspect>
aop:config>

声明通知

基于Schema方式支持前边介绍的5中通知类型:

  • 前置通知:在切入点选择的方法之前执行,通过< aop:aspect>标签下的< aop:before>标签声明:
<aop:before pointcut="切入点表达式"  pointcut-ref="切入点Bean引用"
    method="前置通知实现方法名" 
    arg-names="前置通知实现方法参数列表参数名字"/>
    
public void sayBefore(String param);

@Override
public void sayBefore(String param) {
    System.out.println("============say " + param);
}

public void beforeAdvice(String param) {
    System.out.println("===========before advice param:" + param);
}

"helloWorldService" class="cn.javass.spring.chapter6.service.impl.HelloWorldService"/>
"aspect" class="cn.javass.spring.chapter6.aop.HelloWorldAspect"/>

    ref="aspect">
        "execution(* cn.javass..*.sayBefore(..)) and args(param)" method="beforeAdvice(java.lang.String)" arg-names="param"/>
    


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


==========================================
===========before advice param:before
============say before
==========================================
  • 后置返回通知:在切入点选择的方法正常返回时执行,通过< aop:aspect>标签下的< aop:after-returning>标签声明:
after-returning pointcut="切入点表达式"  pointcut-ref="切入点Bean引用" 
    method="后置返回通知实现方法名" 
    arg-names="后置返回通知实现方法参数列表参数名字" 
    returning="返回值对应的后置返回通知实现方法参数名"/>
public boolean sayAfterReturning();

@Override
public boolean sayAfterReturning() {
    System.out.println("============after returning");
    return true;
}

public void afterReturningAdvice(Object retVal) {
    System.out.println("===========after returning advice retVal:" + retVal);
}


"execution(* cn.javass..*.sayAfterReturning(..))" method="afterReturningAdvice"  
    arg-names="retVal" returning="retVal"/>

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

======================================
============after returning
===========after returning advice retVal:true
======================================
  • 后置异常通知:在切入点选择的方法抛出异常时执行,通过< aop:aspect>标签下的< aop:after-throwing>标签声明
<aop:after-throwing pointcut="切入点表达式"  pointcut-ref="切入点Bean引用" method="后置异常通知实现方法名" 
    arg-names="后置异常通知实现方法参数列表参数名字"
    throwing="将抛出的异常赋值给的通知实现方法参数名"/>
public void sayAfterThrowing();

@Override
public void sayAfterThrowing() {
    System.out.println("============before throwing");
    throw new RuntimeException();
}

public void afterThrowingAdvice(Exception exception) {
  System.out.println("===========after throwing advice exception:" + exception);
}

"execution(* cn.javass..*.sayAfterThrowing(..))" method="afterThrowingAdvice" 
    arg-names="exception"
    throwing="exception"/>

@Test(expected = RuntimeException.class)
public void testSchemaAfterThrowingAdvice() {
    System.out.println("======================================");
    ApplicationContext ctx = new ClassPathXmlApplicationContext("chapter6/advice.xml");
    IHelloWorldService helloworldService = 
    ctx.getBean("helloWorldService", IHelloWorldService.class);
    helloworldService.sayAfterThrowing();    
    System.out.println("======================================");
}

======================================
============before throwing
===========after throwing advice exception:java.lang.RuntimeException
======================================
  • 后置最终通知:在切入点选择的方法返回时执行,不管是正常返回还是抛出异常都执行,通过< aop:aspect>标签下的< aop:after >标签声明
"切入点表达式"  pointcut-ref="切入点Bean引用"
    method="后置最终通知实现方法名" 
    arg-names="后置最终通知实现方法参数列表参数名字"/>
public boolean sayAfterFinally();

@Override
public boolean sayAfterFinally() {
     System.out.println("============before finally");
     throw new RuntimeException();
}

public void afterFinallyAdvice() {
        System.out.println("===========after finally advice");
}

"execution(* cn.javass..*.sayAfterFinally(..))" 
    method="afterFinallyAdvice"/>

@Test(expected = RuntimeException.class)
public void testSchemaAfterFinallyAdvice() {
    System.out.println("======================================");
    ApplicationContext ctx = new ClassPathXmlApplicationContext("chapter6/advice.xml");
    IHelloWorldService helloworldService = 
    ctx.getBean("helloWorldService", IHelloWorldService.class);
    helloworldService.sayAfterFinally();
    System.out.println("======================================");
}

======================================
============before finally
===========after finally advice
======================================
  • 环绕通知:环绕着在切入点选择的连接点处的方法所执行的通知,环绕通知非常强大,可以决定目标方法是否执行,什么时候执行,执行时是否需要替换方法参数,执行完毕是否需要替换返回值,可通过< aop:aspect>标签下的< aop:around >标签声明
"切入点表达式"  pointcut-ref="切入点Bean引用"
    method="后置最终通知实现方法名" 
    arg-names="后置最终通知实现方法参数列表参数名字"/>
public void sayAround(String param);

@Override
public void sayAround(String param) {
   System.out.println("============around param:" + param);
}

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;
}

"execution(* cn.javass..*.sayAround(..))" 
    method="aroundAdvice"/>

@Test
public void testSchemaAroundAdvice() {
    System.out.println("======================================");
    ApplicationContext ctx = new ClassPathXmlApplicationContext("chapter6/advice.xml");
    IHelloWorldService helloworldService = 
    ctx.getBean("helloWorldService", IHelloWorldService.class);
    helloworldService.sayAround("haha");
    System.out.println("======================================");
}

======================================
===========around before advice
============around param:replace
===========around after advice
======================================

引入

Spring引入允许为目标对象引入新的接口,通过在< aop:aspect>标签内使用< aop:declare-parents>标签进行引入

<aop:declare-parents types-matching="AspectJ语法类型表达式"                 
    implement-interface=引入的接口"                             
    default-impl="引入接口的默认实现" 
    delegate-ref="引入接口的默认实现Bean引用"/>
public interface IIntroductionService {
    public void induct();
}

public class IntroductiondService implements IIntroductionService {
    @Override
    public void induct() {
        System.out.println("=========introduction");
    }
}

"cn.javass..*.IHelloWorldService+"
    implement-interface="cn.javass.spring.chapter6.service.IIntroductionService"
    default-impl="cn.javass.spring.chapter6.service.impl.IntroductiondService"/>

@Test
public void testSchemaIntroduction() {
    System.out.println("======================================");
    ApplicationContext ctx = new ClassPathXmlApplicationContext("chapter6/advice.xml");
    IIntroductionService introductionService = 
    ctx.getBean("helloWorldService", IIntroductionService.class);
    introductionService.induct();
    System.out.println("======================================");
}

======================================
=========introduction
======================================

Advisor

Advisor表示只有一个通知和一个切入点的切面,由于Spring AOP都是基于AOP联盟的拦截器模型的环绕通知的,所以引入Advisor来支持各种通知类型(如前置通知等5种),Advisor概念来自于Spring1.2对AOP的支持,在AspectJ中没有相应的概念对应。

"切入点表达式" pointcut-ref="切入点Bean引用"
    advice-ref="通知API实现引用"/>
public void sayAdvisorBefore(String param);

@Override
public void sayAdvisorBefore(String param) {
System.out.println("============say " + param);
}

public class BeforeAdviceImpl implements MethodBeforeAdvice {
    @Override
    public void before(Method method, Object[] args, Object target) throws Throwable {
        System.out.println("===========before advice");
    }
}

"beforeAdvice" class="cn.javass.spring.chapter6.aop.BeforeAdviceImpl"/>

"execution(* cn.javass..*.sayAdvisorBefore(..))"
    advice-ref="beforeAdvice"/>

@Test
public void testSchemaAdvisor() {
   System.out.println("======================================");
   ApplicationContext ctx = new ClassPathXmlApplicationContext("chapter6/advice.xml");
   IHelloWorldService helloworldService =
   ctx.getBean("helloWorldService", IHelloWorldService.class);
   helloworldService.sayAdvisorBefore("haha");
   System.out.println("======================================");
}

======================================
===========before advice
============say haha
======================================

第四部分 基于@AspectJ的AOP

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

启用对@AspectJ的支持

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

<aop:aspectj-autoproxy/>

声明切面

@Aspect()
Public class Aspect{
……
}
id="aspect" class="……Aspect"/>

声明切入点

@Pointcut(value="切入点表达式", argNames = "参数名列表")
public void pointcutName(……) {}
@Pointcut(value="execution(* cn.javass..*.sayAdvisorBefore(..)) && args(param)", argNames = "param")
public void beforePointcut(String param) {}

声明通知

前置通知

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

}

@Pointcut(value="execution(* cn.javass..*.sayAdvisorBefore(..)) && 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);
}

version="1.0" encoding="UTF-8"?>
"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
           http://www.springframework.org/schema/aop/spring-aop-3.0.xsd">

  
  "helloWorldService" class="cn.javass.spring.chapter6.service.impl.HelloWorldService"/>

  "aspect" class="cn.javass.spring.chapter6.aop.HelloWorldAspect2"/>




@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
==========================================

后置返回通知

@AfterReturning(
    value="切入点表达式或命名切入点", 
    pointcut="切入点表达式或命名切入点", 
    argNames="参数列表参数名", 
    returning="返回值对应参数名")
@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);
}

后置异常通知

@AfterThrowing (
    value="切入点表达式或命名切入点", 
    pointcut="切入点表达式或命名切入点", 
    argNames="参数列表参数名", 
    throwing="异常对应参数名")
@AfterThrowing( value="execution(* cn.javass..*.sayAfterThrowing(..))", argNames="exception", throwing="exception")
public void afterThrowingAdvice(Exception exception) {
  System.out.println("===========after throwing advice exception:" + exception);
}

后置最终通知

@After (
    value="切入点表达式或命名切入点", 
    argNames="参数列表参数名")
@After(value="execution(* cn.javass..*.sayAfterFinally(..))")
public void afterFinallyAdvice() {
    System.out.println("===========after finally advice");
}

环绕通知

@Around (
    value="切入点表达式或命名切入点", 
    argNames="参数列表参数名")
@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;
}

引入

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

@DeclareParents( value=" AspectJ语法类型表达式", defaultImpl=引入接口的默认实现类)
private Interface interface;
@DeclareParents( value="cn.javass..*.IHelloWorldService+", defaultImpl=cn.javass.spring.chapter6.service.impl.IntroductiondService.class)
private IIntroductionService introductionService;

第五部分 AspectJ切入点语法详解

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

  • execution:用于匹配方法执行的连接点;
  • within:用于匹配指定类型内的方法执行;
  • this:用于匹配当前AOP代理对象类型的执行方法;注意是AOP代理对象的类型匹配,这样就可能包括引入接口也类型匹配;
  • target:用于匹配当前目标对象类型的执行方法;注意是目标对象的类型匹配,这样就不包括引入接口也类型匹配;
  • args:用于匹配当前执行的方法传入的参数为指定类型的执行方法;
  • @within:用于匹配所以持有指定注解类型内的方法;
  • @target:用于匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;
  • @args:用于匹配当前执行的方法传入的参数持有指定注解的执行;
  • @annotation:用于匹配当前执行方法持有指定注解的方法;
  • bean:Spring AOP扩展的,AspectJ没有对于指示符,用于匹配特定名称的Bean对象的执行方法;
  • reference pointcut:表示引用其他命名切入点,只有@ApectJ风格支持,Schema风格不支持。

命名及匿名切入点

Spring学习笔记整理——AOP_第7张图片

类型匹配语法

首先让我们来了解下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进行匹配,并且可使用通配符“*”;

组合切入点表达式

AspectJ使用 且(&&)、或(||)、非(!)来组合切入点表达式。
在Schema风格下,由于在XML中使用“&&”需要使用转义字符“&&”来代替之,所以很不方便,因此Spring ASP 提供了and、or、not来代替&&、||、!。

  1. execution:使用“execution(方法表达式)”匹配方法执行;
模式 描述
public * *(..) 任何公共方法的执行
*cn.javass..IPointcutService.*() cn.javass包及所有子包下IPointcutService接口中的任何无参方法
* cn.javass..*.*(..) cn.javass包及所有子包下任何类的任何方法
* cn.javass..IPointcutService.*(*) cn.javass包及所有子包下IPointcutService接口的任何只有一个参数方法
* (!cn.javass..IPointcutService+).*(..) 非“cn.javass包及所有子包下IPointcutService接口及子类型”的任何方法
* cn.javass..IPointcutService+.*() cn.javass包及所有子包下IPointcutService接口及子类型的的任何无参方法
* cn.javass..IPointcut*.test*(java.util.Date) cn.javass包及所有子包下IPointcut前缀类型的的以test开头的只有一个参数类型为java.util.Date的方法,注意该匹配是根据方法签名的参数类型进行匹配的,而不是根据执行时传入的参数类型决定的; 如定义方法:public void test(Object obj);即使执行时传入java.util.Date,也不会匹配的;
* cn.javass..IPointcut*.test*(..) throws IllegalArgumentException, ArrayIndexOutOfBoundsException cn.javass包及所有子包下IPointcut前缀类型的的任何方法,且抛出IllegalArgumentException和ArrayIndexOutOfBoundsException异常
* (cn.javass..IPointcutService+ && java.io.Serializable+).*(..) 任何实现了cn.javass包及所有子包下IPointcutService接口和java.io.Serializable接口的类型的任何方法
@java.lang.Deprecated * *(..) 任何持有@java.lang.Deprecated注解的方法
@java.lang.Deprecated @cn.javass..Secure * *(..) 任何持有@java.lang.Deprecated和@cn.javass..Secure注解的方法
@(java.lang.Deprecated || cn.javass..Secure) * *(..) 任何持有@java.lang.Deprecated或@ cn.javass..Secure注解的方法
(@cn.javass..Secure *) *(..) 任何返回值类型持有@cn.javass..Secure的方法
* (@cn.javass..Secure *).*(..) 任何定义方法的类型持有@cn.javass..Secure的方法
* *(@cn.javass..Secure (*) , @cn.javass..Secure (*)) 任何签名带有两个参数的方法,且这个两个参数都被@ Secure标记了,如public void test(@Secure String str1,@Secure String str1);
* *((@ cn.javass..Secure *) 或 * *(@ cn.javass..Secure *) 任何带有一个参数的方法,且该参数类型持有@ cn.javass..Secure;如public void test(Model model);且Model类上持有@Secure注解
* *(@cn.javass..Secure (@cn.javass..Secure *) ,@ cn.javass..Secure (@cn.javass..Secure *)) 任何带有两个参数的方法,且这两个参数都被@ cn.javass..Secure标记了;且这两个参数的类型上都持有@ cn.javass..Secure;
* *(java.util.Map, ..) 任何带有一个java.util.Map参数的方法,且该参数类型是以< cn.javass..Model, cn.javass..Model >为泛型参数;注意只匹配第一个参数为java.util.Map,不包括子类型;如public void test(HashMap map, String str);将不匹配,必须使用“* *(java.util.HashMap, ..)”进行匹配;而public void test(Map map, int i);也将不匹配,因为泛型参数不匹配
* *(java.util.Collection<@cn.javass..Secure *>) 任何带有一个参数(类型为java.util.Collection)的方法,且该参数类型是有一个泛型参数,该泛型参数类型上持有@cn.javass..Secure注解;如public void test(Collection< Model> collection);Model类型上持有@cn.javass..Secure
* *(java.util.Set< ? extends HashMap>) 任何带有一个参数的方法,且传入的参数类型是有一个泛型参数,该泛型参数类型继承与HashMap;Spring AOP目前测试不能正常工作
* *(java.util.List< ? super HashMap>) 任何带有一个参数的方法,且传入的参数类型是有一个泛型参数,该泛型参数类型是HashMap的基类型;如public voi test(Map map);Spring AOP目前测试不能正常工作
* *(*<@cn.javass..Secure *>) 任何带有一个参数的方法,且该参数类型是有一个泛型参数,该泛型参数类型上持有@cn.javass..Secure注解;Spring AOP目前测试不能正常工作

2. within:使用“within(类型表达式)”匹配指定类型内的方法执行;

模式 描述
within(cn.javass..*) cn.javass包及子包下的任何方法执行
within(cn.javass..IPointcutService+) cn.javass包或所有子包下IPointcutService类型及子类型的任何方法
within(@cn.javass..Secure *) 持有cn.javass..Secure注解的任何类型的任何方法,必须是在目标对象上声明这个注解,在接口上声明的对它不起作用

3. this:使用“this(类型全限定名)”匹配当前AOP代理对象类型的执行方法;注意是AOP代理对象的类型匹配,这样就可能包括引入接口方法也可以匹配;注意this中使用的表达式必须是类型全限定名,不支持通配符;

模式 描述
this(cn.javass.spring.chapter6.service.IPointcutService) 当前AOP对象实现了 IPointcutService接口的任何方法
this(cn.javass.spring.chapter6.service.IIntroductionService) 当前AOP对象实现了 IIntroductionService接口的任何方法,也可能是引入接口

4. target:使用“target(类型全限定名)”匹配当前目标对象类型的执行方法;注意是目标对象的类型匹配,这样就不包括引入接口也类型匹配;注意target中使用的表达式必须是类型全限定名,不支持通配符;

模式 描述
target(cn.javass.spring.chapter6.service.IPointcutService) 当前目标对象(非AOP对象)实现了 IPointcutService接口的任何方法
target(cn.javass.spring.chapter6.service.IIntroductionService) 当前目标对象(非AOP对象) 实现了IIntroductionService 接口的任何方法,不可能是引入接口

5. args:使用“args(参数类型列表)”匹配当前执行的方法传入的参数为指定类型的执行方法;注意是匹配传入的参数类型,不是匹配方法签名的参数类型;参数类型列表中的参数必须是类型全限定名,通配符不支持;args属于动态切入点,这种切入点开销非常大,非特殊情况最好不要使用;

模式 描述
args (java.io.Serializable,..) 任何一个以接受“传入参数类型为 java.io.Serializable” 开头,且其后可跟任意个任意类型的参数的方法执行,args指定的参数类型是在运行时动态匹配的

6. @within:使用“@within(注解类型)”匹配所以持有指定注解类型内的方法;注解类型也必须是全限定类型名;

模式 描述
@within cn.javass.spring.chapter6.Secure) 任何目标对象对应的类型持有Secure注解的类方法;必须是在目标对象上声明这个注解,在接口上声明的对它不起作用

7. @target:使用“@target(注解类型)”匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;注解类型也必须是全限定类型名;

模式 描述
@target (cn.javass.spring.chapter6.Secure) 任何目标对象持有Secure注解的类方法;必须是在目标对象上声明这个注解,在接口上声明的对它不起作用

8. @args:使用“@args(注解列表)”匹配当前执行的方法传入的参数持有指定注解的执行;注解类型也必须是全限定类型名;

模式 描述
@args (cn.javass.spring.chapter6.Secure) 任何一个只接受一个参数的方法,且方法运行时传入的参数持有注解 cn.javass.spring.chapter6.Secure;动态切入点,类似于arg指示符;

9. @annotation:使用“@annotation(注解类型)”匹配当前执行方法持有指定注解的方法;注解类型也必须是全限定类型名;

模式 描述
@annotation(cn.javass.spring.chapter6.Secure ) 当前执行方法上持有注解cn.javass.spring.chapter6.Secure将被匹配

10. bean:使用“bean(Bean id或名字通配符)”匹配特定名称的Bean对象的执行方法;Spring ASP扩展的,在AspectJ中无相应概念;

模式 描述
bean(*Service) 匹配所有以Service命名(id或name)结尾的Bean

11. reference pointcut:表示引用其他命名切入点,只有@ApectJ风格支持,Schema风格不支持,如下所示:

@Pointcut(value="bean(*Service)")
private void pointcut1(){}                                    //命名切入点1
@Pointcut(value="@args(cn.javass.spring.chapter6.Secure)")       //命名切入点2
private void pointcut2(){}

@Before(value = "pointcut1() && pointcut2()")                  //引用命名切入点
public void referencePointcutTest1(JoinPoint jp) {
    dump("pointcut1() && pointcut2()", jp);
}
@Aspect
public class ReferencePointcutAspect {
    @Pointcut(value="execution(* *())")
    public void pointcut() {}
}
@Before(value = "cn.javass.spring.chapter6.aop.ReferencePointcutAspect.pointcut()")
public void referencePointcutTest2(JoinPoint jp) {}

第六部分 通知参数

如果想获取被被通知方法参数并传递给通知方法,该如何实现呢?

  • 使用JoinPoint获取
    Spring AOP提供使用org.aspectj.lang.JoinPoint类型获取连接点数据,任何通知方法的第一个参数都可以是JoinPoint(环绕通知是ProceedingJoinPoint,JoinPoint子类),当然第一个参数位置也可以是JoinPoint.StaticPart类型,这个只返回连接点的静态部分。

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

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

【ProceedingJoinPoint】:用于环绕通知,使用proceed()方法来执行目标方法:

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

【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;如果匹配将把该被通知参数传递给通知方法上同名参数。
类似于构造器注入中的参数名注入限制:在class文件中没生成变量调试信息是获取不到方法参数名字的。
所以我们可以使用策略来确定参数名:

1.1. 如果我们通过“argNames”属性指定了参数名,那么就是要我们指定的;

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

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

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

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

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

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

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

1.5. 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) {
……
}

Spring学习笔记整理——AOP_第8张图片
除了上边介绍的普通方式,也可以对使用命名切入点自动获取参数:

@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) {
……
}

第七部分 通知顺序

  • 同一切面中通知执行顺序
    这里写图片描述

而如果在同一切面中定义两个相同类型通知(如同是前置通知或环绕通知(proceed之前))并在同一连接点执行时,其执行顺序是未知的,如果确实需要指定执行顺序需要将通知重构到两个切面,然后定义切面的执行顺序。

  • 不同切面中的通知执行顺序

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

如果需要他们顺序执行,可以通过指定切面的优先级来控制通知的执行顺序。
Spring中可以通过在切面实现类上实现org.springframework.core.Ordered接口或使用Order注解来指定切面优先级。在多个切面中,Ordered.getValue()方法返回值(或者注解值)较小值的那个切面拥有较高优先级。
Spring学习笔记整理——AOP_第9张图片


@Aspect
@Order(2)
public class OrderAspect2 {
}


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

第八部分 代理机制

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

  • JDK动态代理:使用java.lang.reflect.Proxy动态代理实现,即提取目标对象的接口,然后对接口创建AOP代理。
  • CGLIB代理:CGLIB代理不仅能进行接口代理,也能进行类代理,CGLIB代理需要注意以下问题:
    • 不能通知final方法,因为final方法不能被覆盖(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"/>

你可能感兴趣的:(spring)