Spring（八）：Spring之AOP全解析

目录

一、AOP简介

1、AOP简介和作用

2、核心概念

二、AOP案例

1、案例思路分析

2、案例（注解版）制作步骤 

三、AOP工作流程

1、工作流程

2、概念

四、AOP切入点表达式

1、语法格式

2、通配符

3、书写技巧

五、AOP通知类型

1、AOP五种通知类型

2、AOP通知获取数据 

---

一、AOP简介

1、AOP简介和作用

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

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

 作用：在不惊动原始设计的基础上为其进行功能增强

Spring理念：无入侵式/无侵入式

2、核心概念

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

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

2、切入点（Pointcut）：匹配连接点的式子

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

                一个具体方法：com.itheima.dao包下的BookDao接口中的无形参无返回值的save方法

                匹配多个方法：所有的save方法，所有的get开头的方法，所有以Dao结尾的接口中的任                 意方法，所有带有一个参数的方法

3、通知（Advice）：在切入点处执行的操作，也就是共性功能

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

5、通知类：定义通知的类

6、切面（Aspect）：描述通知与切入点的对应关系

        我们原始的save、update、delete、select方法称作连接点，需要追加功能的方法叫做切入点。蓝色是三个方法需要都用的功能，那就提取出来叫做通知，这种通知可以开发很多个。那怎么知道哪个通知需要加载，所以通知和切入点还得有个东西，那这个就是切面。

二、AOP案例

1、案例思路分析

案例设定：测定接口执行效率

简化设定：在接口执行前输出当前系统时间

开发模式：XML or  注解

思路分析：

1. 导入坐标（pom.xml）

2. 制作连接点方法（原始操作，dao接口与实现类）

3. 制作共性功能（通知类和通知）

4. 定义切入点

5. 绑定切入点与通知关系（切面）

2、案例（注解版）制作步骤 

1、导入aop相关坐标

<dependencies>
    <!--spring核心依赖，会将spring-aop传递进来-->
    <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>

2、定义dao接口与实现类 

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

3、定义通知类，制作通知方法

//通知类必须配置成Spring管理的bean
@Component
public class MyAdvice {
    public void method(){
        System.out.println(System.currentTimeMillis());
    }
}

4、定义切入点表达式、配置切面(绑定切入点与通知关系)

//通知类必须配置成Spring管理的bean
@Component
//设置当前类为切面类类
@Aspect
public class MyAdvice {
    //设置切入点，@Pointcut注解要求配置在方法上方
    @Pointcut("execution(void com.csdn.dao.BookDao.update())")
    private void pt(){}

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

5、在配置类中进行Spring注解包扫描和开启AOP功能

@Configuration
@ComponentScan("com.csdn")
//开启注解开发AOP功能
@EnableAspectJAutoProxy
public class SpringConfig {
}

 测试类和运行结果

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

三、AOP工作流程

1、工作流程

1. Spring容器启动
2. 读取所有切面配置中的切入点（只读取配置的）

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

    @Pointcut("execution(void com.itheima.dao.BookDao.update())")
    private void pt(){}

    @Before("pt()")
    public void method(){
        System.out.println(System.currentTimeMillis());
    }
}

3. 初始化bean，判定bean对应的类中的方法是否匹配到任意切入点
   - 匹配失败，创建原始对象
   - 匹配成功，创建原始对象（目标对象）的代理对象
4. 获取bean执行方法
   - 获取的bean是原始对象时，调用方法并执行，完成操作
   - 获取的bean是代理对象时，根据代理对象的运行模式运行原始方法与增强的内容，完成操作

2、概念

目标对象（Target）：被代理的对象，也叫原始对象，该对象中的方法没有任何功能增强。

代理对象（Proxy）：代理后生成的对象，由Spring帮我们创建代理对象。

四、AOP切入点表达式

1、语法格式

1、切入点：要进行增强的方法

2、切入点表达式：要进行增强的方法的描述方式

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

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

        描述方式二：执行com.icsdn.dao.impl包下的BookDaoImpl类中的无参数update方法

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

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

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

• 动作关键字：描述切入点的行为动作，例如execution表示执行到指定切入点

• 访问修饰符：public，private等，可以省略

• 返回值：写返回值类型

• 包名：多级包使用点连接

• 类/接口名

• 方法名

• 参数：直接写参数的类型，多个类型用逗号隔开

• 异常名：方法定义中抛出指定异常，可以省略  

2、通配符

目的：可以使用通配符描述切入点，快速描述。

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

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

execution（public * com.csdn.*.UserService.find*（*））

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

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

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

3、+：专用于匹配子类类型

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

3、书写技巧

1、所有代码按照标准规范开发，否则以下技巧全部失效

2、描述切入点通常描述接口，而不描述实现类

3、访问控制修饰符针对接口开发均采用public描述（可省略访问控制修饰符描述）

4、返回值类型对于增删改类使用精准类型加速匹配，对于查询类使用*通配快速描述

5、包名书写尽量不使用..匹配，效率过低，常用*做单个包描述匹配，或精准匹配

6、接口名/类名书写名称与模块相关的采用*匹配，例如UserService书写成*Service，绑定业务层接口名

7、方法名书写以动词进行精准匹配，名词采用*匹配，例如getById书写成getBy*,selectAll书写成selectAll

8、参数规则较为复杂，根据业务方法灵活调整

9、通常不使用异常作为匹配规则

五、AOP通知类型

1、AOP五种通知类型

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

2、AOP通知共分为5种类型

（1）前置通知

名称：@Before

类型：==方法注解==

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前运行

范例：

@Before("pt()")
public void before() {
    System.out.println("before advice ...");
}

（2）后置通知

名称：@After

类型：==方法注解==

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法后运行

范例：

@After("pt()")
public void after() {
    System.out.println("after advice ...");
}

（3）环绕通知

名称：@Around（重点，常用）

类型：**==方法注解==**

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法前后运行

范例：

@Around("pt()")
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;
}

 @Around注意事项

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

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

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

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

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

（4）返回后通知

名称：@AfterReturning（了解）

类型：**==方法注解==**

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法正常执行完毕后运行

范例：

@AfterReturning("pt()")
public void afterReturning() {
    System.out.println("afterReturning advice ...");
}

（5）抛出异常后通知

名称：@AfterThrowing（了解）

类型：**==方法注解==**

位置：通知方法定义上方

作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法运行抛出异常后执行

范例：

@AfterThrowing("pt()")
public void afterThrowing() {
    System.out.println("afterThrowing advice ...");
}

2、AOP通知获取数据 

说明：在前置通知和环绕通知中都可以获取到连接点方法的参数们

1、获取参数

（1）JoinPoint对象描述了连接点方法的运行状态，可以获取到原始方法的调用参数

@Before("pt()")
public void before(JoinPoint jp) {
    Object[] args = jp.getArgs(); //获取连接点方法的参数们
    System.out.println(Arrays.toString(args));
}

 （2）ProccedJointPoint是JoinPoint的子类

@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable {
    Object[] args = pjp.getArgs(); //获取连接点方法的参数们
    System.out.println(Arrays.toString(args));
    Object ret = pjp.proceed();
    return ret;
}

2、获取返回值

说明：在返回后通知和环绕通知中都可以获取到连接点方法的返回值

（1）抛出异常后通知可以获取切入点方法中出现的异常信息，使用形参可以接收对应的异常对象

@AfterReturning(value = "pt()",returning = "ret")
public void afterReturning(String ret) { //变量名要和returning="ret"的属性值一致
    System.out.println("afterReturning advice ..."+ret);
}

（2）环绕通知中可以手工书写对原始方法的调用，得到的结果即为原始方法的返回值

@Around("pt()")
public Object around(ProceedingJoinPoint pjp) throws Throwable {
    // 手动调用连接点方法，返回值就是连接点方法的返回值
    Object ret = pjp.proceed();
    return ret;
}

3、获取异常

说明：在抛出异常后通知和环绕通知中都可以获取到连接点方法中出现的异常

（1）抛出异常后通知可以获取切入点方法中出现的异常信息，使用形参可以接收对应的异常对象

@AfterThrowing(value = "pt()",throwing = "t")
public void afterThrowing(Throwable t) {//变量名要和throwing = "t"的属性值一致
    System.out.println("afterThrowing advice ..."+ t);
}

 （2）抛出异常后通知可以获取切入点方法运行的异常信息，使用形参可以接收运行时抛出的异常对象

@Around("pt()")
public Object around(ProceedingJoinPoint pjp)  {
    Object ret = null;
    //此处需要try...catch处理，catch中捕获到的异常就是连接点方法中抛出的异常
    try {
        ret = pjp.proceed();
    } catch (Throwable t) {
        t.printStackTrace();
    }
    return ret;
}