当前位置：首页 > news >正文

【接口耗时】⭐️自定义拦截器实现接口耗时统计

news 来源：原创 2025/5/21 18:18:36

💥💥✈️✈️欢迎阅读本文章❤️❤️💥💥

🏆本篇文章阅读大约耗时三分钟。

⛳️motto：不积跬步、无以千里

📋📋📋本文目录如下：🎁🎁🎁

目录

前言

实现

测试

章末

前言

小伙伴们大家好，上篇文章在本地模拟了如何控制接口的负载，通过引入 Resilience4j 依赖实现，整体操作简单，并且不需要额外启动服务，文章链接如下：

【接口负载】✈️整合 Resilience4j 指定接口负载，避免过载_resilience4j 如果多个接口指定一个 api , 会判断成同一个吗-CSDN博客

在实际项目中有很多监控指标，比如接口请求整体耗时，针对请求耗时过长的接口，需要进行统计并优化，本文简单模拟下如何便捷实现接口耗时监控

实现

2.1 统计接口耗时这种需求，是针对全部接口的，所以不能对业务代码造成侵入，并且要统一监控，所以可以使用拦截器，自定义一个拦截器，具体的作用就是请求进来的前后统计下时间，然后统一格式输出，方便查看

2.2 整体流程如下

2.3 代码实现

拦截器方法体如下，简单看下内容：

1.包括初始化 ThreadLocal 对象，重写了 preHandle 方法和 afterCompletion 方法

2.请求进来后，对应的线程会先初始化一个 threadLocal 对象，之后调用执行 preHandle 方法，在这一步会往该线程的 threadLocal 对象中存放一个开始时间，之后去执行业务方法，执行结束后，会流转到 afterCompletion 方法中，这时会计算当前时间与开始时间的差值，如果超过指定范围打印一个 Warn 级别的日志

注：这里最后会手动调用 threadLocal 的 remove 方法释放占用，避免内存溢出风险

import lombok.extern.slf4j.Slf4j;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;

/**
 * @author HuangBenben 
 */
@Slf4j
@Component
public class RequestHeaderHandlerInterceptor implements HandlerInterceptor {
    // 为 ThreadLocal 提供初始值
    private final ThreadLocal<Map<String, Object>> contexts = ThreadLocal.withInitial(HashMap::new);

    private void set(String key, Object value) {
        contexts.get().put(key, value);
    }

    private Object get(String key) {
        return contexts.get().get(key);
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        long start = System.currentTimeMillis();
        set("Request_begin", start);
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) {
        try {
            Long start = (Long) get("Request_begin");
            if (start != null) {
                long time = System.currentTimeMillis() - start;
                StringBuilder sb = new StringBuilder();
                sb.append("接口：").append(request.getRequestURI()).append(" 耗时：").append(time);
                if (time > 1000) {
                    log.warn(sb.toString());
                } else {
                    log.info(sb.toString());
                }
            }
        } finally {
        contexts.remove();
        }
    }
}

拦截器创建好之后需要手动添加注册，保证生效

将自定义的拦截器对象注入之后，重写 addInterceptors 方法将其添加注册，并且指定该拦截器针对的请求地址，这里配置的全部请求

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @author HuangBenben 
 */
@Configuration
public class AutoWebMvcConfigurer implements WebMvcConfigurer {

    @Autowired
    private RequestHeaderHandlerInterceptor requestHeaderHandlerInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 添加自定义的拦截器
        registry.addInterceptor(requestHeaderHandlerInterceptor).addPathPatterns("/**");
    }
}