Spring Boot基于事件實現接口請求的性能監控

作者：一安 2025-01-08 09:35:55

在Spring?框架中，監控接口請求的性能可以通過ServletRequestHandledEvent事件實現。這種方法簡單有效，能夠幫助開發者實時跟蹤和分析請求的性能。

前言

在Spring框架中，監控接口請求的性能可以通過ServletRequestHandledEvent事件實現。這種方法簡單有效，能夠幫助開發者實時跟蹤和分析請求的性能。

它在請求處理完成后發布，包含了請求的詳細信息，如客戶端地址、請求URL、請求方法和處理時間。使用這個事件可以輕松地監控和記錄每個請求的性能數據。

實現步驟

創建監聽器類

@Component
public class TimeCountListener implements ApplicationListener<ServletRequestHandledEvent> {

  @Override
  public void onApplicationEvent(ServletRequestHandledEvent event) {
    Throwable failureCause = event.getFailureCause();
    if (failureCause != null) {
      System.err.printf("錯誤原因: %s%n", failureCause.getMessage());
    }
    System.err.println("========================================");
    System.err.printf("請求客戶端地址：%s\n請求URL: %s\n請求Method: %s\n請求耗時: %d毫秒%n", 
        event.getClientAddress(),
        event.getRequestUrl(), 
        event.getMethod(), 
        event.getProcessingTimeMillis());
    System.err.println("========================================");
  }
}

優點：

簡單易用：無需對業務代碼進行侵入式修改，只需創建監聽器類。
準確性高：Spring會在請求處理完成后發布事件，記錄的時間較為準確。
低侵入性：與業務邏輯代碼解耦，易于維護和擴展。

缺點：

性能開銷：盡管開銷較小，但記錄和處理事件仍然會增加系統的負擔。
事件丟失：在高并發或系統異常情況下，事件可能會丟失或記錄不全。

其他方案

自定義攔截器可以用來在請求處理的不同階段（如請求前、請求后、請求完成后）添加額外的邏輯。

public class PerformanceInterceptor implements HandlerInterceptor {

    private static final Logger logger = LoggerFactory.getLogger(PerformanceInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        request.setAttribute("startTime", System.currentTimeMillis());
        returntrue;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        long startTime = (Long) request.getAttribute("startTime");
        long endTime = System.currentTimeMillis();
        long executeTime = endTime - startTime;
        logger.info("請求URL: {}，耗時: {} ms", request.getRequestURI(), executeTime);
    }
}

責任編輯：武曉燕來源：一安未來

Spring 性能監控