Spring AOP 笔记一(基础概念,一个简单切面)

此文是Sping in Action 第4版 英文原版切面部分的读书笔记,仅限交流使用,有不足之处,一定听取修改。

系列目录:
Spring AOP 笔记一(基础概念,一个简单切面)
Spring AOP 笔记二(环绕通知,切面中获取参数)
Spring AOP 笔记三(切面注解引入新的方法)

1. 理解

  • 面向切面编程的基本思想是在极少影响原程序的代码的前提下,在程序中的某些地方,使用某些方式,不可见的(即不在原程序中添加其他代码)为原程序切入一些额外的功能。

优点

  • 减少代码间的耦合性,使功能具有拔插性,保证自己代码的清洁型。
  • 能够让你只关注自己的代码,不需要关注切面是如何实现的。

2. 名词解释

这里使用电力公司下的去各家各户查电表的工人为例。

通知(advice):

  • 查电表的工人,在工作前心里明白,或者说必须接到公司老板下达的任务,即包括什么时候去查电表,以及去住户人家怎样查电表。和此相似,通知定义了切面做什么和什么时候去做(确切的说是程序员在通知中定义的)。除了定义切面要完成的工作(what job),还会定位什么时候(when)去履行这项工作。是在方法调用前,还是调用之后,还是前后都是,还是抛出异常时。
切面一共有五种通知
  1. Before 某方法调用之前发出通知。
  2. After 某方法完成之后发出通知,不考虑方法运行的结果。
  3. After-returning 将通知放置在被通知的方法成功执行之后。
  4. After-throwing 将通知放置在被通知的方法抛出异常之后。
  5. Around 通知包裹在被通知的方法的周围,在方法调用之前和之后发出通知。

连接/参加点(Join Point):

  • 就像每一个电力公司下有很多使用他提供的电的房子,每一个房子都可以,都有机会被查电表。同样,在你的应用程序中会有好多的地方可以,或者有机会被通知申请完成通知自己的工作。这些机会(某个点)就被称为连接点。连接点是切面在应用程序执行过程中插入的地方,可能是方法调用的时候,异常抛出的时候。

切点(pointcuts):

  • 很明显一位查电表的人不能把所有的用电客户都拜访个遍,而是每一个人都会有自己管辖的客户。同样,一个切面没必要通知(advise)应用程序中所有的连接点(join point)。切点(pointcuts)能够精确定位被切面通知的连接点。

  • 如果通知(advice)定义了切面what和when,那切点就定义的切面的 where。切点决定去匹配通知们应该去编织的一个或者多个连接点。通常需要使用类或者方法的名字来指定切点,或者通过正则表达式去匹配类和方法的名字

切面(aspects):

  • 当查电表的开始了他的一天(when),他知道他需要去做些什么(what),(通知),以及那些房子需要他访问(where)(切点)。事实上他知道他工作上要做的每一件事。
  • 很明显,切面即是通知和切点的结合体。放在一块,通知和切点定义了切面需要知道的每一件事。要做什么,以及在哪里什么时候去做。

引入(introductions):

  • 引入允许你添加一个新的方法给已经存在的类。

3. Spring AOP的支持

  • Spring建议在Java中书写AOP
  • Spring是在运行阶段才将切面编织进bean中,是使用代理类。
  • Spring只支持方法级别的连接点。

4. Spring使用AspectJ的切点表达式去定义Spring切面

AspectJ标志符 解释
args() 定制join-point去匹配那些参数为指定类型的方法的执行动作。
@args() 定制join-point去匹配那些参数被指定类型注解的方法的执行动作
execution() 开始匹配在其内部编写的定制
this() 定制join-pont去匹配由AOP代理的Bean引用的指定类型的类。
target() 定制join-point去匹配特定的对象,这些对象一定是指定类型的类。
@target() 定制join-point去匹配特定的对象,这些对象要具有的指定类型的注解。
within() 定制join-point在必须哪一个包中。
@within() 定制join-point在必须由指定注解标注的类中。
@annotation 定制连接点具有指定的注解。
  • 只有execution用来执行匹配,其他标志符都只是为了限制/定制他们所要匹配的连接点的位置。

4.1 编写切点,一个简答的示例

开始写代码之前需要做一些准备。
如果你使用的是Maven工具构建的项目,除了基本的Spring依赖,还需要导入下面两个支持Spring切面的依赖。

<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>    
    <groupId>org.aspectj</groupId>            
    <artifactId>aspectjweaver</artifactId>    
    <version>1.8.9</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjrt -->
<dependency>   
      <groupId>org.aspectj</groupId> 
      <artifactId>aspectjrt</artifactId>    
     <version>1.8.9</version>
</dependency>

Gradle 相似。注意这里的groupId要为org.aspectj,而不是aspectj,否则运行时会抛出异常。

  • 首先定义一个接口
public interface Performance {
    public void perform();
}

Performance代表一个表演者,比如舞台上的表演者,电影里的演员等等。
现在你想写一个当Performance的perform()方法执行时触发的切面。下面这个表达式就展示了一个切点表达式,只要perform()方法执行了,他就能得到切面的通知。

execution(* concert.Performance.perform(..))

这里解释一下:

  • execution意思是当某方法执行时触发。
  • 第一个 * 意思配备任何一个perform方法,是不在乎方法返回类型是什么。
  • concert.Performance是为了定位perform()方法再哪个类中。
  • .. 代表配备任何一个perform方法,不在意他的参数列表是啥。

如果你想限定切点的范围,只匹配在concert包被调用的perform()。你可以使用within()标识符:

execution(* concert.Performance.perform(..))
    && within(concert.*))

注意这里的 && 就是与的意思,当然还有 或 || ,非 ! ,如果你是在XML配置文件中编写切面,那就建议使用 and or not 来替代他们。

4.2 在切点中选取bean

在表达式中,可以使用bean()标识符,通过bean的ID来识别一个bean。例如:

execution(* concert.Performance.perform())
and bean('woodstock')

4.3 创建注解切面

AspectJ 5 之后你就能使用注解的方式来创建切面,他能够让你使用很少的注解就能实现切面。
现在你已经定义了一个Performance作为你切面要切入的主体。现在我们就使用AspectJ 注解来创建切面。

4.3.1 定义一个切面。

没有观众的表演家就不能叫表演家,观众对于表演家非常重要,但又不属于表演家,他是一个分离出来的点,因此,我们就能将观众定义成一个切面,好让他能够轻松的观看一个表演家的表演。

package com.mengxiang.concert;

import org.aspectj.lang.annotation.*;

/**
 * 观众
 * Created by Henvealf on 2016/8/26.
 */
@Aspect
public class Audience {
    @Before("execution(* com.mengxiang.concert.Performance.perform(..))")
    public void slienceCellPhones(){
        System.out.println("关掉手机");
    }

    @Before("execution(* com.mengxiang.concert.Performance.perform(..))")
    public void takeSeats() {
        System.out.println("找到座位");
    }

    @AfterReturning("execution(* com.mengxiang.concert.Performance.perform(..))")
    public void applause() {
        System.out.println("好好好!!鼓掌");
    }

    @AfterThrowing("execution(* com.mengxiang.concert.Performance.perform())")
    public  void demandRefund() {
        System.out.println("退票! 退票! ");
    }
}

然后编写一个配置文件,注入观众Bean和演员Bean。

@Configuration
@EnableAspectJAutoProxy
@ComponentScan
public class ConcertConfig {
    @Bean
    public Audience audience() {
        return new Audience();
    }
    @Bean(name = "dancer")
    public Performance dancer(){
        return new Dancer();
    }
}

最后测试

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

/**
 * Created by Henvealf on 2016/8/27.
 */
public class Main {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext("com.mengxiang.concert");
        Performance per = (Performance) context.getBean("dancer");
        per.perform();

    }
}

测试结果完全可以预料到:

关掉手机
找到座位
表演开始,跳舞,跳舞。
好好好!!鼓掌

哈哈,感谢大家的阅读。

推荐阅读更多精彩内容