SpringBoot 统计接口调用耗时的多种方式

在实际开发中，了解项目中接口的响应时间是必不可少的事情。SpringBoot 项目支持监听接口的功能也不止一个，接下来我们分别以 AOP、ApplicationListener、Tomcat 三个方面去实现三种不同的监听接口响应时间的操作。

AOP

首先我们在项目中创建一个类 ，比如就叫 WebLogAspect ，然后在该类上加上 @Aspect 和 @Component 注解，声明是一个 Bean 并且是一个切面：

import org.aspectj.lang.JoinPoint;  
import org.aspectj.lang.ProceedingJoinPoint;  
import org.aspectj.lang.annotation.*;  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.stereotype.Component;  
import org.springframework.web.context.request.RequestContextHolder;  
import org.springframework.web.context.request.ServletRequestAttributes;  import javax.servlet.http.HttpServletRequest;  
import java.util.Date;  @Aspect  
@Component  
public class WebLogAspect {  private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);  // 定义一个切入点，拦截所有带有@RequestMapping注解的方法@Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")  public void webLog() {}  // 前置通知，在方法执行前记录请求信息  @Before("webLog()")  public void doBefore(JoinPoint joinPoint) {  ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();  HttpServletRequest request = attributes.getRequest();  // 记录请求信息  logger.info("请求开始：URL={}, IP={}, 方法={}", request.getRequestURL(), request.getRemoteAddr(), request.getMethod());  }  // 环绕通知，记录方法执行时间  @Around("webLog()")  public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {  long startTime = System.currentTimeMillis();  Object result = joinPoint.proceed(); // 继续执行被拦截的方法  long endTime = System.currentTimeMillis();  long executeTime = endTime - startTime;  // 记录执行时间  logger.info("请求结束：耗时={}ms", executeTime);  return result;  }  // 异常通知，在方法抛出异常时记录异常信息  @AfterThrowing(pointcut = "webLog()", throwing = "ex")  public void doAfterThrowing(JoinPoint joinPoint, Exception ex) {  ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();  HttpServletRequest request = attributes.getRequest();  // 记录异常信息  logger.error("请求异常：URL={}, 异常={}", request.getRequestURL(), ex.getMessage());  }  // 后置通知（返回通知），在方法正常返回后记录信息  @AfterReturning(returning = "retVal", pointcut = "webLog()")  public void doAfterReturning(JoinPoint joinPoint, Object retVal) {  // 你可以在这里记录返回值，但通常我们不记录，因为可能会包含敏感信息  // logger.info("请求返回：返回值={}", retVal);  }  
}

2024-06-19 17:49:37.373 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求开始：URL=http://localhost:18080/springboot/test1, IP=0:0:0:0:0:0:0:1, 方法=POST
2024-06-19 17:49:37.386 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求结束：耗时=13ms
2024-06-19 17:49:37.501 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求开始：URL=http://localhost:18080/springboot/test2, IP=0:0:0:0:0:0:0:1, 方法=POST
2024-06-19 17:49:37.516 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求结束：耗时=15ms
2024-06-19 17:49:37.905 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求开始：URL=http://localhost:18080/springboot/test3, IP=0:0:0:0:0:0:0:1, 方法=POST
2024-06-19 17:49:37.913 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求结束：耗时=8ms

优点：

  • 全局性：可以在不修改业务代码的情况下，对全局范围内的接口进行执行时间的记录。
  • 灵活性：可以根据需要灵活定义哪些接口需要记录执行时间。
  • 精确性：可以精确记录从方法开始执行到结束的时间。

缺点：

  • 配置复杂性：AOP配置可能相对复杂，特别是对于初学者来说。
  • 性能开销：虽然性能开销通常很小，但在高并发场景下仍然需要考虑，并且它是会阻塞主线程的。

**常用性：**在Spring框架中，AOP是一个强大的工具，用于实现诸如日志记录、事务管理等横切关注点。因此，使用AOP记录接口执行时间是一种非常常见和推荐的做法。

ApplicationListener

首先我们在项目中创建一个类 ，比如就叫 TakeTimeCountListener，然后实现 ApplicationListener 接口：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
import org.springframework.web.context.support.ServletRequestHandledEvent;@Component
public class TakeTimeCountListener implements ApplicationListener<ServletRequestHandledEvent> {public final Logger logger = LoggerFactory.getLogger(this.getClass());@Overridepublic void onApplicationEvent(ServletRequestHandledEvent event) {Throwable failureCause = event.getFailureCause() ;if (failureCause != null) {logger.warn("错误原因: {}", failureCause.getMessage());}// 比如我这里只记录接口响应时间大于1秒的日志if (event.getProcessingTimeMillis() > 1000) {logger.warn("请求客户端地址：{}, 请求URL: {}, 请求Method: {}, 请求耗时:{} ms",event.getClientAddress(),event.getRequestUrl(),event.getMethod(),event.getProcessingTimeMillis());}}
}

2024-06-19 17:14:59.620 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求客户端地址：0:0:0:0:0:0:0:1, 请求URL: /springboot/test1, 请求Method: GET, 请求耗时:51 ms
2024-06-19 17:14:59.716 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求客户端地址：0:0:0:0:0:0:0:1, 请求URL: /springboot/test2, 请求Method: GET, 请求耗时:136 ms
2024-06-19 17:14:59.787 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求客户端地址：0:0:0:0:0:0:0:1, 请求URL: /springboot/test3, 请求Method: POST, 请求耗时:255 ms
2024-06-19 17:14:59.859 [TID: N/A] WARN  [com.springboot.demo.TakeTimeCountListener] 请求客户端地址：0:0:0:0:0:0:0:1, 请求URL: /springboot/test4, 请求Method: POST, 请求耗时:167 ms

优点：

  • 集成性：与Spring MVC框架紧密集成，无需额外配置。
  • 性能：改方法是不会阻塞主线程的，也就是说 该方法在处理的时候，controller 已经正常返回了，可以通过在该方法进行断点调试来验证。
  • 简单易用：实现ApplicationListener接口并监听ServletRequestHandledEvent事件即可。

缺点：

  • 适用范围：主要适用于Spring MVC 框架下的 Web 请求，对于非 Web 接口（如RESTful API）可能不适用。
  • 精度：只能记录整个请求的处理时间，无法精确到具体的方法执行时间。

**常用性：**在Spring MVC应用中，使用ApplicationListener来记录请求处理时间是一种常见做法，但通常用于监控和性能分析，而不是精确记录接口执行时间。

Tomcat

Tomcat 的实现很简单，只需要开启它本身就支持的访问日志就可以了 ，在 SpringBoot 中，我们可以在 properties 或 yaml 文件中增加下面配置：

# 启用Tomcat访问日志
server.tomcat.accesslog.enabled=true  
# 启用缓冲模式，日志会先写入缓冲区，然后定期刷新到磁盘 
server.tomcat.accesslog.buffered=true  
# 指定日志存储目录，这里是相对于项目根目录的logs文件夹  
server.tomcat.accesslog.directory=logs 
# 定义日志文件名的日期格式
server.tomcat.accesslog.file-date-format=.yyyy-MM-dd 
# 定义日志记录的格式  
# 各个字段的意义：  
# %{X-Forwarded-For}i: 请求头中的X-Forwarded-For，通常用于记录客户端真实IP  
# %p: 本地端口  
# %l: 远程用户，通常为'-'  
# %r: 请求的第一行（例如：GET / HTTP/1.1）  
# %t: 请求时间（格式由日志处理器决定）  
# 注意：这里有一个重复的%r，可能是个错误，通常第二个%r不需要  
# %s: HTTP状态码  
# %b: 响应字节数，不包括HTTP头，如果为0则不输出  
# %T: 请求处理时间（以秒为单位）  
server.tomcat.accesslog.pattern=%{X-Forwarded-For}i %p %l %r %t %r %s %b %T
# 日志文件名前缀  
server.tomcat.accesslog.prefix=localhost_access_log
# 日志文件名后缀  
server.tomcat.accesslog.suffix=.log

server:  tomcat:  accesslog:  enabled: true  # 启用Tomcat访问日志buffered: true  # 启用缓冲模式，日志会先写入缓冲区，然后定期刷新到磁盘 directory: logs  # 指定日志存储目录，这里是相对于项目根目录的logs文件夹  file-date-format: ".yyyy-MM-dd"   # 定义日志文件名的日期格式pattern: "%{X-Forwarded-For}i %p %l %r %t %s %b %T"  # 定义日志记录的格式   prefix: localhost_access_log   # 日志文件名前缀  suffix: .log # 日志文件名后缀

- 8080 - - [19/Jun/2024:00:00:09 +0800] GET /springboot/test1 HTTP/1.1 200 92 0.247 Ignored_Trace
- 8080 - - [19/Jun/2024:00:00:09 +0800] GET /springboot/test2 HTTP/1.1 200 92 0.247 Ignored_Trace
- 8080 - - [19/Jun/2024:09:49:55 +0800] POST /springboot/test3 HTTP/1.1 200 291556 0.314 Ignored_Trace

优点：

  • 集成性：Tomcat 内置功能，无需额外代码或配置。
  • 全面性：记录所有通过 Tomcat 处理的请求和响应信息。

缺点：

  • 性能：访问日志可能会对 Tomcat 性能产生一定影响。
  • 精度：同样只能记录整个请求的处理时间，无法精确到具体的方法执行时间。
  • 配置复杂性：对于复杂的日志格式或需求，可能需要修改 Tomcat 的配置文件。

**常用性：**Tomcat 的访问日志通常用于监控 Web 服务器的访问情况，如 IP 地址、请求路径、HTTP 状态码等。虽然它可以记录请求处理时间，但通常不会用于精确的性能分析或接口执行时间记录。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/bicheng/30156.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

▶《强化学习的数学原理》(2024春)_西湖大学赵世钰 Ch4 值迭代 与 策略迭代 【动态规划 算法】

▶《强化学习的数学原理》(2024春)_西湖大学赵世钰 Ch4 值迭代 与 策略迭代 【动态规划 算法】

PPT 截取必要信息。 课程网站做习题。总体 MOOC 过一遍 1、视频 学堂在线 习题 2、过 电子书 补充 【下载&#xff1a; 本章 PDF 电子书 GitHub】 [又看了一遍视频。原来第一次跳过了好多内容。。。] 3、总体 MOOC 过一遍 习题 学堂在线 课程页面链接 中国大学MOOC 课程页面链…
阅读更多...
科技创新对农业发展的影响

科技创新对农业发展的影响

科技创新对农业发展的影响深远且广泛&#xff0c;主要体现在以下几个方面&#xff1a; 一、提高农业生产效率 引入先进的农业机械设备&#xff1a;新型农业机械设备如无人机、机器人等的应用&#xff0c;显著减轻了农民的劳动强度&#xff0c;提高了农作物的种植效率。利用精…
阅读更多...
上市公司-社会责任报告、ESG报告文本（2006-2023年）

上市公司-社会责任报告、ESG报告文本（2006-2023年）

上市公司社会责任报告是企业对外公布的一份关于其社会责任实践和成果的详细文件&#xff0c;涵盖环境保护、社会贡献和公司治理等方面的表现。通常包含公司在减少环境影响、提升社会福祉、维护员工权益、促进社区发展以及确保透明和道德的管理实践等方面的信息和数据。有助于了…
阅读更多...
浅谈Java23种设计模式之11种行为型模式的使用场景(第二部分)

浅谈Java23种设计模式之11种行为型模式的使用场景(第二部分)

前言: 行为型设计模式实际使用场景第二部分; 1.中介者模式&#xff08;Mediator&#xff09; 概念: 它定义了一个中介类来封装一系列对象之间的交互&#xff0c;从而使各个对象不需要显式地相互引用&#xff0c;降低耦合度&#xff0c;提高系统的可维护性和扩展性。中介者模…
阅读更多...
滑动窗口练习1-长度最小的子数组

滑动窗口练习1-长度最小的子数组

1.题目链接&#xff1a;209.长度最小的子数组 2.题目描述&#xff1a; 给定一个含有 n 个正整数的数组和一个正整数 target 。 找出该数组中满足其总和大于等于 target 的长度最小的 子数组 [numsl, numsl1, ..., numsr-1, numsr] &#xff0c;并返回其长度。如果不存在符合条…
阅读更多...
聊聊分布式集群的基本概念

聊聊分布式集群的基本概念

在当前主流的分布式架构中，各种各样的集群技术几乎成了任何想要提升系统稳定性和处理能力的团队的必备技能。虽然各种中间件和系统都有让人看似眼花缭乱的集群实现方案，但其背后仍然逃不过一些核心的技术概念，我会结合几个我比较熟悉的中间件，简单聊一下我对集群的理解： …
阅读更多...
zlib安装教程（Windows）

zlib安装教程（Windows）

开源项目地址&#xff1a;madler/zlib: A massively spiffy yet delicately unobtrusive compression library. (github.com) 下载代码 可以选择git clone 或直接下载release包 Releases madler/zlib (github.com) git clone https://github.com/madler/zlib.git release…
阅读更多...
【Android面试八股文】Kotlin内置标准函数with的原理是什么？

【Android面试八股文】Kotlin内置标准函数with的原理是什么？

文章目录 原理和实现方式应用场景总结 with 是 Kotlin 标准库中的一个内置函数&#xff0c;其主要目的是简化对某个对象实例执行多个操作的代码。它的原理和实现方式如下&#xff1a; 原理和实现方式 with的源码定义如下&#xff1a; /*** Calls the specified function [blo…
阅读更多...
被拷打已老实！面试官问我 #{} 和 ${} 的区别是什么？

被拷打已老实！面试官问我 #{} 和 ${} 的区别是什么？

引言&#xff1a;在使用 MyBatis 进行数据库操作时&#xff0c;#{} 和 ${} 的区别是面试中常见的问题&#xff0c;对理解如何在 MyBatis 中安全有效地处理 SQL 语句至关重要。正确使用这两种占位符不仅影响应用的安全性&#xff0c;还涉及到性能优化。 题目 被拷打已老实&…
阅读更多...
GRU基础知识以及相关名词解释

GRU基础知识以及相关名词解释

当然&#xff0c;GRU&#xff08;Gated Recurrent Unit&#xff0c;门控循环单元&#xff09;是一种改进的循环神经网络&#xff08;RNN&#xff09;结构&#xff0c;它引入了门控机制来更好地控制信息的流动&#xff0c;从而解决了传统RNN在处理长序列数据时存在的梯度消失和梯…
阅读更多...
2024-06-19，面试官问的问题

2024-06-19，面试官问的问题

文章目录 1、采用minIO完成了图片存储&#xff0c;采用阿里云OSS服务器存储图片这两个功能面试官理解为重复&#xff0c;面试官又问minIO怎么同步到OSS&#xff1f;2、讲一下ThreadLocal&#xff1f;3、为什么用ThreadLocal存数据&#xff1f;4、redis有几种数据结构&#xff1…
阅读更多...
零成本！无需服务器，搭建你的图床！

零成本！无需服务器，搭建你的图床！

先给大家看看成品&#xff1a; 访问地址&#xff1a;http://cp64mba5g6h48vl4is50.app.memfiredb.cn/ 这是我花十分钟做出来的零成本&#xff0c;不需要服务器的图床&#xff0c;不需要登录&#xff0c;任何人都可以在上面上传图片和拿到图片链接去使用&#xff0c;当然这只…
阅读更多...
【Java面试】二十一、JVM篇（中）：垃圾回收相关

【Java面试】二十一、JVM篇（中）：垃圾回收相关

文章目录 1、类加载器1.1 什么是类加载器1.2 什么是双亲委派机制 2、类装载的执行过程&#xff08;类的生命周期&#xff09;3、对象什么时候可以被垃圾回收器处理4、JVM垃圾回收算法4.1 标记清除算法4.2 标记整理算法4.3 复制算法 5、分代收集算法5.1 MinorGC、Mixed GC、Full…
阅读更多...
大数据的发展，带动电子商务产业链，促进了社会的进步【电商数据采集API接口推动电商项目的源动力】

大数据的发展，带动电子商务产业链，促进了社会的进步【电商数据采集API接口推动电商项目的源动力】

最近几年计算机技术在诸多领域得到了有效的应用&#xff0c;同时在多方面深刻影响着我国经济水平的发展。除此之外&#xff0c;人民群众的日常生活水平也受大数据技术的影响。 在这其中电子商务领域也在大数据技术的支持下&#xff0c;得到了明显的进步。虽然电子商务领域的发…
阅读更多...
网页钓鱼-克隆修改--劫持口令下载后门

网页钓鱼-克隆修改--劫持口令下载后门

免责声明:本文仅做技术交流与学习... 目录 1-右键另存为 2-goblin项目(不推荐) 修改goblin.yaml文件 运行exe ​编辑 3-Setoolkit (kali自带) 网页克隆---> 1-右键另存为 --不行就再定位元素进行修改. 2-goblin项目(不推荐) GitHub - xiecat/goblin: 一款适用于红蓝…
阅读更多...
Spring Boot 增删改查（mybatis-plus）

Spring Boot 增删改查（mybatis-plus）

在GitHub上已经开源&#xff0c;有全部源码&#xff0c;有问题可以在GitHub上提问https://github.com/sky41/MySQL.git 1、创建(User) 实体类 package com.my.mysql.entity; import lombok.*; Setter Getter Data NoArgsConstructor //AllArgsConstructor public …
阅读更多...
云原生安全联防联抗策略玩转微隔离

云原生安全联防联抗策略玩转微隔离

前言 随着信息技术的发展、互联网的快速普及&#xff0c;越来越多的信息被存储在云端&#xff0c;企业面临的安全问题也日益突出。在《网络安全法》、《数据安全法》等多部法律法规要求下&#xff0c;各行业用户纷纷设立安全部门。不管安全部门里是“一人当关”还是“三三两两…
阅读更多...
PCB AVI品质报告采集工具

PCB AVI品质报告采集工具

AVI设备,品质报告. 可以通过: 过滤文件名指定文件名 排除多余的日志;运行日志为增量日志,可采用增量模式;品质报告可设置采集后删除; 下载: Gitee下载 最新版本 优势: A. 开箱即用. 解压直接运行.不需额外安装. B. 批管理设备. 设备配置均在后台管理. C. 无人值守 客户端自…
阅读更多...
lammps聚合物建模组合技巧

lammps聚合物建模组合技巧

大家好，我是小马老师。 本文介绍聚合物结构的组合问题。 在lammps模拟中，聚合物模拟应该算是比较复杂的一种模拟，不仅建模复杂、势参数较多，而且在模拟过程中也会经常出现各种意想不到的错误。 本文主要解决聚合物建模过程中常遇到的一个问题：多成分的组合。 比如下面的结…
阅读更多...
什么是分布式架构？

什么是分布式架构？

一、分布式架构的概念&#xff1a; 分布式架构是现代软件工程中一个非常核心的概念&#xff0c;特别是在互联网、大数据和云计算领域。分布式架构指的是将一个应用程序分解为多个相互协作的组件或服务&#xff0c;这些组件或服务运行在不同的计算机或服务器上&#xff0c;通常…
阅读更多...
最新文章

Copyright @ 2022~2023