Spring AOP切入点与通知XML类型

itzhuzhu.

已于 2022-05-05 10:00:39 修改

阅读量1.4k

点赞数 1

分类专栏： Spring 文章标签： spring java Spring AOP AOP配置切入点通知

于 2021-12-28 16:40:21 首次发布

本文链接：https://blog.csdn.net/weixin_45477086/article/details/122175244

版权

Spring 专栏收录该内容

9 篇文章 2 订阅

订阅专栏

`AOP：`

AOP(Aspect Oriented Programing)面向切面编程，一种编程范式，隶属于软工范畴，指导开发者如何组织程序结构
AOP弥补了OOP的不足，基于OOP基础之上进行横向开发
uOOP规定程序开发以类为主体模型，一切围绕对象进行，完成某个任务先构建模型
uAOP程序开发主要关注基于OOP开发中的共性功能，一切围绕共性功能进行，完成某个任务先构建可能遇到的所有共性功能（当所有功能都开发出来也就没有共性与非共性之分）

AOP是“AOP联盟”提出来的，Spring是用这种思想把AOP落地

`AOP作用：`

伴随着AOP时代的降临，可以从各个行业的标准化、规范化开始入手，一步一步将所有共性功能逐一开发完毕，最终以功能组合来完成个别业务模块乃至整体业务系统的开发，比如我要建站，直接去拼各个组件模块
目标：将软件开发由手工制作走向半自动化/全自动化阶段，实现“插拔式组件体系结构”搭建
标准的统一怎么理解：比如买usb接口，直接下单不需要考虑买回来是个圆的插不上去，因为都遵守了标准规范

`AOP优势：`

提高代码的可重用性
业务代码编码更简洁
业务代码维护更高效
业务功能扩展更便捷

`AOP相关概念：`

在这里插入图片描述

Joinpoint(连接点)：就是方法
Pointcut(切入点)：就是挖掉共性功能的方法
Advice(通知)：就是共性功能，最终以一个方法的形式呈现
Aspect(切面)：就是共性功能与挖的位置的对应关系
Target(目标对象)：就是挖掉功能的方法对应的类产生的对象，这种对象是无法直接完成最终工作的
Weaving(织入)：就是将挖掉的功能回填的动态过程
Proxy(代理)：目标对象无法直接完成工作，需要对其进行功能回填，通过创建原始对象的代理对象实现
Introduction(引入/引介) ：就是对原始对象无中生有的添加成员变量或成员方法

`AOP开发过程：`

开发阶段(开发者完成)

正常的制作程序
将非共性功能开发到对应的目标对象类中，并制作成切入点方法
将共性功能独立开发出来，制作成通知
在配置文件中，声明切入点
在配置文件中，声明切入点与通知间的关系（含通知类型），即切面

运行阶段(AOP完成)

Spring容器加载配置文件，监控所有配置的切入点方法的执行
当监控到切入点方法被运行，使用代理机制，动态创建目标对象的代理对象，根据通知类别，在代理对象的对应位置将通知对应的功能织入，完成完整的代码逻辑并运行

`入门案例制作分析：`

1.导入相关坐标
2.确认要抽取的功能，并将其制作成方法保存到专用的类中，删除原始业务中对应的功能
3.将所有进行AOP操作的资源加载到IoC容器中
4.使用配置的方式描述被抽取功能的位置，并描述被抽取功能与对应位置的关系
5.运行程序

步骤一导入坐标

  <dependencies>
        <dependency>
            <groupId>o rg.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.3.5</version>
            <scope>compile</scope>
        </dependency>

        <!--aspectjweaver：支持切入点表达式-->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.4</version>
        </dependency>
    </dependencies>

applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        https://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--3.开启AOP命名空间-->
    <bean id="userService" class="com.itzhuzhu.service.impl.UserServiceImpl"/>
    <!--2.配置共性功能成功spring控制的资源-->
    <bean id="myAdvice" class="com.itzhuzhu.aop.AOPAdvice"/>

    <!--4.配置AOP-->
    <aop:config>
        <!--5.配置切入点-->
        <aop:pointcut id="pt" expression="execution(* *..*(..))"/>
        <!--6.配置切面（切入点与通知的关系）-->
        <aop:aspect ref="myAdvice">
            <!--7.配置具体的切入点对应通知中那个操作方法-->
            <aop:before method="function" pointcut-ref="pt"/>
        </aop:aspect>
    </aop:config>

</beans>

方法接口：

public interface UserService {
    public void save();
}

自定义的方法：

public class UserServiceImpl implements UserService {

    @Override
    public void save(){
        // 将共性功能抽取出来
        // System.out.println("共性功能");
        System.out.println("user service running...");
    }
}

共性类：

// 制作通知类，在类中定义一个方法用于完成共性功能
public class AOPAdvice {

    public void function(){
        System.out.println("共性功能");
    }
}

测试：

public class App {
    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
        UserService userService = (UserService) ctx.getBean("userService");
        userService.save();
    }
}

`AOP配置（XML）：`

`AspectJ：`

Aspect（切面）用于描述切入点与通知间的关系，是AOP编程中的一个概念
AspectJ是基于java语言对Aspect的实现

`aop:config：`

名称：aop:config
类型：标签
归属：beans标签
作用：设置AOP
格式：

<beans>
    <aop:config>……</aop:config>
    <aop:config>……</aop:config>
</beans>

说明：一个beans标签中可以配置多个aop:config标签

`aop:aspect：`

名称：aop:aspect
类型：标签
归属：aop:config标签
作用：设置具体的AOP通知对应的切入点
格式：

<aop:config>
    <aop:aspect ref="beanId">……</aop:aspect>
    <aop:aspect ref="beanId">……</aop:aspect>
</aop:config>

说明：

一个aop:config标签中可以配置多个aop:aspect标签
基本属性：

ref ：通知所在的bean的id

`aop:pointcut：`

名称：aop:pointcut
类型：标签
归属：aop:config标签、aop:aspect标签
作用：设置切入点
格式：

<aop:config>
    <aop:pointcut id="pointcutId" expression="……"/>
    <aop:aspect>
        <aop:pointcut id="pointcutId" expression="……"/>
    </aop:aspect>
</aop:config>

说明：

一个aop:config标签中可以配置多个aop:pointcut标签，且该标签可以配置在aop:aspect标签内
基本属性：
- id ：识别切入点的名称
- expression ：切入点表达式

`切入点：`

切入点描述的是某个方法
切入点表达式是一个快速匹配方法描述的通配格式，类似于正则表达式

`切入点表达式的组成：`

切入点描述的是某个方法
切入点表达式是一个快速匹配方法描述的通配格式，类似于正则表达式

关键字（访问修饰符  返回值  包名.类名.方法名（参数）异常名）

关键字：描述表达式的匹配模式（参看关键字列表）

访问修饰符：方法的访问控制权限修饰符

类名：方法所在的类（此处可以配置接口名称）

异常：方法定义中指定抛出的异常

范例：

execution（public User com.itheima.service.UserService.findById（int））

`切入点表达式——关键字`

execution ：匹配执行指定方法
args ：匹配带有指定参数类型的方法
within ：……
this ：……
target ：……
@within ：……
@target ：……
@args ：……
@annotation ：……
bean ：……
reference pointcut ：……

`切入点表达式——通配符：`

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

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

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

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

execution（public User com..UserService.findById（..））

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

+：专用于匹配子类类型

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

`切入点表达式——逻辑运算符：`

&& ：连接两个切入点表达式，表示两个切入点表达式同时成立的匹配
|| ：连接两个切入点表达式，表示两个切入点表达式成立任意一个的匹配
! ：连接单个切入点表达式，表示该切入点表达式不成立的匹配

`切入点表达式——范例：`

execution(* *(..))  *：任意返回值   *任意包，(..))任意方法,任意参数
execution(* *..*(..))  和上面一样
execution(* *..*.*(..))   *：任意返回值   *..任意包，  *.：任意类 *:任意方法  (..))任意参数
execution(public * *..*.*(..))    规定了修饰符类型public
execution(public int *..*.*(..))  规定了返回值类型int
execution(public void *..*.*(..)) 规定了返回值类型void
execution(public void com..*.*(..))   规定了第一个包是com
execution(public void com..service.*.*(..))   规定了第一个包下的service包下的任意方法类/接口
execution(public void com.itzhuzhu.service.*.*(..))  规定了com.itzhuzhu.service包下的类/接口
execution(public void com.itzhuzhu.service.User*.*(..))  规定了com.itzhuzhu.service.User开头的类/接口
execution(public void com.itzhuzhu.service.*Service.*(..))   规定了com.itzhuzhu.service.Service开头或结尾的的类/接口
execution(public void com.itzhuzhu.service.UserService.*(..))  规定了com.itzhuzhu.service.UserService的类/接口
execution(public User com.itzhuzhu.service.UserService.find*(..))  规定了com.itzhuzhu.service.Service.find开头的的类/接口
execution(public User com.itzhuzhu.service.UserService.*Id(..))  规定了com.itzhuzhu.service.Service.以什么id结尾的的方法
execution(public User com.itzhuzhu.service.UserService.findById(..))  规定了com.itzhuzhu.service.Service.findById的方法
execution(public User com.itzhuzhu.service.UserService.findById(int)) 规定了com.itzhuzhu.service.Service.findById并有一个int参数的的方法
execution(public User com.itzhuzhu.service.UserService.findById(int,int))   规定了com.itzhuzhu.service.Service.findById并有两个int参数的的方法
execution(public User com.itzhuzhu.service.UserService.findById(int,*))   规定了com.itzhuzhu.service.Service.findById并第一个参数是int，第二个任意参数的的方法
execution(public User com.itzhuzhu.service.UserService.findById(*,int))   前面参数类型任意，后面任意
execution(public User com.itzhuzhu.service.UserService.findById())  无参数
execution(List com.itzhuzhu.service.*Service+.findAll(..))   返回值类型是list的，service包下的以service结尾的类/接口中findall方法，不限参数

`切入点的三种配置方式：`

<aop:config>
    <!--配置公共切入点-->
    <aop:pointcut id="pt1" expression="execution(* *(..))"/>
    <aop:aspect ref="myAdvice">
        <!--配置局部切入点-->
        <aop:pointcut id="pt2" expression="execution(* *(..))"/>
        <!--引用公共切入点-->
        <aop:before method="logAdvice" pointcut-ref="pt1"/>
        <!--引用局部切入点-->
        <aop:before method="logAdvice" pointcut-ref="pt2"/>
        <!--直接配置切入点-->
        <aop:before method="logAdvice" pointcut="execution(* *(..))"/>
    </aop:aspect>
</aop:config>

`切入点配置经验：`

企业开发命名规范严格遵循规范文档进行
先为方法配置局部切入点
再抽取类中公共切入点
最后抽取全局切入点
代码走查过程中检测切入点是否存在越界性包含
代码走查过程中检测切入点是否存在非包含性进驻
设定AOP执行检测程序，在单元测试中监控通知被执行次数与预计次数是否匹配
设定完毕的切入点如果发生调整务必进行回归测试

（以上规则适用于XML配置格式）

`通知类型：`

AOP的通知类型共5种

前置通知：原始方法执行前执行，如果通知中抛出异常，阻止原始方法运行

应用：数据校验
后置通知：原始方法执行后执行，无论原始方法中是否出现异常，都将执行通知

应用：现场清理
返回后通知：原始方法正常执行完毕并返回结果后执行，如果原始方法中抛出异常，无法执行

应用：返回值相关数据处理
抛出异常后通知：原始方法抛出异常后执行，如果原始方法没有抛出异常，无法执行

应用：对原始方法中出现的异常信息进行处理
环绕通知：在原始方法执行前后均有对应执行执行，还可以阻止原始方法的执行

应用：十分强大，可以做任何事情

`aop:before：`

名称：aop:before
类型：标签
归属：aop:aspect标签
作用：设置前置通知
格式：

<aop:aspect ref="adviceId">
    <aop:before method="methodName" pointcut="……"/>
</aop:aspect>

说明：一个aop:aspect标签中可以配置多个aop:before标签
基本属性：
- method ：在通知类中设置当前通知类别对应的方法
- pointcut ：设置当前通知对应的切入点表达式，与pointcut-ref属性冲突
- pointcut-ref ：设置当前通知对应的切入点id，与pointcut属性冲突

`aop:after：`

名称：aop:after
类型：标签
归属：aop:aspect标签
作用：设置后置通知
格式：

<aop:aspect ref="adviceId">
    <aop:after method="methodName" pointcut="……"/>
</aop:aspect>

说明：一个aop:aspect标签中可以配置多个aop:after标签
基本属性：
- method ：在通知类中设置当前通知类别对应的方法
- pointcut ：设置当前通知对应的切入点表达式，与pointcut-ref属性冲突
- pointcut-ref ：设置当前通知对应的切入点id，与pointcut属性冲突

`aop:after-returning：`

名称：aop:after-returning
类型：标签
归属：aop:aspect标签
作用：设置返回后通知
格式：

<aop:aspect ref="adviceId">
    <aop:after-returning method="methodName" pointcut="……"/>
</aop:aspect>

说明：一个aop:aspect标签中可以配置多个aop:after-returning标签
基本属性：
- method ：在通知类中设置当前通知类别对应的方法
- pointcut ：设置当前通知对应的切入点表达式，与pointcut-ref属性冲突
- pointcut-ref ：设置当前通知对应的切入点id，与pointcut属性冲突

`aop:after-throwing：`

名称：aop:after-throwing
类型：标签
归属：aop:aspect标签
作用：设置抛出异常后通知
格式：

<aop:aspect ref="adviceId">
    <aop:after-throwing method="methodName" pointcut="……"/>
</aop:aspect>

说明：一个aop:aspect标签中可以配置多个aop:after-throwing标签
基本属性：
- method ：在通知类中设置当前通知类别对应的方法
- pointcut ：设置当前通知对应的切入点表达式，与pointcut-ref属性冲突
- pointcut-ref ：设置当前通知对应的切入点id，与pointcut属性冲突

`aop:around：`

名称：aop:around
类型：标签
归属：aop:aspect标签
作用：设置环绕通知
格式：

<aop:aspect ref="adviceId">
    <aop:around method="methodName" pointcut="……"/>
</aop:aspect>

说明：一个aop:aspect标签中可以配置多个aop:around标签
基本属性：
- method ：在通知类中设置当前通知类别对应的方法
- pointcut ：设置当前通知对应的切入点表达式，与pointcut-ref属性冲突
- pointcut-ref ：设置当前通知对应的切入点id，与pointcut属性冲突

环绕通知的开发方式

环绕通知是在原始方法的前后添加功能，在环绕通知中，存在对原始方法的显式调用

public Object around(ProceedingJoinPoint pjp) throws Throwable {
	// 要使用proceed分割，才能知道哪是前后
    System.out.println("before");
    
    Object ret = pjp.proceed();
    
    System.out.println("after");
    return ret;
    
}

环绕通知方法相关说明：
- 方法须设定Object类型的返回值，否则会拦截原始方法的返回。如果原始方法返回值类型为void，通知方也可以设定返回值类型为void，最终返回null
- 方法需在第一个参数位置设定ProceedingJoinPoint对象，通过该对象调用proceed()方法，实现对原始方法的调用。如省略该参数，原始方法将无法执行
- 使用proceed()方法调用原始方法时，因无法预知原始方法运行过程中是否会出现异常，强制抛出Throwable对象，封装原始方法中可能出现的异常信息

`通知顺序：`

当同一个切入点配置了多个通知时，通知会存在运行的先后顺序，该顺序以通知配置的顺序为准

`通知获取数据：`

参数
返回值
异常

`通知获取参数数据：`

第一种情况：

所有的通知均可以获取参数
设定通知方法第一个参数为JoinPoint，通过该对象调用getArgs()方法，获取原始方法运行的参数数组

public void before(JoinPoint jp) throws Throwable {
    System.out.println("user service running...");
}

第二种情况：

设定切入点表达式为通知方法传递参数（锁定通知变量名）
原始方法

public void save(int a ,int b){
    System.out.println("user service running...");
}

AOP配置

<aop:aspect ref="adviceId">
	<aop:pointcut id="pt" expression="execution(* *..*(..)) &amp;&amp; args(a,b)"/>
	<aop:before method="before" pointcut-ref="pt"/>
</aop:aspect>

通知类

public void save(int a ,int b){
    System.out.println(a);
    System.out.println(b);
}

第三种情况

设定切入点表达式为通知方法传递参数（改变通知变量名的定义顺序）
原始方法

请添加图片描述

`通知获取返回值数据：`

第一种：返回值变量名

设定返回值变量名
适用于返回后通知（after-returning）
原始方法

public int save() {
	System.out.println("user service running...");
    return 100;
}

AOP配置

<aop:aspect ref="myAdvice">
    <aop:pointcut id="pt3" expression="execution(* *(..))  "/>
    <aop:after-returning method="afterReturning" pointcut-ref="pt3" returning="ret"/>
</aop:aspect>

通知类

public void afterReturning(Object ret) {
    System.out.println(ret);
}

第二种：

在通知类的方法中调用原始方法获取返回值
适用于环绕通知（around）
原始方法

public int save() {
    System.out.println("user service running...");
    return 100;
}

AOP配置l

<aop:aspect ref="myAdvice">
    <aop:pointcut id="pt2" expression="execution(* *(..))  "/>
    <aop:around method="around" pointcut-ref="pt2" />
</aop:aspect>

通知类

public Object around(ProceedingJoinPoint pjp) throws Throwable {
    Object ret = pjp.proceed();
    return ret;
}

`通知获取异常数据：`

第一种：通知类的方法中调用原始方法捕获异常

适用于环绕通知（around）
在通知类的方法中调用原始方法捕获异常
原始方法

public void save() {
    System.out.println("user service running...");
    int i = 1/0;
}

AOP配置

<aop:aspect ref="myAdvice">
    <aop:pointcut id="pt4" expression="execution(* *(..))  "/>
    <aop:around method="around" pointcut-ref="pt4" />
</aop:aspect>

通知类

public Object around(ProceedingJoinPoint pjp) throws Throwable {
    Object ret = pjp.proceed();	//对此处调用进行try……catch……捕获异常，或抛出异常
    return ret;
}

第二种：

适用于返回后通知（after-throwing）
设定异常对象变量名
原始方法

public void save() {
    System.out.println("user service running...");
    int i = 1/0;
}

AOP配置

<aop:aspect ref="myAdvice">
	<aop:pointcut id="pt4" expression="execution(* *(..))  "/>
    <aop:after-throwing method="afterThrowing" pointcut-ref="pt4" throwing="t"/>
</aop:aspect>

通知类

public void afterThrowing(Throwable t){
    System.out.println(t.getMessage());
}

itzhuzhu.

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
打赏
0
评论
Spring AOP切入点与通知XML类型

伴随着AOP时代的降临，可以从各个行业的标准化、规范化开始入手，一步一步将所有共性功能逐一开发完毕，最终以功能组合来完成个别业务模块乃至整体业务系统的开发，比如我要建站，直接去拼各个组件模块目标：将软件开发由手工制作走向半自动化/全自动化阶段，实现“插拔式组件体系结构”搭建标准的统一怎么理解：比如买usb接口，直接下单不需要考虑买回来是个圆的插不上去，因为都遵守了标准规范
复制链接

扫一扫