详细分析Spring中的@Around注解(附Demo)

这篇具有很好参考价值的文章主要介绍了详细分析Spring中的@Around注解(附Demo)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

前言

此知识点都来源于项目实战,对此进行科普总结,使得之后项目游刃有余

对于Spring的基本知识,推荐阅读:

  1. Spring框架从入门到学精(全)
  2. java框架 零基础从入门到精通的学习路线 附开源项目面经等(超全)

1. 基本知识

在Java中,@Around注解通常与AspectJ框架一起使用,用于定义一个环绕通知(around advice)。

  • AspectJ是一个面向切面编程的框架,它允许开发者通过切面(aspects)来模块化横切关注点。
  • 环绕通知是AspectJ中的一种通知类型,用于在目标方法执行前后完全控制目标方法的执行。

此处着重加深一下环绕通知以及切面这两个抽象名词的概念,有助于加深@Around注解

👇👇👇

环绕通知(Around Advice)概念:

  1. 定义
    切面中的一种通知类型,它允许在目标方法执行前后完全控制目标方法的执行。
    可以决定是否继续执行目标方法,以及是否修改目标方法的输入参数和返回值。

  2. 特点
    最灵活的通知类型,提供了对目标方法的完全控制。它能够在目标方法执行前后执行自定义逻辑,包括修改方法的输入和输出。

  3. 执行步骤
    1.在目标方法执行之前,环绕通知执行前置逻辑。
    2.调用ProceedingJoinPoint.proceed()来执行目标方法。
    3.在目标方法执行之后,环绕通知执行后置逻辑。

  4. 使用场景
    记录方法执行时间
    权限验证
    缓存控制
    事务管理等

👇👇👇

切面(Aspect)概念:

  1. 定义
    切面是一种模块化的方式,用于将横切关注点(cross-cutting concerns)从业务逻辑中分离出来
    横切关注点包括日志记录、性能统计、安全性等,它们通常涉及多个对象和方法

  2. 主要组成
    1.切入点(Join Point): 在应用程序执行期间的某个特定点,如方法调用、异常抛出等。
    2.通知(Advice): 定义在切入点上执行的操作,包括前置、后置、环绕、异常等不同类型的通知。
    3.切入点表达式(Pointcut): 用于匹配切入点的表达式,决定在哪些切入点上执行通知。

  3. 主要作用
    将横切关注点集中管理,避免散布在各处的重复代码
    提高代码的模块化和可维护性

2. Demo

以下两种Demo示例大同小异

其中不带参数与带参数章节,差异在于切面类是否可以携带参数(大白话:自定义的注解中是否携带参数,增强处理类就是否有参数)

导入依赖:使用@Around注解,先导入AspectJ库

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjrt</artifactId>
    <version>1.9.7</version> <!-- 根据实际情况调整版本号 -->
</dependency>

2.1 不带参数

  1. 创建自定义注解:创建一个自定义的注解@LogExecutionTime,该注解用于标记需要记录执行时间的方法
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogExecutionTime {
}
  1. 创建切面类:创建一个切面类LoggingAspect,其中包含一个使用@Around注解的环绕通知
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LoggingAspect {
	// @Around("@annotation(com.example.demo.LogExecutionTime)")表示该环绕通知仅在使用@LogExecutionTime注解的方法上执行
    @Around("@annotation(com.example.demo.LogExecutionTime)")
    public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();

        // 执行目标方法
        Object result = joinPoint.proceed();

        long endTime = System.currentTimeMillis();
        System.out.println(
                joinPoint.getSignature() + " executed in " + (endTime - startTime) + "ms");

        return result;
    }
}
  1. 创建控制器类:创建一个简单的Spring Boot控制器类,其中包含一个被@LogExecutionTime注解标记的方法
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DemoController {

    @LogExecutionTime
    @GetMapping("/demo")
    public String demoEndpoint() {
        // 模拟业务逻辑
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return "Demo endpoint executed";
    }
}
  1. 启动应用程序:创建一个Spring Boot应用程序入口类,启动Spring Boot应用
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
  1. 访问端点:启动应用程序后,访问http://localhost:8080/demo,可在控制台中可以看到输出的执行时间信息
    (由于代码模块中8080已被占用,此处在配置文件中修改为8088端口,并且使用测试接口测试)
# application.properties 文件
server.port=8088

以上是测试模块的代码,为了书写规整,博主将其归类如下,大致也差不多

@around,Java,spring,java,后端

输出截图如下:

结果先出这个,这个是执行过程输出!

@around,Java,spring,java,后端

最后是环绕后置通知:
@around,Java,spring,java,后端

通过切面环绕通知,实现在不修改业务逻辑的情况下,记录方法执行时间的功能。

切面提供了一种清晰、模块化的方式来处理横切关注点

2.2 带参数

  1. 带参数自定义注解:(这个注解带有一个value参数,用于传递额外的信息)
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogExecutionTime {
    String value() default "";
}
  1. 切面类
    @Around注解中使用@annotation(logExecutionTime)表示将注解信息传递给切面方法。
    通过LogExecutionTime logExecutionTime参数获取注解的值,然后在切面逻辑中使用
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LoggingAspect {

    @Around("@annotation(logExecutionTime)")
    public Object logExecutionTime(ProceedingJoinPoint joinPoint, LogExecutionTime logExecutionTime) throws Throwable {
        long startTime = System.currentTimeMillis();

        // 打印传入的参数值
        String additionalInfo = logExecutionTime.value();
        System.out.println("Additional Info: " + additionalInfo);

        // 执行目标方法
        Object result = joinPoint.proceed();

        long endTime = System.currentTimeMillis();
        System.out.println(
                joinPoint.getSignature() + " executed in " + (endTime - startTime) + "ms");

        return result;
    }
}
  1. 控制类
    在控制器类中,@LogExecutionTime(value = "Custom Message")注解传递一个带参数的自定义消息
    在demoEndpoint方法中,也接收了一个@RequestParam参数,用于演示带参数的情况。
    (对于@RequestParam参数,推荐阅读:
    1.详细分析Java中的@RequestParam和@RequestBody
    2.@pathvariable 和 @Requestparam的详细区别)

这样,通过@Around注解和ProceedingJoinPoint,能够实现对带参数的自定义注解进行更灵活的处理。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DemoController {

    @LogExecutionTime(value = "Custom Message")
    @GetMapping("/demo")
    public String demoEndpoint(@RequestParam("param") String param) {
        // 模拟业务逻辑
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return "Demo endpoint executed with param: " + param;
    }
}

截图如下:

@around,Java,spring,java,后端文章来源地址https://www.toymoban.com/news/detail-847898.html

到了这里,关于详细分析Spring中的@Around注解(附Demo)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 写代码时遇到Run-Time Check Failure #2 - Stack around the variable str was corrupted. 错误的解决方法

    今天在写共享栈顶的简单应用时老是出现这样的错误,只好上网查其解决方案 关于上面错误的意思是指运行时检查失败  - 变量 str(这里是指你自己定义的变量 周围的堆栈已损坏。   注:就是在程序控制窗口输出的内容为汉字(也有可能会出现代码直接跳转到如图底第35行

    2024年02月11日
    浏览(41)
  • 【关于[C]报错:Run-Time Check Failure #2 - Stack around the variable ‘xxx‘ was corrupted的示例及解决办法】

      在我们编写c语言程序时,尤其是使用数组进行编写时,通常会遇到一种令我们猝不及防的报错: Run-Time Check Failure #2 - Stack around the variable ‘xxx‘ was corrupted,如图:     相信很多小伙伴遇到这个问题时都会和当时的我一样懵,奇葩的是这个程序明明可以成功运行且结果无

    2024年02月04日
    浏览(40)
  • 详细分析Python中的Pyautogui库(附Demo)

    该博客主要以入门了解其函数为主,灵活运用,后续会出一些实战结合类! PyAutoGUI 是 Python 的一个库,用于实现自动化的图形用户界面 (GUI) 操作 允许编写 Python 脚本来 控制鼠标、键盘和屏幕 ,从而实现 自动化任务,如自动化测试、模拟用户交互、批量处理等 主要概念和作

    2024年04月24日
    浏览(27)
  • 详细分析SpringSecurity中的@PreAuthorize注解

    在Java中, @PreAuthorize 是Spring Security框架中的一个注解,用于在方法调用之前对用户的权限进行验证。 允许在方法级别定义访问控制规则,确保只有满足指定条件的用户才能调用该方法 这个注解通常与Spring的AOP(面向切面编程)结合使用,推荐阅读: Spring框架从入门到学精(

    2024年04月28日
    浏览(32)
  • 详细分析python中的 async 和 await(附Demo)

    对于异步的基本知识推荐阅读我之前的文章: 详细讲解Python中的aioschedule定时任务操作 java关于@Async异步调用详细解析附代码 【操作系统】线程与进程的深入剖析(全) 【操作系统】守护线程和守护进程的区别 在Python中, async 和 await 是用于异步编程的,引入了异步

    2024年04月28日
    浏览(33)
  • flex布局——align-items属性垂直之共有flex-start、center、flex-end& justify-content属性水平之space-around、space-between

    flex布局——align-items属性垂直之共有flex-start、center、flex-end justify-content属性水平之space-around、space-between 对容器进行display: flex布局之后,可通过justify-content来调整容器中子元素整体的布局的位置,其值分别有如下几个: 注:以下情况均由主轴为从左到右方向进行,其从下到

    2024年01月19日
    浏览(42)
  • 基于Spring注解 + MyBatis + Servlet 实现数据库交换的小小Demo

    配置数据库连接信息 db.properties 配置web.xml 配置logback.xml配置文件 配置applicationContext.xml 里面的bean 配置myBatis核心配置文件mybatis-config.xml 创建实体类对象User 创建LoginServlet响应前端的数据 创建UserService 接口 创建UserMapper接口 创建UserServiceImpl 接口实现类 按照这样的方式进行拼接

    2024年02月02日
    浏览(80)
  • 详细分析Java中的@RequestParam和@RequestBody

    该知识点主要来源于SpringMVC:SpringMVC从入门到精通(全) 慢慢作为一名全栈,偶尔看项目使用 @RequestParam 或者 @RequestBody ,对此需要做一个深度的总结,防止混淆 @RequestParam 注解用于从HTTP请求中提取查询参数或表单参数。 其中一些常用的属性参数包括 name 、 defaultValue 和 r

    2024年04月26日
    浏览(36)
  • 详细分析Java中的Optional类以及应用场景

    在实战中学习,灵活运用每个操作类,具体如下: 源码主要如下: 大致含义如下: 这是一个容器对象,可能包含或不包含非空值。如果有值存在,isPresent() 方法将返回 true,而 get() 方法将返回该值。 提供了一些依赖于包含值的存在或缺失的其他方法,例如 orElse()(如果值不

    2024年04月27日
    浏览(43)
  • Spring 中的 @ConditionalOnProperty 注解

    介绍@ConditionalOnProperty注解的主要目的。 通常,在开发基于Spring的应用程序时,可能需要根据配置属性的存在和值有条件地创建一些bean。 例如,取决于是否将属性值设置为“ prod”或“ test”,可能想要注册一个DataSource bean来指向生产或测试数据库。 幸运的是,实现这一目标

    2024年02月16日
    浏览(37)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包