Spring基于注解使用AOP

1.1 AOP简介和作用

• AOP(Aspect Oriented Programming)面向切面编程，一种编程范式，指导开发者如何组织程序结构
• OOP(Object Oriented Programming)面向对象编程
• 作用：在不惊动原始设计的基础上为其进行功能增强。简单的说就是在不改变方法源代码的基础上对方法进行功能增强。
• Spring理念：无入侵式/无侵入式

1.2 AOP中的核心概念

连接点（JoinPoint）：正在执行的方法，例如：update()、delete()、select()等都是连接点。

• 切入点（Pointcut）：进行功能增强了的方法，例如:update()、delete()方法，select()方法没有被增强所以不是切入点，但是是连接点。
• 在SpringAOP中，一个切入点可以只描述一个具体方法，也可以匹配多个方法
  • 一个具体方法：com.itheima.dao包下的BookDao接口中的无形参无返回值的save方法
  • 匹配多个方法：所有的save方法，所有的get开头的方法，所有以Dao结尾的接口中的任意方法，所有带有一个参数的方法
• 通知（Advice）：在切入点前后执行的操作，也就是增强的共性功能
• 在SpringAOP中，功能最终以方法的形式呈现
• 通知类：通知方法所在的类叫做通知类
• 切面（Aspect）：描述通知与切入点的对应关系，也就是哪些通知方法对应哪些切入点方法。

2.2 AOP入门案例实现

导入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>

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

//通知类必须配置成Spring管理的bean
@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());
    }
}

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

@Configuration
@ComponentScan("通知类所在的包")
//开启注解开发AOP功能
@EnableAspectJAutoProxy
public class SpringConfig {
}

AOP切入点表达式

语法格式

• 切入点：要进行增强的方法
• 切入点表达式：要进行增强的方法的描述方式
• 描述方式一：执行com.dao包下的BookDao接口中的无参数update方法

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

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

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

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

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

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

通配符

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

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

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

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

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

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

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

• +：专用于匹配子类类型

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

AOP通知类型

前置通知

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

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

后置通知

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

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

返回后通知

• 名称：@AfterReturning（了解）
• 类型： 方法注解
• 位置：通知方法定义上方
• 作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法正常执行完毕后运行
• 范例：

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

抛出异常后通知

• 名称：@AfterThrowing（了解）
• 类型： 方法注解
• 位置：通知方法定义上方
• 作用：设置当前通知方法与切入点之间的绑定关系，当前通知方法在原始切入点方法运行抛出异常后执行
• 范例：

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

5.2.5 环绕通知

• 名称：@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;
}

环绕通知注意事项

1. 环绕通知方法形参必须是ProceedingJoinPoint，表示正在执行的连接点，使用该对象的proceed()方法表示对原始对象方法进行调用，返回值为原始对象方法的返回值。
2. 环绕通知方法的返回值建议写成Object类型，用于将原始对象方法的返回值进行返回，哪里使用代理对象就返回到哪里。

AOP切入点数据获取

2 获取参数

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

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

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

• 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.2 获取返回值

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

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

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

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

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

2.3 获取异常

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

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

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

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

Original: https://www.cnblogs.com/icemomo/p/16209985.html
Author: 冰莫莫
Title: Spring基于注解使用AOP