Java 中注解怎么结合拦截器实现请求日志记录-java教程-PHP中文网

在Spring Boot中，通过自定义@LogRequest注解与HandlerInterceptor拦截器实现按需请求日志记录：注解控制是否记录请求体/响应体，拦截器在preHandle和afterCompletion中读取注解并记录URI、IP、耗时、状态码等信息，需配合ContentCachingRequestWrapper确保请求体可重复读。

java 中注解怎么结合拦截器实现请求日志记录

在 Java Web 项目中（尤其是 Spring Boot），用自定义注解 + 拦截器实现请求日志记录，是一种灵活、低侵入的方式。核心思路是：定义一个注解标记需要记录日志的接口，拦截器在执行前/后读取该注解并决定是否记录请求和响应信息。

1. 定义日志记录注解

创建一个运行时保留、可作用于方法的自定义注解：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogRequest {
    String value() default "request"; // 可选描述
    boolean includeRequestBody() default true;
    boolean includeResponseBody() default false;
}

这个注解用于 Controller 方法上，控制日志粒度（比如是否打印请求体、响应体）。

2. 编写日志拦截器

继承 HandlerInterceptor，在 preHandle 和 afterCompletion 中分别记录请求开始和结束（含耗时、状态码等）。关键点是通过反射获取目标方法上的 @LogRequest 注解：

public class RequestLogInterceptor implements HandlerInterceptor {
    private static final Logger log = LoggerFactory.getLogger(RequestLogInterceptor.class);
<pre class="brush:php;toolbar:false;">@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    if (handler instanceof HandlerMethod) {
        HandlerMethod method = (HandlerMethod) handler;
        LogRequest logRequest = method.getMethodAnnotation(LogRequest.class);
        if (logRequest != null) {
            long startTime = System.currentTimeMillis();
            request.setAttribute("logStartTime", startTime);
            String uri = request.getRequestURI();
            String methodType = request.getMethod();
            String clientIP = getClientIP(request);

            log.info("[REQ-BEGIN] {} {} | IP: {} | Params: {}", methodType, uri, clientIP, getParams(request));

            if (logRequest.includeRequestBody()) {
                String body = getRequestBody(request);
                if (body != null && !body.trim().isEmpty()) {
                    log.debug("[REQ-BODY] {}", body);
                }
            }
        }
    }
    return true;
}

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    if (handler instanceof HandlerMethod) {
        HandlerMethod method = (HandlerMethod) handler;
        LogRequest logRequest = method.getMethodAnnotation(LogRequest.class);
        if (logRequest != null) {
            long startTime = (Long) request.getAttribute("logStartTime");
            long cost = System.currentTimeMillis() - startTime;
            int status = response.getStatus();
            String uri = request.getRequestURI();

            log.info("[REQ-END] {} | Status: {} | Cost: {}ms", uri, status, cost);

            if (logRequest.includeResponseBody() && response.getStatus() == HttpStatus.OK.value()) {
                // 注意：response body 需要包装 HttpServletResponseWrapper 才能读取（见下文）
            }
        }
    }
}

private String getClientIP(HttpServletRequest request) {
    String ip = request.getHeader("X-Forwarded-For");
    if (ip == null || ip.isEmpty() || "unknown".equalsIgnoreCase(ip)) {
        ip = request.getRemoteAddr();
    }
    return ip;
}

private String getParams(HttpServletRequest request) {
    return request.getParameterMap().entrySet().stream()
            .map(e -> e.getKey() + "=" + Arrays.toString(e.getValue()))
            .collect(Collectors.joining(", "));
}

private String getRequestBody(HttpServletRequest request) {
    try {
        return new BufferedReader(new InputStreamReader(request.getInputStream()))
                .lines().collect(Collectors.joining("\n"));
    } catch (IOException e) {
        return "[Cannot read body]";
    }
}

}

注意：直接读取 request.getInputStream() 在某些容器（如 Tomcat）中只能读一次，后续 Controller 就会读不到。生产环境建议使用 ContentCachingRequestWrapper 包装 request（Spring 提供），并在拦截器中提前缓存。

3. 注册拦截器并启用

配置类中注册拦截器，指定拦截路径（如所有 API 接口）：

deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文，推断业务需求，进行多维度评分和分类汇总，生成完整PRD文档。包含细粒度Java代码审查清单（Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载

@Configuration
public class WebConfig implements WebMvcConfigurer {
<pre class="brush:php;toolbar:false;">@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new RequestLogInterceptor())
            .excludePathPatterns("/actuator/**", "/swagger-ui/**")
            .addPathPatterns("/api/**"); // 只对 /api 下接口生效
}

}

4. 在 Controller 方法上使用注解

只需在需要记录日志的方法上添加 @LogRequest 即可：

@RestController
@RequestMapping("/api/users")
public class UserController {
<pre class="brush:php;toolbar:false;">@GetMapping("/{id}")
@LogRequest(includeRequestBody = false, includeResponseBody = true)
public User getUser(@PathVariable Long id) {
    return new User(id, "Alice");
}

@PostMapping
@LogRequest // 默认全开
public Result<user> createUser(@RequestBody User user) {
    return Result.success(userService.create(user));
}</user>

}

这样就做到了按需开启、职责分离：注解声明“要不要记”，拦截器负责“怎么记”。

不复杂但容易忽略的是请求体/响应体的可重复读问题——务必用 ContentCachingRequestWrapper 和自定义 ContentCachingResponseWrapper 包装原始对象，否则可能丢数据或报错。这部分可封装成工具类复用。