Spring AOP - 配置文件方式实现

xujinwei_gingko2024-09-23 11:16

目录

AOP基础概念

示例1：模拟在com.text包及子包项下所有类名称以ServiceImpl结尾的类的所有方法执行前、执行后、执行正常后返回值、执行过程中出异常的情况

示例2：统计com.text包及子包项下所有类名称以DaoImpl结尾的类的所有方法执行时长情况

AOP基础概念

AOP：Aspect Oriented Programming 面向切面编程

使用场景：将一些通用的功能封装成切面类，切面类作用在目标类方法的前后，并通过自动插拔实现目标类方法的前后逻辑，示意图如下：

上述的示意图显示，Aspect切面类横向贯穿了3个目标类方法的执行逻辑之前，由此可以看出，AOP实现需要如下组件：

  1. 切面类（Aspect类）
  2. 切点（Pointcut），即上图的各个目标方法，通过切点表达式（execution)实现
  3. 连接点（JoinPoint) ，切面和切点之间的连接信息，可以理解为横切面和切点的交汇处
  4. 通知（Advice) ，在目标类方法的之前、之后还是环绕执行切面逻辑

Spring AOP实现需要引入aspectjweaver依赖

XML 复制代码 
<dependency>
   <groupId>org.aspectj</groupId>
   <artifactId>aspectjweaver</artifactId>
   <version>1.9.6</version>
</dependency>

示例1：模拟在com.text包及子包项下所有类名称以ServiceImpl结尾的类的所有方法执行前、执行后、执行正常后返回值、执行过程中出异常的情况

1、配置文件：applicationContext.xml

XML 复制代码 
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns="http://www.springframework.org/schema/beans"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd">
    <!--<context:component-scan base-package="com.text"/>-->
    <bean id="studentService" class="com.text.service.impl.StudentServiceImpl"/>
    <!-- 切面类交给IOC容器实例 -->
    <bean id="methodAspect" class="com.text.aspect.MethodAspect"/>
    <!-- aop配置-->
    <aop:config>
        <!-- 切点配置，expression表示com.text所有包及子包项下所有服务层（以ServiceImpl结束的类）的所有方法-->
        <aop:pointcut id="pointcut" expression="execution(public * com.text..*ServiceImpl.*(..))"/>
        <!-- 切面配置-->
        <aop:aspect ref="methodAspect">
            <!-- 切点方法执行之前执行-->
            <aop:before method="methodInvokeBefore" pointcut-ref="pointcut"/>
            <!-- 切点方法执行之后执行-->
            <aop:after method="methodInvokeAfter" pointcut-ref="pointcut"/>
            <!-- 切点方法执行之后带返回值-->
            <aop:after-returning method="methodInvokeAfterReturn" returning="ret" pointcut-ref="pointcut"/>
            <!-- 切点方法执行时出现异常-->
            <aop:after-throwing method="methodInvokeException" throwing="thr" pointcut-ref="pointcut"/>
        </aop:aspect>
    </aop:config>

</beans>

2、服务类及方法（pointcut)

java 复制代码 
package com.text.service.impl;

import com.text.entity.Course;
import com.text.entity.Student;
import com.text.service.StudentService;

public class StudentServiceImpl implements StudentService {

    @Override
    public void save(Student student) {
        System.out.println(student + "正在被保存...");
    }

    @Override
    public void deleteById(String id) {
        System.out.println("学生id=" + id + "的记录已被删除...");
    }

    @Override
    public void updateById(String id) throws Exception{
        System.out.println("学生id=" + id + "的记录正在被修改...");
        throw new Exception("修改学生信息出异常");
    }

    @Override
    public Student searchById(String id) {
        System.out.println("已查询到学生id=" + id + "的记录...");
        return new Student("张三",20,new Course("计算机"));
    }
}

3、切面类（aspect)

java 复制代码 
package com.text.aspect;

import org.aspectj.lang.JoinPoint;

/**
 * 定义方法切面类
 */
public class MethodAspect {
    public void methodInvokeBefore(JoinPoint joinPoint) {
        String targetClassName = joinPoint.getTarget().getClass().getName();//获取切面执行的目标类
        String methodName = joinPoint.getSignature().getName();
        System.out.println(targetClassName + "." + methodName + "方法执行之前的处理逻辑...");
    }

    public void methodInvokeAfter(JoinPoint joinPoint) {
        String targetClassName = joinPoint.getTarget().getClass().getName();//获取切面执行的目标类
        String methodName = joinPoint.getSignature().getName();
        System.out.println(targetClassName + "." + methodName + "方法执行之后的处理逻辑...");
    }

    public void methodInvokeAfterReturn(JoinPoint joinPoint,Object ret) {
        String targetClassName = joinPoint.getTarget().getClass().getName();//获取切面执行的目标类
        String methodName = joinPoint.getSignature().getName();
        System.out.println(targetClassName + "." + methodName + "方法执行之后返回的结果为:" + ret);
    }

    public void methodInvokeException(JoinPoint joinPoint,Throwable thr) throws Throwable {
        String targetClassName = joinPoint.getTarget().getClass().getName();//获取切面执行的目标类
        String methodName = joinPoint.getSignature().getName();
        System.out.println(targetClassName + "." + methodName + "方法执行中的异常信息为:" + thr.getMessage());
        throw thr;
    }
}

4、测试类 Application

java 复制代码 
package com.text;
import com.text.entity.Course;
import com.text.entity.Student;
import com.text.service.StudentService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Application {
    public static void main(String[] args) throws Exception {
        ApplicationContext context = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        StudentService studentService = context.getBean("studentService", StudentService.class);
        studentService.save(new Student("张三",20,new Course("计算机")));
        System.out.println("======save end========");
        studentService.deleteById("1");
        System.out.println("======delete end ========");
        Student student = studentService.searchById("1");
        System.out.println("======search end ========");
        studentService.updateById("1");
        System.out.println("======update end ========");
    }
}

5、输出结果：

**示例2：**统计com.text包及子包项下所有类名称以DaoImpl结尾的类的所有方法执行时长情况

此需求如果按照之前的advice至少需要写2个，一个是aop:before，一个是aop:after，方法的总执行时间需要after的当前时间减去before的当前时间，这2个时间如何联通也存在困难，AOP 提供一种自定义的通知执行时机-Around Advice(环绕通知）可以轻松解决此需求

1、配置文件：applicationContext.xml

XML 复制代码 
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns="http://www.springframework.org/schema/beans"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd">
    <!--<context:component-scan base-package="com.text"/>-->
    <bean id="studentDao" class="com.text.dao.impl.StudentDaoImpl"/>
    <!-- 切面类交给IOC容器实例 -->
    <bean id="methodAspect" class="com.text.aspect.MethodAspect"/>
    <!-- aop配置-->
    <aop:config>
        <!-- 切点配置，expression表示com.text所有包及子包项下所有服务层（以DaoImpl结束的类）的所有方法-->
        <aop:pointcut id="pointcut" expression="execution(public * com.text..*DaoImpl.*(..))"/>
        <!-- 切面配置-->
        <aop:aspect ref="methodAspect">
            <!-- 自定义的环绕通知-->
            <aop:around method="countMethodInvokeTime" pointcut-ref="pointcut"/>
        </aop:aspect>
    </aop:config>

</beans>

2、服务类及方法（pointcut)

java 复制代码 
package com.text.dao.impl;
import com.text.dao.StudentDao;

public class StudentDaoImpl implements StudentDao {

    @Override
    public void getById(String id) throws Exception {
        Thread.sleep(1000);
        System.out.println("查询学生id=" + id + "的信息");
    }
}

3、切面类（aspect)

java 复制代码 
package com.text.aspect;

import org.aspectj.lang.ProceedingJoinPoint;

import java.util.Date;

/**
 * 定义方法切面类
 */
public class MethodAspect {
    public void countMethodInvokeTime(ProceedingJoinPoint proceedingJoinPoint) {
        System.out.println("目标方法执行之前记录初始时间...");
        Date startTime = new Date();
        try {
            proceedingJoinPoint.proceed();//执行目标方法 即：StudentDaoImpl.getById方法
            System.out.println("目标方法执行之后记录结束时间...");
            String methodName = proceedingJoinPoint.getTarget().getClass().getName() + "." +
                    proceedingJoinPoint.getSignature().getName();
            Date endTime = new Date();
            System.out.println(methodName + "方法执行总时长为：" + (endTime.getTime() - startTime.getTime()) + "毫秒");
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
    }
}

4、测试类 Application

java 复制代码 
package com.text;

import com.text.dao.StudentDao;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Application {
    public static void main(String[] args) throws Exception {
        ApplicationContext context = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        StudentDao studentDao = context.getBean("studentDao", StudentDao.class);
        studentDao.getById("1");
        System.out.println("======getById end========");
    }
}

5、输出结果：

相关推荐
程序员大金10 分钟前
基于SpringBoot+Vue+MySQL的校园一卡通系统
java·javascript·vue.js·spring boot·后端·mysql·tomcat
基础不牢，地动山摇...16 分钟前
jbcTemplate和namedParameterJdbcTemplate详解
java·开发语言·数据库
逸狼16 分钟前
【JavaEE初阶】文件IO(上)
java·java-ee
科研小白_d.s17 分钟前
数据结构的基础知识
java·开发语言·数据结构
布说在见25 分钟前
Spring Boot管理用户数据
java·spring boot·后端
小七蒙恩32 分钟前
java的排序算法，代码详细说明
java·算法·排序算法
coder what44 分钟前
基于springboot的图书管理系统
java·spring boot·后端·图书管理系统
熙客1 小时前
Spring MVC的应用
java·spring·mvc
赤橙红的黄1 小时前
策略模式+模版模式+工厂模式
java·开发语言·策略模式
coffee_baby2 小时前
策略模式在 Spring Boot 框架中的应用
java·spring boot·后端·策略模式
热门推荐
01组基轨迹建模 GBTM的介绍与实现（Stata 或 R）02RAG 实践- Ollama+RagFlow 部署本地知识库032024年高教社杯数学建模国赛C题超详细解题思路分析04yolov8实战第五天——yolov8+ffmpg实时视频流检测并进行实时推流——（推流，保姆教学）05CCF-CSP认证考试 202406-3 文本分词 100分题解06【2024数模国赛赛题思路公开】国赛B题思路丨附可运行代码丨无偿自提07【SCS-CN】SCS-CN模型中CN值的确定08苍穹外卖面试总结09【2024高教社杯全国大学生数学建模竞赛】B题 生产过程中的决策问题——解题思路 代码 论文10【极空间NAS】使用WebDAV服务 + DDNSTO内网穿透 实现思源笔记的内外网同步