【Spring篇】AOP

@Repository
public class BookDaoImpl implements BookDao {
public void save() {
//记录程序当前执行执行（开始时间）
Long startTime = System.currentTimeMillis();
 //业务执行万次
 for (int i = 0;i<10000;i++) {
 System.out.println("book dao save ...");
 }
 //记录程序当前执行时间（结束时间）
 Long endTime = System.currentTimeMillis();
 //计算时间差
 Long totalTime = endTime-startTime;
 //输出信息
 System.out.println("执行万次消耗时间：" + totalTime + "ms");
 }
 public void update(){
 System.out.println("book dao update ...");
 }
 public void delete(){
 System.out.println("book dao delete ...");
 }
 public void select(){
 System.out.println("book dao select ...");
 }
 }

• 对于计算万次执行消耗的时间只有save方法有，为什么delete和update方法也会有呢?
• delete和update方法有，那什么select方法为什么又没有呢?

• 无入侵式/无侵入式

1.需求分析

案例设定：测算接口执行效率，但是这个案例稍微复杂了点，我们对其进行简化。

简化设定：在方法执行前输出当前系统时间。

对于 SpringAOP 的开发有两种方式， XML 和 注解 ，我们使用哪个呢 ?

因为现在注解使用的比较多，所以本次课程就采用注解完成 AOP 的开发。

总结需求为 : 使用 SpringAOP 的注解方式完成在方法执行的前打印出当前系统时间。

public interface BookDao {
    public void save();
    public void update();
}

@Repository
public class BookDaoImpl implements BookDao {

    public void save() {
        System.out.println(System.currentTimeMillis());
        System.out.println("book dao save ...");
    }

    public void update(){
        System.out.println("book dao update ...");
    }
}

@Configuration
@ComponentScan("com.itheima")

public class SpringConfig {
}

编写 App 运行类

public class App {
    public static void main(String[] args) {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
        BookDao bookDao = ctx.getBean(BookDao.class);
        bookDao.save();

    }
}

最终创建好的项目结构如下 :

说明 :

• 目前打印save方法的时候，因为方法中有打印系统时间，所以运行的时候是可以看到系统时间
• 对于update方法来说，就没有该功能
• 我们要使用SpringAOP的方式在不改变update方法的前提下让其具有打印系统时间的功能。

4.AOP实现步骤

步骤 1: 添加依赖

pom.xml

<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.4</version>
</dependency>

因为 spring - context 中已经导入了 spring - aop , 所以不需要再单独导入 spring - aop

导入 AspectJ 的 jar 包 ,AspectJ 是 AOP 思想的一个具体实现， Spring 有自己的 AOP 实现，但是相比于AspectJ 来说比较麻烦，所以我们直接采用 Spring 整合 ApsectJ 的方式进行 AOP 开发。

步骤 2: 定义接口与实现类

环境准备的时候， BookDaoImpl 已经准备好，不需要做任何修改

步骤 3: 定义通知类和通知

通知就是将共性功能抽取出来后形成的方法，共性功能指的就是当前系统时间的打印。

public class MyAdvice {
public void method(){
System.out.println(System.currentTimeMillis());
}
}

类名和方法名没有要求，可以任意。

步骤 4: 定义切入点

BookDaoImpl 中有两个方法，分别是 save 和 update ，我们要增强的是 update 方法，该如何定义呢 ?

public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
public void method(){
System.out.println(System.currentTimeMillis());
}
}

说明 :

• 切入点定义依托一个不具有实际意义的方法进行，即无参数、无返回值、方法体无实际逻辑。
• execution及后面编写的内容，后面会有章节专门去学习。

步骤 5: 制作切面

切面是用来描述通知和切入点之间的关系，如何进行关系的绑定 ?

public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Before("pt()")
public void method(){
System.out.println(System.currentTimeMillis());
}
}

绑定切入点与通知关系，并指定通知添加到原始连接点的具体执行 位置

说明 : @Before 翻译过来是之前，也就是说通知会在切入点方法执行之前执行，除此之前还有其他四种类型，后面会讲。

步骤 6: 将通知类配给容器并标识其为切面类

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Before("pt()")
public void method(){
System.out.println(System.currentTimeMillis());
}
}

步骤 7: 开启注解格式 AOP 功能

@Configuration
@ComponentScan("com.itheima")
@EnableAspectJAutoProxy
public class SpringConfig {
}

步骤 8: 运行程序

public class App {
public static void main(String[] args) {
ApplicationContext ctx = new
AnnotationConfigApplicationContext(SpringConfig.class);
BookDao bookDao = ctx.getBean(BookDao.class);
bookDao.update();
}
}

看到在执行 update 方法之前打印了系统时间戳，说明对原始方法进行了增强， AOP 编程成功。

 

三、AOP工作流程 

AOP 的入门案例已经完成，对于刚才案例的执行过程，我们就得来分析分析，这一节我们主要讲解两个知识点: AOP 工作流程 和 AOP 核心概念 。其中核心概念是对前面核心概念的补充。

1.AOP工作流程

由于AOP是基于Spring容器管理的bean做的增强，所以整个工作过程需要从Spring加载bean说起:

流程 1:Spring 容器启动

• 容器启动就需要去加载bean,哪些类需要被加载呢?
• 需要被增强的类，如:BookServiceImpl
• 通知类，如:MyAdvice
• 注意此时bean对象还没有创建成功

流程 2: 读取所有切面配置中的切入点

 上面这个例子中有两个切入点的配置，但是第一个ptx()并没有被使用，所以不会被读取。

流程 3: 初始化 bean ，

判定 bean 对应的类中的方法是否匹配到任意切入点

• 注意第1步在容器启动的时候，bean对象还没有被创建成功。
• 要被实例化bean对象的类中的方法和切入点进行匹配

匹配失败，创建原始对象 , 如 UserDao

• 匹配失败说明不需要增强，直接调用原始对象的方法即可。

匹配成功，创建原始对象（ 目标对象 ）的 代理 对象 , 如 : BookDao

• 匹配成功说明需要对其进行增强
• 对哪个类做增强，这个类对应的对象就叫做目标对象
• 因为要对目标对象进行功能增强，而采用的技术是动态代理，所以会为其创建一个代理对象
• 最终运行的是代理对象的方法，在该方法中会对原始方法进行功能增强

流程 4: 获取 bean 执行方法

获取的 bean 是原始对象时，调用方法并执行，完成操作

获取的 bean 是代理对象时，根据代理对象的运行模式运行原始方法与增强的内容，完成操作

验证容器中是否为代理对象

为了验证 IOC 容器中创建的对象和我们刚才所说的结论是否一致，首先先把结论理出来 :

如果目标对象中的方法会被增强，那么容器中将存入的是目标对象的代理对象

如果目标对象中的方法不被增强，那么容器中将存入的是目标对象本身。

验证思路

1. 要执行的方法，不被定义的切入点包含，即不要增强，打印当前类的 getClass() 方法

2. 要执行的方法，被定义的切入点包含，即要增强，打印出当前类的 getClass() 方法

3. 观察两次打印的结果

步骤 1: 修改 App 类 , 获取类的类型

public class App {
    public static void main(String[] args) {
        ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
        BookDao bookDao = ctx.getBean(BookDao.class);
//        bookDao.update();
        System.out.println(bookDao);
        System.out.println(bookDao.getClass());
    }
}

步骤 2: 修改 MyAdvice 类，不增强

因为定义的切入点中，被修改成 update1 , 所以 BookDao 中的 update 方法在执行的时候，就不会被增强， 所以容器中的对象应该是目标对象本身。

@Component
//设置当前类为切面类类
@Aspect
public class MyAdvice {
    //设置切入点，要求配置在方法上方
    @Pointcut("execution(void com.itheima.dao.BookDao.update1())")
    private void pt(){}

    //设置在切入点pt()的前面运行当前操作（前置通知）
     @Before("pt()")
    public void method(){
        System.out.println(System.currentTimeMillis());
    }
}

步骤3:运行程序 

2.AOP核心概念

• 目标对象(Target)：原始功能去掉共性功能对应的类产生的对象，这种对象是无法直接完成最终工作的
• 代理(Proxy)：目标对象无法直接完成工作，需要对其进行功能回填，通过原始对象的代理对象实现

四、AOP配置管理

1.AOP切入点表达式

前面的案例中，有涉及到如下内容:

 对于AOP中切入点表达式，我们总共会学习三个内容，分别是语法格式、通配符和书写技巧。

1，语法格式

• 切入点:要进行增强的方法
• 切入点表达式:要进行增强的方法的描述方式

 描述方式一：执行com.itheima.dao包下的BookDao接口中的无参数update方法

 execution(void com.itheima.dao.BookDao.update())

 execution(void com.itheima.dao.impl.BookDaoImpl.update())

因为调用接口方法的时候最终运行的还是其实现类的方法，所以上面两种描述方式都是可以的。

对于切入点表达式的语法为 :

• 切入点表达式标准格式：动作关键字(访问修饰符 返回值 包名.类/接口名.方法名(参数) 异常 名）

对于这个格式，我们不需要硬记，通过一个例子，理解它 :

execution(public User com.itheima.service.UserService.findById(int))

• execution：动作关键字，描述切入点的行为动作，例如execution表示执行到指定切入点
• public:访问修饰符,还可以是public，private等，可以省略
• User：返回值，写返回值类型
• com.itheima.service：包名，多级包使用点连接
• UserService:类/接口名称
• findById：方法名
• int:参数，直接写参数的类型，多个类型用逗号隔开
• 异常名：方法定义中抛出指定异常，可以省略

切入点表达式就是要找到需要增强的方法，所以它就是对一个具体方法的描述，但是方法的定义会有很多，所以如果每一个方法对应一个切入点表达式，想想这块就会觉得将来编写起来会比较麻烦，有没有更简单的方式呢?

就需要用到下面所学习的通配符。

2.通配符

我们使用通配符描述切入点，主要的目的就是简化之前的配置，具体都有哪些通配符可以使用?

* : 单个独立的任意符号，可以独立出现，也可以作为前缀或者后缀的匹配符出现

execution（public * com.itheima.*.UserService.find*(*))

匹配 com.itheima 包下的任意包中的 UserService 类或接口中所有 find 开头的带有一个参数的

方法

.. ：多个连续的任意符号，可以独立出现，常用于简化包名与参数的书写

execution（public User com..UserService.findById(..))

匹配 com 包下的任意包中的 UserService 类或接口中所有名称为 findById 的方法

+ ：专用于匹配子类类型

execution(* *..*Service+.*(..))

这个使用率较低，描述子类的，咱们做 JavaEE 开发，继承机会就一次，使用都很慎重，所以很少

用它。 *Service+ ，表示所有以 Service结尾的接口的子类。        

接下来，我们把案例中使用到的切入点表达式来分析下 :

execution(void com.itheima.dao.BookDao.update())
匹配接口，能匹配到
execution(void com.itheima.dao.impl.BookDaoImpl.update())
匹配实现类，能匹配到
execution(* com.itheima.dao.impl.BookDaoImpl.update())
返回值任意，能匹配到
execution(* com.itheima.dao.impl.BookDaoImpl.update(*))
返回值任意，但是update方法必须要有一个参数，无法匹配，要想匹配需要在update接口和实现类添加
参数
execution(void com.*.*.*.*.update())
返回值为void,com包下的任意包三层包下的任意类的update方法，匹配到的是实现类，能匹配
execution(void com.*.*.*.update())
返回值为void,com包下的任意两层包下的任意类的update方法，匹配到的是接口，能匹配
execution(void *..update())
返回值为void，方法名是update的任意包下的任意类，能匹配
execution(* *..*(..))
匹配项目中任意类的任意方法，能匹配，但是不建议使用这种方式，影响范围广
execution(* *..u*(..))
匹配项目中任意包任意类下只要以u开头的方法，update方法能满足，能匹配
execution(* *..*e(..))
匹配项目中任意包任意类下只要以e结尾的方法，update和save方法能满足，能匹配
execution(void com..*())
返回值为void，com包下的任意包任意类任意方法，能匹配，*代表的是方法
execution(* com.itheima.*.*Service.find*(..))
将项目中所有业务层方法的以find开头的方法匹配
execution(* com.itheima.*.*Service.save*(..))
将项目中所有业务层方法的以save开头的方法匹配

                                                                        

后面两种更符合我们平常切入点表达式的编写规则

3.书写技巧

对于切入点表达式的编写其实是很灵活的，那么在编写的时候，有没有什么好的技巧让我们用用:

• 所有代码按照标准规范开发，否则以下技巧全部失效
• 描述切入点通常描述接口，而不描述实现类,如果描述到实现类，就出现紧耦合了
• 访问控制修饰符针对接口开发均采用public描述（可省略访问控制修饰符描述）
• 返回值类型对于增删改类使用精准类型加速匹配，对于查询类使用*通配快速描述
• 包名书写尽量不使用..匹配，效率过低，常用*做单个包描述匹配，或精准匹配
• 接口名/类名书写名称与模块相关的采用*匹配，例如UserService书写成*Service，绑定业务层接口名
• 方法名书写以动词进行精准匹配，名词采用匹配，例如getById书写成getBy,selectAll书写成 selectAll
• 参数规则较为复杂，根据业务方法灵活调整
• 通常不使用异常作为匹配规则

 2.AOP通知类型

前面的案例中，有涉及到如下内容:

 @Before("pt()")

它所代表的含义是将 通知 添加到 切入点 方法执行的 前面 。

除了这个注解外，还有没有其他的注解，换个问题就是除了可以在前面加，能不能在其他的地方加 ?

1.类型介绍

我们先来回顾下AOP通知:

AOP 通知描述了抽取的共性功能，根据共性功能抽取的位置不同，最终运行代码时要将其加入到合 理的位置

通知具体要添加到切入点的哪里 ?

共提供了 5 种通知类型 :

• 前置通知
• 后置通知
• 环绕通知(重点)
• 返回后通知(了解)
• 抛出异常后通知(了解)

为了更好的理解这几种通知类型，我们来看一张图

(1) 前置通知，追加功能到方法执行前 , 类似于在代码 1 或者代码 2 添加内容

(2) 后置通知 , 追加功能到方法执行后 , 不管方法执行的过程中有没有抛出异常都会执行，类似于在代

码 5 添加内容

(3) 返回后通知 , 追加功能到方法执行后，只有方法正常执行结束后才进行 , 类似于在代码 3 添加内容，如果方法执行抛出异常，返回后通知将不会被添加

(4) 抛出异常后通知 , 追加功能到方法抛出异常后，只有方法执行出异常才进行 , 类似于在代码 4 添加内容，只有方法抛出异常后才会被添加

(5) 环绕通知 , 环绕通知功能比较强大，它可以追加功能到方法执行的前后，这也是比较常用的方式，它可以实现其他四种通知类型的功能，具体是如何实现的，需要我们往下学习。

2.环境准备

• 创建一个Maven项目
• pom.xml添加Spring依赖

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>5.2.10.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.aspectj</groupId>
      <artifactId>aspectjweaver</artifactId>
      <version>1.9.4</version>
    </dependency>
  </dependencies>

添加BookDao和BookDaoImpl类 

public interface BookDao {
    public void update();

    public int select();
}

@Repository
public class BookDaoImpl implements BookDao {

    public void update(){
        System.out.println("book dao update is running ...");
    }

    public int select() {
        System.out.println("book dao select is running ...");

        return 100;
    }
}

创建 Spring 的配置类

@Configuration
@ComponentScan("com.itheima")
@EnableAspectJAutoProxy
public class SpringConfig {
}

创建通知类

@Component
 @Aspect
 public class MyAdvice {
 @Pointcut("execution(void com.itheima.dao.BookDao.update())")
 private void pt(){}

 public void before() {
 System.out.println("before advice ...");
}
 public void after() {
 System.out.println("after advice ...");
}
 public void around(){
 System.out.println("around before advice ...");
 System.out.println("around after advice ...");
}
 public void afterReturning() {
 System.out.println("afterReturning advice ...");
}
 public void afterThrowing() {
 System.out.println("afterThrowing advice ...");
}
}

编写 App 运行类

public class App {
public static void main(String[] args) {
ApplicationContext ctx = new
AnnotationConfigApplicationContext(SpringConfig.class);
BookDao bookDao = ctx.getBean(BookDao.class);
bookDao.update();
}
}

最终创建好的项目结构如下 :

3.通知类型的使用

前置通知

修改 MyAdvice, 在 before 方法上添加 @Before 注解

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Before("pt()")
//此处也可以写成 @Before("MyAdvice.pt()"),不建议
public void before() {
System.out.println("before advice ...");
}
}

 后置通知

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Before("pt()")
public void before() {
System.out.println("before advice ...");
}
@After("pt()")
public void after() {
System.out.println("after advice ...");
}
}

环绕通知

基本使用

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Around("pt()")
public void around(){
System.out.println("around before advice ...");
System.out.println("around after advice ...");
}
}

 运行结果中，通知的内容打印出来，但是原始方法的内容却没有被执行。

因为环绕通知需要在原始方法的前后进行增强，所以环绕通知就必须要能对原始操作进行调用，具体如何实现?

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Around("pt()")
public void around(ProceedingJoinPoint pjp) throws Throwable{
System.out.println("around before advice ...");
//表示对原始操作的调用
pjp.proceed();
System.out.println("around after advice ...");
}
}

说明 : proceed() 为什么要抛出异常 ?

再次运行，程序可以看到原始方法已经被执行了

注意事项

(1) 原始方法有返回值的处理

修改 MyAdvice, 对 BookDao 中的 select 方法添加环绕通知，

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Pointcut("execution(int com.itheima.dao.BookDao.select())")
private void pt2(){}
@Around("pt2()")
public void aroundSelect(ProceedingJoinPoint pjp) throws Throwable {
System.out.println("around before advice ...");
//表示对原始操作的调用
pjp.proceed();
System.out.println("around after advice ...");
}
}

修改 App 类，调用 select 方法

public class App {
 public static void main(String[] args) {
 ApplicationContext ctx = new
AnnotationConfigApplicationContext(SpringConfig.class);
 BookDao bookDao = ctx.getBean(BookDao.class);
 int num = bookDao.select();
 System.out.println(num);
 }
 }

运行后会报错，错误内容为:

Exception in thread "main" org.springframework.aop.AopInvocationException:

Null return value from advice does not match primitive return type for:

public abstract int com.itheima.dao.BookDao.select() at

org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopP

roxy.java:226) at com.sun.proxy.$Proxy19.select(Unknown Source) at

com.itheima.App.main(App.java:12)

错误大概的意思是 : 空的返回不匹配原始方法的 int 返回

• void就是返回Null
• 原始方法就是BookDao下的select方法

所以如果我们使用环绕通知的话，要根据原始方法的返回值来设置环绕通知的返回值，具体解决方案为

public Object around(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("around before advice ...");
        //表示对原始操作的调用
        Object ret = pjp.proceed();

        System.out.println("around after advice ...");
        return ret;
    }

说明 :

为什么返回的是 Object 而不是 int 的主要原因是 Object 类型更通用。

在环绕通知中是可以对原始方法返回值就行修改的。

返回后通知

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Pointcut("execution(int com.itheima.dao.BookDao.select())")
private void pt2(){}
@AfterReturning("pt2()")
public void afterReturning() {
System.out.println("afterReturning advice ...");
}
}

注意： 返回后通知是需要在原始方法 select 正常执行后才会被执行，如果 select() 方法执行的过程

中出现了异常，那么返回后通知是不会被执行。后置通知是不管原始方法有没有抛出异常都会被执

行。

异常后通知

@Component
@Aspect
public class MyAdvice {
@Pointcut("execution(void com.itheima.dao.BookDao.update())")
private void pt(){}
@Pointcut("execution(int com.itheima.dao.BookDao.select())")
private void pt2(){}
@AfterReturning("pt2()")
public void afterThrowing() {
System.out.println("afterThrowing advice ...");
}
}

 

注意： 异常后通知是需要原始方法抛出异常，可以在 select() 方法中添加一行代码 int i = 1/0 即

可。如果没有抛异常，异常后通知将不会被执行。

学习完这 5 种通知类型，我们来思考下环绕通知是如何实现其他通知类型的功能的 ?

因为环绕通知是可以控制原始方法执行的，所以我们把增强的代码写在调用原始方法的不同位置就可以实现不同的通知类型的功能，如:

环绕通知注意事项

1. 环绕通知必须依赖形参 ProceedingJoinPoint 才能实现对原始方法的调用，进而实现原始方法

调用前后同时添加通知

2. 通知中如果未使用 ProceedingJoinPoint 对原始方法进行调用将跳过原始方法的执行

3. 对原始方法的调用可以不接收返回值，通知方法设置成 void 即可，如果接收返回值，最好设定为

Object 类型

4. 原始方法的返回值如果是 void 类型，通知方法的返回值类型可以设置成 void, 也可以设置成

Object

5. 由于无法预知原始方法运行后是否会抛出异常，因此环绕通知方法必须要处理 Throwable 异常

笔记来自： 黑马程序员SSM框架教程