springAOP完整实现过程

更新时间：2024年02月28日 10:50:41 作者：苏汀star

当你调用SimpleService类的doSomething方法时,上述的PerformanceAspect会自动拦截此调用,并且记录该方法的执行时间,这样你就完成了一个针对Spring的AOP入门级案例,感兴趣的朋友一起看看吧

前言

江湖阳哥曾经说过这么句话：
使用技术在当前这个环境中无非就是这么几步：
1、引入POM（maven）坐标
2、改yml（配置文件也可以是properties等等）
3、写配置类或者在启动类上加注解
4、写代码就完事

提示：以下是本篇文章正文内容，下面案例可供参考

一、熟悉相关概念：

在Spring AOP中，注解是
定义切面（Aspects）、切点（Pointcuts）、通知（Advice）等的主要方式。
以下是Spring AOP中几种常见的注解及其用途和如何使用：

1、@Aspect：

作用：标识一个类为切面类。
使用方式：将此注解标注在类上，这个类会包含切点和通知的定义。
示例

示例：

@Aspect
public class MyAspect {
    // 切点和通知定义...
}

2、@Pointcut：

作用：定义一个切点，即横切关注点的入口，明确什么样的方法调用会被拦截。
使用方式：在方法声明前使用此注解，并提供一个切点表达式，该方法本身通常是空方法，仅作为切点的引用。
示例：

@Aspect
public class MyAspect {
    @Pointcut("execution(* com.example.service.*.*(..))")
    public void serviceMethod() {}
    // 其他通知...
}

3、@Before：

作用：定义一个前置通知，在切点的方法执行之前执行。
使用方式：将此注解放在一个方法上，该方法将在目标方法执行前执行。
示例：

示例：

@Aspect
public class MyAspect {
    @Before("serviceMethod()")
    public void beforeServiceMethod() {
        // 前置逻辑...
    }
}

4、@AfterReturning：

作用：定义一个返回后通知，如果切点的方法正常返回后执行。
使用方式：将此注解放在一个方法上，并通过该方法提供的参数记入返回的值。
示例：

@Aspect
public class MyAspect {
    @AfterReturning(pointcut = "serviceMethod()", returning = "retVal")
    public void afterReturning(Object retVal) {
        // 处理返回值...
    }
}

5、@AfterThrowing：

作用：定义一个异常通知，如果切点的方法抛出异常后执行。
使用方式：将此注解放在一个方法上，并可选地获取抛出的异常。
示例：

@Aspect
public class MyAspect {
    @AfterThrowing(pointcut = "serviceMethod()", throwing = "ex")
    public void afterThrowing(Exception ex) {
        // 异常处理...
    }
}

6、@After：

作用：定义一个最终通知，无论切点的方法是正常返回还是抛出异常都会执行。
使用方式：将此注解放在一个方法上，该方法无论目标方法如何都会执行。
示例：

示例：

@Aspect
public class MyAspect {
    @After("serviceMethod()")
    public void afterServiceMethod() {
        // 最终逻辑...
    }
}

7、@Around：

作用：定义一个环绕通知，可以自定义在目标方法前后执行的逻辑，同时决定是否继续执行目标方法。
使用方式：将此注解放在一个方法上，该方法需要返回一个Object，可能是目标方法的返回值，也可能是你自定义的返回值。你可以在此方法中直接调用目标方法。
示例：

@Aspect
public class MyAspect {
    @Around("serviceMethod()")
    public Object aroundServiceMethod(ProceedingJoinPoint pjp) throws Throwable {
        // 前置逻辑...
        Object result = pjp.proceed(); // 执行目标方法
        // 后置逻辑...
        return result;
    }
}

Spring AOP的使用通常有两种方式：

通过注解驱动的方式：在配置类上使用 @EnableAspectJAutoProxy 注解开启AOP支持，然后声明切面类和相关注解。

通过XML配置的方式：在XML文件中定义 aop:config 元素，并在该元素内部配置切面和通知。

通常情况下，注解驱动的方式更简洁直观，且是推荐的做法。不过，在某些用例或旧项目中，XML配置方式可能还是会用到。

二、具体使用case：

当然，让我们以一个简单的AOP用例为例，实现一个记录方法执行时间的切面。首先确保您的项目已经加入了Spring AOP的相关依赖，例如，使用Maven时，您可以添加下列依赖到您的pom.xml文件：

1.pom文件

<!-- Spring AOP 依赖 -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>5.3.18</version>
</dependency>
<!-- AOP联盟API -->
<dependency>
    <groupId>aopalliance</groupId>
    <artifactId>aopalliance</artifactId>
    <version>1.0</version>
</dependency>
<!-- Spring框架的一部分，用于处理AOP的代理 -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aspects</artifactId>
    <version>5.3.18</version>
</dependency>

2.代码

现在，让我们创建一个切面，该切面会记录方法执行的时间：

// 具有@Aspect注解的类会被Spring识别为一个切面
@Aspect
// 确保这个类被Spring的容器扫描到，通常它应该位于@ComponentScan指定的包或子包中
@Component
public class PerformanceAspect {
    // 切点表达式，这里是指任意返回值的Service层中的任意方法
    @Pointcut("execution(* com.example.service.*.*(..))")
    public void serviceMethod() {}
    // 环绕通知，让我们可以在方法执行前后添加自定义逻辑
    @Around("serviceMethod()")
    public Object profile(ProceedingJoinPoint pjp) throws Throwable {
        long start = System.currentTimeMillis(); // 开始时间
        Object output = pjp.proceed(); // 执行被代理的方法
        long elapsedTime = System.currentTimeMillis() - start; // 计算消耗的时间
        System.out.println("Method execution time: " + elapsedTime + " milliseconds.");
        return output; // 返回被代理方法的返回值
    }
}

然后，你需要在Spring的配置类加入如下内容，以启用AOP的自动代理功能：

@Configuration
@EnableAspectJAutoProxy
@ComponentScan("com.example") // 修改为你的包名
public class AppConfig {
    // 可以添加额外的Bean配置...
}

现在，你的AOP切面已经准备好了。当你的程序运行时，任何匹配Pointcut（位于com.example.service包的任意方法）的方法都会被PerformanceAspect所拦截，它会在方法执行前后记录执行时间，并将该时间打印到控制台。
假设我们有一个简单的服务类：

package com.example.service;
import org.springframework.stereotype.Service;
@Service
public class SimpleService {
    public void doSomething() {
        // 模拟业务逻辑处理时间
        try {
            Thread.sleep(1000); 
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
        }
    }
}

当你调用SimpleService类的doSomething方法时，上述的PerformanceAspect会自动拦截此调用，并且记录该方法的执行时间。这样你就完成了一个针对Spring的AOP入门级案例。

总结

好了尽情的开发使用吧，其实这个是为了我写那个面试题的文章准备的哈哈哈哈

到此这篇关于springAOP完整实现过程的文章就介绍到这了,更多相关springAOP实现内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java编程实现springMVC简单登录实例
这篇文章主要介绍了Java编程实现springMVC简单登录实例，具有一定参考价值，需要的朋友可以了解下。
2017-11-11
Java 在游戏中探索数组二维数组
数组和二维数组感觉用王者荣耀的装备栏来举例解释，应该更易懂一些。从基础开始讲，后续会讲到JAVA高级，中间会穿插面试题和项目实战，希望能给大家带来帮助
2022-03-03
RocketMQ中的NameServer详细解析
这篇文章主要介绍了RocketMQ中的NameServer详细解析,NameServer是一个非常简单的Topic路由注册中心,支持Broker的动态注册与发现,因此不能保证NameServer的一致性,需要的朋友可以参考下
2024-01-01
JDK安装与配置超级详细教程(包含二个或多个JDK的同时安装)
这篇文章主要给大家介绍了关于JDK安装与配置(包含二个或多个JDK的同时安装)的相关资料,对于Java学习者来说,一台电脑拿到手肯定要配置JDK,但是对于新手来说还是容易出错,需要的朋友可以参考下
2023-10-10
利用Kafka动态调整topic分区partition
这篇文章主要介绍了利用Kafka动态调整topic分区partition问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-12-12
Spring Boot对Future模式的支持详解
这篇文章主要给大家介绍了关于Spring Boot对Future模式的支持的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用spring boot具有一定的参考学习价值，需要的朋友们下面来一起看看吧
2019-01-01
详解spring项目中如何动态刷新bean
这篇文章主要为大家介绍了详解spring项目中如何动态刷新bean,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-08-08
Java检查日期字符串是否合法的方法总结
后端接口在接收数据的时候，都需要进行检查。检查全部通过后，才能够执行业务逻辑。本文总结了四个Java检查日期字符串是否合法的方法，感兴趣的可以了解一下
2022-10-10
Java多线程ForkJoinPool实例详解
这篇文章主要介绍了Java多线程ForkJoinPool实例详解,涉及forkjoin框架的相关内容，需要的朋友可以参考下。
2017-09-09
快速入门HarmonyOS的Java UI框架的教程
这篇文章主要介绍了快速入门HarmonyOS的Java UI框架,本文给大家介绍的非常详细对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-09-09