spring AOP总结

一、概念

　　AOP面向切面编程，一种编程范式

二、作用

　　在不改动原始设计（原代码不改动）的基础上为方法进行功能增强（即增加功能）

三、核心概念

　　1、代理（Proxy）：SpringAOP的核心本质是采用代理模式实现的

　　2、连接点（JoinPoint）：在SpringAOP中，理解为任意方法的执行

　　3、切入点（Pointcut）：匹配连接点的式子，也是具有共性功能的方法描述

　　4、通知（Advice）：若干个方法的共性功能，在切入点处执行，最终体现为一个方法

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

　　6、目标对象（Target）：被代理的原始对象成为目标对象

四、快速开始

　　1、导入相关依赖

　　由于导入spring-context时会自动导入spring的AOP包所以，这里只用导入aspectjweaver即可。

　　在pom.xml文件中导入

    <dependencies>
 　　<!--spring核心依赖，会将spring-aop传递进来-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.3.29</version>
        </dependency>
    <!--切入点表达式依赖，目的是找到切入点方法，也就是找到要增强的方法-->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.19</version>
        </dependency>
    </dependencies>

　　2、定义dao接口与实现类

　　在dao下面创建BookDao接口类文件

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

　　在dao下面创建impl文件夹，里面创建BookDao的实现类BookDaoImpl

package com.itheima.dao.impl;

import com.itheima.dao.BookDao;
import org.springframework.stereotype.Repository;

@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、定义通知类，制作通知方法

　　创建aop文件夹，并在下面创建类MyAdvice。

package com.itheima.aop;

import org.springframework.stereotype.Component;

@Component
public class MyAdvice {
    public void method() {
        System.out.println(System.currentTimeMillis());
        System.out.println("进行增强功能");
    }
}

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

package com.itheima.aop;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class MyAdvice {
    //设置切入点，@Pointcut注解要求配置在方法上方
    @Pointcut("execution(void com.itheima.dao.BookDao.update())")
    private void pt(){}
    //设置在切入点pt()的前面运行当前操作(前置通知)
    @Before("pt()")
    public void method() {
        System.out.println(System.currentTimeMillis());
        System.out.println("进行增强功能");
    }
}

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

　　创建config文件夹，创建Spring的配置文件。

package com.itheima.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;

// 告知spring这是个配置类
@Configuration
// 扫描指定包
@ComponentScan(basePackages = {"com.itheima"})
// 开启aop,告知spring开启使用注解的方式开启aop
@EnableAspectJAutoProxy
public class SpringConfig {

}

　　6、创建启动文件

　　在项目目录下创建启动类文件，App文件

package com.itheima;

import com.itheima.config.SpringConfig;
import com.itheima.dao.BookDao;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class App {
    public static void main(String[] args) {
        // 1. 创建容器对象, 传入配置类
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        // 2. 从容器中获取对象
        BookDao bookDao = context.getBean(BookDao.class);
        // 3. 执行方法
//        bookDao.save();
        bookDao.update();
    }
}

　　7、最终项目目录结构

五、切入点表达式

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

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

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

execution(* com.testweb.service.*Service.*(..))

　　切入点表达式描述通配符

　　　　作用：用于快速描述，范围描述

　　　　* ：匹配任意符号（常用）

　　　　..：匹配多个连续的任意符号（常用）

　　　　+：匹配子类型

　　切入点表达式书写技巧

　　　　1、按标准规范开发

　　　　2、查询操作的返回值建议使用*匹配

　　　　3、减少使用 .. 的形式描述包

　　　　4、对接口进行描述，使用 * 表示模块名，例如UserService的匹配描述为 *Service

　　　　5、方法名书写保留动词，例如get，使用 * 表示名词，例如getById匹配描述为 getBy*

　　　　6、参数根据实际情况灵活调整

六、通知类型

　　1、通知类型

　　　　1、前置通知

　　　　2、后置通知

　　　　3、环绕通知（重点）

　　　　　　* 环绕通知依赖形参ProceedingJoinPoint才能实现对原始方法的调用

　　　　　　* 环绕通知可以隔离原始方法的调用执行

　　　　　　* 环绕通知返回值设置为object类型

　　　　　　* 环绕通知中可以对原始方法调用过程中出现的异常进行处理

　　　　4、返回后通知

　　　　5、抛出异常后通知

　　2、AOP通知获取数据

　　　　1、获取切入点方法的参数

　　　　　　* JoinPoint：适用于前置（@Before）、后置（@after）、返回后（@AfterReturning）、抛出异常后通知(@AfterThrowing)

package com.itheima.aop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class MyAdvice {
    //设置切入点，@Pointcut注解要求配置在方法上方
    @Pointcut("execution(* com.itheima.dao.BookDao.findName(..))")
    private void pt(){}
    //设置在切入点pt()的前面运行当前操作(前置通知)
    @Before("pt()")
    public void method(JoinPoint jp) {
        // 获取参数
        for (Object o : jp.getArgs()) {
            System.out.println(o);
        }
        System.out.println(System.currentTimeMillis());
        System.out.println("进行增强功能");
    }
}

　　　　　　* ProceedJointPoint：适用于环绕通知

package com.itheima.aop;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class MyAdvice {
    //设置切入点，@Pointcut注解要求配置在方法上方
    @Pointcut("execution(* com.itheima.dao.BookDao.findName(..))")
    private void pt() {
    }

    //设置在切入点pt()的前面运行当前操作(前置通知)
    @Around("pt()")
    public Object method(ProceedingJoinPoint pjp) throws Throwable {
        // 获取参数
        Object[] args = pjp.getArgs();
        // 修改原先的参数
        args[0] = 666;
        // 执行原方法,并传入参数
        Object ret = pjp.proceed(args);
        System.out.println("进行增强功能");
        return ret;
    }
}

　　　　2、获取切入点方法返回值

　　　　　　* 返回后通知

package com.itheima.aop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

import java.util.Arrays;

@Component
@Aspect
public class MyAdvice {
    //设置切入点，@Pointcut注解要求配置在方法上方
    @Pointcut("execution(* com.itheima.dao.BookDao.findName(..))")
    private void pt() {
    }
    // 设置在原函数执行后执行当前操作(后置通知）
    // 如果有返回值，则可以写成afterReturning(value = "pt()", returning = "ret"),使用ret接收原方法返回值
    // 如果有参数，则public void afterReturning(JoinPoint jp, Object ret)，且JoinPoint jp，一定要在前面
    @AfterReturning(value = "pt()", returning = "ret")
    public void afterReturning(JoinPoint jp, Object ret) {
        // 获取参数
        Object[] args = jp.getArgs();
        System.out.println("参数：" + Arrays.toString(args));
        System.out.println("返回值：" + ret);
        System.out.println("执行后置通知");
    }
}

　　　　　　* 环绕通知

package com.itheima.aop;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class MyAdvice {
    //设置切入点，@Pointcut注解要求配置在方法上方
    @Pointcut("execution(* com.itheima.dao.BookDao.findName(..))")
    private void pt() {
    }

    //设置在切入点pt()的前面运行当前操作(前置通知)
    @Around("pt()")
    public Object method(ProceedingJoinPoint pjp) throws Throwable {
        // 获取参数
        Object[] args = pjp.getArgs();
        // 修改原先的参数
        args[0] = 666;
        // 执行原方法,并传入参数，并用ret接收原方法返回值
        Object ret = pjp.proceed(args);
        System.out.println("进行增强功能");
        return ret;
    }
}

　　　　3、获取切入点方法运行异常信息

　　　　　　* 抛出异常后通知

package com.itheima.aop;

import org.aspectj.lang.JoinPoint;import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

import java.util.Arrays;

@Component
@Aspect
public class MyAdvice {
    //设置切入点，@Pointcut注解要求配置在方法上方
    @Pointcut("execution(* com.itheima.dao.BookDao.findName(..))")
    private void pt() {
    }


    @AfterThrowing(value = "pt()", throwing = "e")
    public void afterThrowing(JoinPoint jp, Exception e) {
        // 获取参数
        Object[] args = jp.getArgs();
        System.out.println("参数：" + Arrays.toString(args));
        System.out.println("异常：" + e);
        System.out.println("执行异常后置通知");
    }
}