
本文探讨了在Spring Boot应用中,当异常被全局`ExceptionHandler`捕获时,如何有效记录方法执行时间的问题。文章介绍了两种主要策略:一是利用Spring AOP在方法执行前后环绕,实现统一的执行时间测量和异常捕获;二是通过自定义异常类,在业务逻辑层捕获异常并封装执行时间,再由`ExceptionHandler`进行处理。这两种方法各有优势,可根据项目需求选择,旨在提供清晰、可维护的解决方案。
在开发基于Spring Boot的应用程序时,我们经常需要监控方法的执行时间,特别是在出现异常的情况下,了解异常发生时的耗时对于性能分析和问题排查至关重要。然而,当应用程序使用全局@ExceptionHandler来统一处理异常时,直接在业务方法内部捕获异常并记录时间,会使得代码变得冗余。本文将介绍两种在ExceptionHandler被调用时也能记录方法执行时间的专业方法。
Spring AOP(面向切面编程)提供了一种优雅的方式来处理横切关注点,如日志记录、性能监控和事务管理。通过定义一个切面,我们可以在不修改业务逻辑代码的情况下,在特定方法的执行前后插入逻辑。
首先,创建一个切面类,使用@Aspect和@Component注解,使其成为Spring管理的Bean。
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.time.Duration;
import java.time.Instant;
@Aspect
@Component
public class ExecutionTimeAspect {
private static final Logger logger = LoggerFactory.getLogger(ExecutionTimeAspect.class);
/**
* 定义一个切点,匹配所有在com.example.app.service包及其子包下的公共方法
* 实际应用中可根据需求调整切点表达式
*/
@Around("execution(public * com.example.app.service.*.*(..))")
public Object logExecutionTimeAndHandleException(ProceedingJoinPoint joinPoint) throws Throwable {
Instant start = Instant.now();
Object result;
try {
// 执行目标方法
result = joinPoint.proceed();
} catch (Exception e) {
Instant end = Instant.now();
long executionTimeMillis = Duration.between(start, end).toMillis();
logger.error("方法 {} 执行异常,耗时 {} ms. 异常信息: {}",
joinPoint.getSignature().toShortString(),
executionTimeMillis,
e.getMessage(),
e);
// 重新抛出异常,以便ExceptionHandler能够捕获
throw e;
} finally {
// 无论是否发生异常,都会执行此处的逻辑
// 如果没有异常,在这里记录成功执行的时间
if (result != null) { // 简单判断,实际可能需要更复杂的逻辑
Instant end = Instant.now();
long executionTimeMillis = Duration.between(start, end).toMillis();
logger.info("方法 {} 成功执行,耗时 {} ms.",
joinPoint.getSignature().toShortString(),
executionTimeMillis);
}
}
return result;
}
}如果AOP对于你的特定场景过于宽泛,或者你希望在业务逻辑层更精细地控制异常信息和执行时间的传递,可以考虑使用自定义异常类来封装执行时间。
创建一个继承自RuntimeException的自定义异常类,包含一个字段来存储执行时间。
import java.time.Duration;
public class TimeMeasuredException extends RuntimeException {
private final Duration executionTime;
private final Throwable originalCause; // 用于存储原始异常
public TimeMeasuredException(Duration executionTime, Throwable originalCause) {
super("方法执行异常,耗时 " + executionTime.toMillis() + " ms", originalCause);
this.executionTime = executionTime;
this.originalCause = originalCause;
}
public Duration getExecutionTime() {
return executionTime;
}
public Throwable getOriginalCause() {
return originalCause;
}
}在可能抛出异常的业务方法中,使用try-catch块来捕获原始异常,并将其包装进TimeMeasuredException,同时记录执行时间。
import org.springframework.stereotype.Service;
import java.time.Duration;
import java.time.Instant;
@Service
public class MyBusinessService {
public String performComplexOperation() {
Instant start = Instant.now();
try {
// 模拟一些复杂的业务逻辑,可能抛出异常
if (Math.random() > 0.5) {
throw new IllegalArgumentException("随机参数错误!");
}
Thread.sleep(200); // 模拟耗时操作
return "操作成功完成";
} catch (Exception ex) {
Instant end = Instant.now();
Duration executionTime = Duration.between(start, end);
// 捕获原始异常,并抛出自定义的TimeMeasuredException
throw new TimeMeasuredException(executionTime, ex);
}
}
}在全局@RestControllerAdvice或@ControllerAdvice中,捕获TimeMeasuredException,然后从中提取执行时间和原始异常信息进行处理。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class GlobalExceptionHandler {
private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(TimeMeasuredException.class)
public ResponseEntity<ErrorResponse> handleTimeMeasuredException(TimeMeasuredException ex) {
// 从自定义异常中获取执行时间
long executionTimeMillis = ex.getExecutionTime().toMillis();
// 获取原始异常
Throwable originalCause = ex.getOriginalCause();
logger.error("请求处理异常,耗时 {} ms. 原始异常类型: {}, 消息: {}",
executionTimeMillis,
originalCause.getClass().getSimpleName(),
originalCause.getMessage(),
originalCause);
ErrorResponse errorResponse = new ErrorResponse(
HttpStatus.INTERNAL_SERVER_ERROR.value(),
"处理请求失败: " + originalCause.getMessage(),
executionTimeMillis + " ms"
);
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
// 也可以捕获所有Exception,然后检查是否是TimeMeasuredException的实例
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGenericException(Exception e) {
if (e instanceof TimeMeasuredException) {
return handleTimeMeasuredException((TimeMeasuredException) e);
}
// 处理其他未被TimeMeasuredException包装的通用异常
logger.error("发生未知异常: {}", e.getMessage(), e);
ErrorResponse errorResponse = new ErrorResponse(
HttpStatus.INTERNAL_SERVER_ERROR.value(),
"服务器内部错误",
"未知"
);
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
// 辅助类用于构建统一的错误响应
static class ErrorResponse {
public int status;
public String message;
public String executionTime;
public ErrorResponse(int status, String message, String executionTime) {
this.status = status;
this.message = message;
this.executionTime = executionTime;
}
}
}两种方法都能够实现在ExceptionHandler被调用时记录方法执行时间的需求,但适用场景略有不同:
选择Spring AOP:
选择自定义异常:
在实际项目中,可以根据团队的技术栈、项目规模和具体需求来选择最合适的方案。通常,对于广泛的性能监控,AOP是更推荐的选择;而对于特定业务场景下需要携带额外异常信息的,自定义异常则更为直观。无论选择哪种方式,目的都是为了提高代码的可维护性、可观测性,并为问题诊断提供更多有价值的数据。
以上就是Spring Boot中优雅地记录异常处理时的执行时间的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号