SpringBoot优雅实现计算方法执行时间

 更新时间:2025年04月15日 08:37:43   作者:写bug写bug  
这篇文章主要为大家详细介绍了SpringBoot中优雅实现计算方法执行时间的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

计算方法执行时间是大多数后端应用程序中常见的非功能性需求。以下是一些计算执行时间的传统方法:

long startTime = (System.currentTimeMillis());
// 你的逻辑代码
long executionTime = (System.currentTimeMillis() - startTime) / 1000;
LOGGER.info("计算所花费的时间为:{} 秒", executionTime);

StopWatch watch = new StopWatch();
watch.start();
// 你的逻辑代码
watch.stop();
LOGGER.info("计算所花费的时间为:{} 秒", watch.getTotalTimeSeconds());

可以看到需要在每个需要计算执行时间的方法里增加相同的计算代码,这种统计代码执行时间的方式存在代码冗余、违反 DRY 原则、侵入性强等问题。

接下来让我们通过 AOP 来实现在方法顶部添加一个注解,就可以非常高效地计算所有方法的执行时间的功能。

步骤一:启用 Spring AOP

首先,通过在 POM.xml 中添加以下内容来启用 Spring AOP:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

步骤二:创建自定义注解

现在让我们在 Spring Boot 中创建一个名为 ExecutionTimeLogger 的自定义注解。可以看到,该注解在运行时起作用,并且适用于方法级别。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExecutionTimeLogger {
}

步骤三:创建切面类

创建一个作为切面的新类,包含计算方法执行时间的逻辑。在 Spring AOP 中有多种使用切面的方式,这里使用 @Around 注解。创建 ExecutionTimeLoggerAspect 类并使用 @Aspect 注解,再创建 executionTimeLogger 方法并添加 @Around 注解,将注解名称作为参数传递给 @Around,这样该方法会在带 ExecutionTimeLogger 注解的方法执行前后被调用:

@Aspect
@Component
publicclass ExecutionTimeLoggerAspect {
    static final Logger logger = LoggerFactory.getLogger(ExecutionTimeLoggerAspect.class);

    @Around("@annotation(ExecutionTimeLogger)")
    public Object executionTimeLogger(ProceedingJoinPoint joinPoint) {
        try {
            long startTime = System.currentTimeMillis();
            Object proceed = joinPoint.proceed();
            long executionTime = (System.currentTimeMillis() - startTime);
            logger.info("{}方法在{}毫秒内执行完毕", joinPoint.getSignature(), executionTime);
            return proceed;
        } catch (Throwable e) {
            logger.error("在计算{}方法执行时间时出错", joinPoint.getSignature(), e);
            return null;
        }
    }
}

步骤四:使用自定义注解

所有必需的配置都已完成。现在我们唯一需要做的就是在想要计算 Java 代码中方法执行时间的地方使用该注解。假设要计算方法的执行时间,如下面的代码所示。只需在方法顶部添加注解即可。

public class CustomLoggingService {
    @ExecutionTimeLogger
    public void myMethod() {
        try {
            Thread.sleep(20000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

步骤五:查看输出

当 myMethod 在你的代码中执行时的输出:

c.n.t.a.ExecutionTimeLoggerAspect|void com.main.project.CustomLoggingService.myMethod()方法在20毫秒内执行完毕

是不是很简单?想象一下节省了多少时间和精力。只需写一遍计算执行时间的代码,然后在需要计算执行时间的地方继续使用注解即可。

总结一下

1.创建自定义注解。

2.创建 @Aspect 类,包含计算执行时间的方法。

3.用 @Around 声明方法并指定为自定义注解执行。

4.在要记录执行时间的方法上加注解。

到此这篇关于SpringBoot优雅实现计算方法执行时间的文章就介绍到这了,更多相关SpringBoot计算方法执行时间内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java实现插入排序实例

    Java实现插入排序实例

    这篇文章主要介绍了Java实现插入排序,实例分析了Java的插入排序原理与实现技巧,非常具有实用价值,需要的朋友可以参考下
    2015-02-02
  • 5个JAVA入门必看的经典实例

    5个JAVA入门必看的经典实例

    这篇文章主要为大家详细介绍了5个JAVA入门必看的经典实例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10
  • Servlet文件的上传与下载详解

    Servlet文件的上传与下载详解

    很多朋友不清楚在Servlet中怎么上传下载文件,谈到这个问题,首先需要我们掌握开发servlet的步骤,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2022-06-06
  • Java switch 语句如何使用 String 参数

    Java switch 语句如何使用 String 参数

    这篇文章主要介绍了Java switch 语句如何使用 String 参数,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,,需要的朋友可以参考下
    2019-06-06
  • 如何解决Maven无法拉取SNAPSHOT依赖问题

    如何解决Maven无法拉取SNAPSHOT依赖问题

    在使用Maven管理项目时,可能会遇到无法拉取SNAPSHOT版本依赖的问题,这通常是因为Maven默认不支持直接拉取SNAPSHOT版本,遇到这样的问题,可以通过在项目的pom.xml文件中添加<repositories>标签,并配置启用SNAPSHOT的仓库地址来解决
    2024-10-10
  • SpringBoot集成Access DB实现数据导入和解析

    SpringBoot集成Access DB实现数据导入和解析

    microsoft office access是由微软发布的关联式数据库管理系统,它结合了 microsoft jet database engine 和 图形用户界面两项特点,是一种关系数据库工具,本文给大家介绍了SpringBoot集成Access DB实现数据导入和解析,需要的朋友可以参考下
    2024-11-11
  • 详解SpringBoot中Session超时原理说明

    详解SpringBoot中Session超时原理说明

    本篇文章主要介绍了详解SpringBoot中Session超时原理说明,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • Spring配置文件使用占位符配置方式

    Spring配置文件使用占位符配置方式

    这篇文章主要介绍了Spring配置文件使用占位符配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • MyBatis中SqlSession生命周期的使用

    MyBatis中SqlSession生命周期的使用

    SqlSession是MyBatis的核心接口之一,本文主要介绍了MyBatis中SqlSession生命周期的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-09-09
  • springboot 如何重定向redirect 并隐藏参数

    springboot 如何重定向redirect 并隐藏参数

    这篇文章主要介绍了springboot 如何重定向redirect 并隐藏参数的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09

最新评论