Spring：入门AOP案例分析

Posted 2023-01-23

今日目标

• 理解并掌握AOP相关概念

1，AOP简介

前面我们在介绍Spring的时候说过，Spring有两个核心的概念，一个是​​IOC/DI​​​，一个是​​AOP​​。

前面已经对​​IOC/DI​​进行了系统的学习，接下来要学习它的另一个核心内容，就是AOP。

对于AOP,我们前面提过一句话是:AOP是在不改原有代码的前提下对其进行增强。

对于下面的内容，我们主要就是围绕着这一句话进行展开学习，主要学习两方面内容​​AOP核心概念​​​,​​AOP作用​​:

1.1 什么是AOP?

• AOP(Aspect Oriented Programming)面向切面编程，一种编程范式，指导开发者如何组织程序结构。

• OOP(Object Oriented Programming)面向对象编程

我们都知道OOP是一种编程思想，那么AOP也是一种编程思想，编程思想主要的内容就是指导程序员该如何编写程序，所以它们两个是不同的​​编程范式​​。

1.2 AOP作用

• 作用:在不惊动原始设计的基础上为其进行功能增强，前面咱们有技术就可以实现这样的功能即代理模式。

前面咱们有技术就可以实现这样的功能即​​代理模式​​。

1.3 AOP核心概念

为了能更好的理解AOP的相关概念，我们准备了一个环境，整个环境的内容我们暂时可以不用关注，最主要的类为:​​BookDaoImpl​​

@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​​方法中有计算万次执行消耗的时间。

当在App类中从容器中获取bookDao对象后，分别执行其​​save​​​,​​delete​​​,​​update​​​和​​select​​方法后会有如下的打印结果:

这个时候，我们就应该有些疑问?

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

这个案例中其实就使用了Spring的AOP，在不惊动(改动)原有设计(代码)的前提下，想给谁添加功能就给谁添加。这个也就是Spring的理念：

• 无入侵式/无侵入式

说了这么多，Spring到底是如何实现的呢?

(1)前面一直在强调，Spring的AOP是对一个类的方法在不进行任何修改的前提下实现增强。对于上面的案例中BookServiceImpl中有​​save​​​,​​update​​​,​​delete​​​和​​select​​方法,这些方法我们给起了一个名字叫连接点

(2)在BookServiceImpl的四个方法中，​​update​​​和​​delete​​​只有打印没有计算万次执行消耗时间，但是在运行的时候已经有该功能，那也就是说​​update​​​和​​delete​​方法都已经被增强，所以对于需要增强的方法我们给起了一个名字叫切入点

(3)执行BookServiceImpl的update和delete方法的时候都被添加了一个计算万次执行消耗时间的功能，将这个功能抽取到一个方法中，换句话说就是存放共性功能的方法，我们给起了个名字叫通知

(4)通知是要增强的内容，会有多个，切入点是需要被增强的方法，也会有多个，那哪个切入点需要添加哪个通知，就需要提前将它们之间的关系描述清楚，那么对于通知和切入点之间的关系描述，我们给起了个名字叫切面

(5)通知是一个方法，方法不能独立存在需要被写在一个类中，这个类我们也给起了个名字叫通知类

至此AOP中的核心概念就已经介绍完了，总结下:

• 连接点(JoinPoint)：程序执行过程中的任意位置，粒度为执行方法、抛出异常、设置变量等

• 在SpringAOP中，理解为方法的执行

• 切入点(Pointcut):匹配连接点的式子

• 在SpringAOP中，一个切入点可以描述一个具体方法，也可也匹配多个方法

• 一个具体的方法:如com.itheima.dao包下的BookDao接口中的无形参无返回值的save方法
• 匹配多个方法:所有的save方法，所有的get开头的方法，所有以Dao结尾的接口中的任意方法，所有带有一个参数的方法

• 连接点范围要比切入点范围大，是切入点的方法也一定是连接点，但是是连接点的方法就不一定要被增强，所以可能不是切入点。

• 通知(Advice):在切入点处执行的操作，也就是共性功能

• 在SpringAOP中，功能最终以方法的形式呈现

• 通知类：定义通知的类
• 切面(Aspect):描述通知与切入点的对应关系。

小结

这一节中主要讲解了AOP的概念与作用，以及AOP中的核心概念，学完以后大家需要能说出:

• 什么是AOP?
• AOP的作用是什么?
• AOP中核心概念分别指的是什么?

• 连接点
• 切入点
• 通知
• 通知类
• 切面

2，AOP入门案例

2.1 需求分析

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

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

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

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

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

2.2 思路分析

需求明确后，具体该如何实现，都有哪些步骤，我们先来分析下:

1.导入坐标(pom.xml)

2.制作连接点(原始操作，Dao接口与实现类)

3.制作共性功能(通知类与通知)

4.定义切入点

5.绑定切入点与通知关系(切面)

2.3 环境准备

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

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

• 添加BookDao和BookDaoImpl类

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 ...");
    

• 创建Spring的配置类

@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();
    

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-plL4ew8U-1654510725057)(assets/1630167092142.png)]

说明:

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

2.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编程成功。

知识点1：@EnableAspectJAutoProxy

名称	@EnableAspectJAutoProxy
类型	配置类注解
位置	配置类定义上方
作用	开启注解格式AOP功能

知识点2：@Aspect

名称	@Aspect
类型	类注解
位置	切面类定义上方
作用	设置当前类为AOP切面类

知识点3：@Pointcut

名称	@Pointcut
类型	方法注解
位置	切入点方法定义上方
作用	设置切入点方法
属性	value（默认）：切入点表达式

知识点4：@Before

名称	@Before
类型	方法注解
位置	通知方法定义上方
作用	设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前运行