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

Spring Boot 中怎么记录 REST 接口请求日志

星丽小哥_5428

星丽小哥_5428

发布时间:2026-10-22 06:18:31

|

223人浏览过

|

来源于php中文网

原创

Spring Boot记录REST接口日志有Filter、HandlerInterceptor、AOP和ClientHttpRequestInterceptor四种主流方案:Filter最底层可捕获全量请求响应体但需包装缓存;Interceptor位于MVC层适合记录URL、参数、IP、状态码等,但难获取原始body;AOP灵活支持注解标记与日志入库;ClientHttpRequestInterceptor用于记录出站HTTP请求日志。

spring boot 中怎么记录 rest 接口请求日志

Spring Boot 中记录 REST 接口请求日志,核心目标是捕获 请求路径、方法、参数、IP、耗时、状态码、响应体(可选) 等关键信息。方式不止一种,选哪种取决于你的需求粒度、是否要记录请求体、是否需入库、是否已有统一拦截体系。下面介绍几种主流且实用的方案。

用 Filter 记录全链路请求/响应日志

Filter 是最底层、最通用的方式,能拿到原始 HttpServletRequest 和 HttpServletResponse,适合记录完整请求上下文(包括流式 body)。但要注意:request.getInputStream() 和 response.getOutputStream() 只能读一次,需用 ContentCachingRequestWrapper 和 ContentCachingResponseWrapper 包装。

  • 继承 OncePerRequestFilter,避免异步或转发场景重复执行
  • 在 doFilterInternal 中包装 request/response,调用 filterChain.doFilter() 前后分别记录起始和结束信息
  • 用 getContentAsByteArray() 读取缓存的 body,转为字符串(注意编码和长度限制,敏感字段如密码需脱敏)
  • 耗时计算用 System.currentTimeMillis() 差值,状态码从 response 获取

用 HandlerInterceptor 拦截 Controller 层调用

Interceptor 运行在 Spring MVC 生命周期中,比 Filter 更“上层”,天然支持获取 handler 方法、参数绑定结果,但拿不到原始 request body 流(除非提前解析并缓存)。

JavaStoryDevelop
JavaStoryDevelop

你接手一个需求时,是不是经常这样:"改一个小字段 → 结果把不相关的代码也改了"、"需求说得很模糊 → 做着做着发现跑偏了"、"数据库加个字段 → 上线才发现漏了数据兼容"、"做了个新功能 → 一个月后自己都忘了当时怎么设计的"、"写到一半被中断 → 再回来不知道从哪继续";这个 Skill 就是专门解决这些问题的。 它会自动探测你的项目环境(JDK、Spring Boot、ORM、数据库、前端框架),记在

下载
  • 实现 HandlerInterceptor,重写 preHandle(记录 URL、method、query params、IP)和 afterCompletion(记录 status、costTime、异常信息)
  • 可通过 RequestContextHolder 获取当前 request,用 ServletRequestAttributes 提取参数
  • 不推荐在 postHandle 中记录响应体,因为 ModelAndView 对 @RestController 无效;响应体建议在 afterCompletion 阶段通过 response 输出流缓存获取(仍需包装)

用 AOP 切 Controller 方法执行过程

AOP 更灵活,适合按需标记(比如只对加了 @LogRequest 注解的方法记录),也便于与业务逻辑解耦、做日志入库等扩展。

  • 定义自定义注解(如 @LogRequest),标注在 Controller 方法上
  • 切面类用 @Around 拦截,通过 ProceedingJoinPoint 获取方法签名、参数值
  • 结合 RequestContextHolder 补充 IP、URL、method 等信息
  • 可将日志对象(如 RequestLog)存入数据库或发到消息队列,而非仅打到控制台
  • 注意:AOP 拦不到全局异常处理器(@RestControllerAdvice)处理的异常,需额外配合

给 RestTemplate 添加请求日志(调用方视角)

如果你的服务作为 HTTP 客户端调用第三方接口,也要记录出站请求日志,可用 ClientHttpRequestInterceptor。

  • 实现 ClientHttpRequestInterceptor,在 intercept 中打印 request URI、method、headers、body
  • 执行 execution.execute() 后,再读取 ClientHttpResponse 的 status、headers、body
  • 注册到 RestTemplate 实例:通过 setInterceptors 或配置 BeanPostProcessor
  • 注意 body 字节数组需指定编码(如 UTF-8),大响应体建议限长或开关控制

热门AI工具

更多
豆包大模型

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

Seko
Seko Hot

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

DeepSeek

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

相关专题

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

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

631

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 快速开发高效、稳定的企业级应用。

4986

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 后端服务架构。

371

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

326

2026.04.17

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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