讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring Boot 项目怎么使用拦截器记录请求日志

浅墨姑娘_7819

浅墨姑娘_7819

发布时间:2026-10-08 13:18:14

|

892人浏览过

|

来源于php中文网

原创

Spring Boot 用 HandlerInterceptor 记录请求日志,核心是 preHandle 抓请求信息并生成 traceId 写入 MDC,afterCompletion 记响应状态与耗时,通过 WebMvcConfigurer 注册拦截器并排除非业务路径,配合 Logback 结构化输出含 traceId 的可检索日志。

spring boot 项目怎么使用拦截器记录请求日志

Spring Boot 项目用拦截器记录请求日志,核心是利用 HandlerInterceptor 在请求进入 Controller 前后捕获关键信息,并配合日志框架(如 Logback)输出结构化日志。重点不是“能不能记”,而是“记什么、怎么记得清、怎么查得快”——尤其要带上 traceId 实现链路追踪。

一、定义拦截器:抓取请求入口和出口信息

创建一个类实现 HandlerInterceptor,重点关注三个方法:

  • preHandle:记录请求 URI、HTTP 方法、请求头(如 User-Agent)、查询参数、Body 内容(需包装 request)、生成并存入 MDC 的 traceId
  • afterCompletion:记录响应状态码、耗时(用 System.currentTimeMillis() 差值)、异常信息(如有)
  • 不建议在 postHandle 中记录响应体,因为此时 ModelAndView 可能为空,且响应体尚未写入输出流;如需记录响应内容,应结合 ContentCachingResponseWrapper 或改用 Filter

二、注入 traceId 实现日志串联

单次请求的日志散落在不同线程或异步调用中,必须靠唯一标识串联。推荐做法:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载
  • 在 preHandle 中生成 UUID 或使用 org.springframework.util.IdGenerator 生成 traceId
  • 通过 MDC.put("traceId", traceId) 将其绑定到当前线程上下文(Logback 支持自动打印 MDC 字段)
  • 在 afterCompletion 中调用 MDC.clear() 避免线程复用导致日志污染
  • 若涉及异步(如 @Async),需手动将 MDC 内容传递至子线程(例如用 ThreadLocal 包装或借助 Logback 的 AsyncAppender 配置)

三、注册拦截器:让 Spring MVC 知道它该生效

不能只写类,必须显式注册。推荐方式是实现 WebMvcConfigurer 并重写 addInterceptors:

  • 新建配置类,@Configuration 注解
  • 重写 addInterceptors(InterceptorRegistry registry)
  • 用 registry.addInterceptor(你的拦截器实例).excludePathPatterns("/actuator/**", "/swagger-ui/**") 排除监控、文档等非业务路径
  • 注意:拦截器默认只作用于 Controller 层请求,静态资源、错误页、Actuator 端点等不会触发

四、日志格式适配:让输出可读又可查

在 logback-spring.xml 中配置 pattern,把 traceId、时间、级别、URI、耗时、状态码都打出来:

  • 示例 pattern:%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level [traceId:%X{traceId}] %logger{36} - URI:%X{uri} | Cost:%X{cost}ms | Status:%X{status}
  • 配合 LoggingEventCompositeJsonEncoder 输出 JSON 格式日志,方便 ELK(Elasticsearch + Logstash + Kibana)采集与检索
  • 敏感字段(如密码、token)务必脱敏,不要直接打印原始 Body

不复杂但容易忽略。关键是 traceId 要早生成、早放入 MDC、早清理,日志字段要对齐排查场景——比如出问题时,你第一眼想看的是哪个字段?就把它固定打在每行开头。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

更多
spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

591

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

1455

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

4546

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

436

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

640

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

385

2026.02.11

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

351

2026.02.12

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

306

2026.04.17

C++运算符基础入门
C++运算符基础入门

本专题详细讲解了C++运算符的类型、语法与使用方法,涵盖算术运算符、关系运算符、逻辑运算符、位运算符、赋值运算符、条件运算符及其他特殊运算符,并通过代码示例解析优先级与结合性。

0

2026.10.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn