SpringBoot使用Logbook记录HTTP请求响应日志

配置

下面的表格展示了可配置的选项：

配置示例

详细用法

所有的功能集成都需要一个 Logbook 实例来完成，它保存了所有的配置并将所有需要的组件连接在一起。你可以使用所有的默认值创建一个实例：

或者使用 LogbookBuilder 创建一个自定义的版本：

在使用 starter 时，我们只需要自定义相应的 Bean 即可。

策略

Logbook使用一个非常硬性的策略来执行请求/响应日志记录：

请求/响应分开记录

请求/响应尽快记录

请求/响应一起记录或不记录

从2.0版本开始，Logbook引入了一个新的策略模式为核心，它内置了部分策略：

BodyOnlyIfStatusAtLeastStrategy

StatusAtLeastStrategy

WithoutBodyStrategy

阶段

Logbook工作在几个不同的阶段：

条件

过滤

格式化

记录

每个阶段都由一个或多个可以自定义的接口完成。每个阶段都有一个合理的默认值。

条件

记录HTTP消息并且包含其body的代价是非常大的，所以禁用某些请求的日志记录非常有意义。一个常见的情景就是忽略一些不必要的请求，比如Spring Boot的Actuator端点。

定义一个条件非常简单，只需要编写一个 Predicate 来决定请求是否需要记录。当然，你也可以组合预定义的 Predicate ：

对与路径的包含和排除也可以通过设置 logbook.include 和 logbook.exclude 属性实现。

过滤

过滤的目的是防止记录HTTP请求和响应的某些敏感数据。这通常包括Authorization请求头，但也可以用于某些明文查询或表单参数，例如access_token和password。

Logbook支持不同类型的过滤器：

SpringBoot使用Logbook记录HTTP请求响应日志

QueryFilter ， PathFilter ， HeaderFilter 和 BodyFilter 能够满足绝大多数情况下的需求，对于更复杂的需求，可以使用 RequestFilter 和 ResponseFilter 。

关联

Logbook使用一个id来关联请求和响应，因为请求和响应通常位于日志文件中的不同位置。

在Spring Cloud应用中一般会集成Zipkin进行链路追踪，此时可以使用TraceId来关联请求和响应日志记录。

如果默认实现不满足你的需求，你可以提供一个自定义的实现：

格式化

格式化定义了如何把请求和响应转换为字符串的方式。格式化不会指定请求和响应的记录位置，这是由writer来完成的。

Writer

Writer定义了格式化后的请求和响应写入的位置。Logbook内置了三种实现：Logger，Stream和Chunking。

Logger

默认情况下，请求和响应使用了slf4j来进行日志记录，日志的级别为 trace 。你也可以自定义：

Stream

另一种实现方式是记录请求和响应到 PrintStream ，例如 System.out 或 System.err 。在生产环境中这是一个糟糕的选择，但有时对于短暂的本地开发和调试很有用。

Chunking

ChunkingSink 会把长的消息分割成较小的块，并且会委托给另一个sink将它们写入，只需要设置 logbook.write.chunk-size 属性即可。

Sink

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

整理的这些资料希望对Java开发的朋友们有所参考以及少走弯路，本文的重点是你有没有收获与成长，其余的都不重要，希望读者们能谨记这一点。

其实面试这一块早在第一个说的25大面试专题就全都有的。以上提及的这些全部的面试+学习的各种笔记资料，我这差不多来回搞了三个多月，收集整理真的很不容易，其中还有很多自己的一些知识总结。正是因为很麻烦，所以对以上这些学习复习资料感兴趣
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
理真的很不容易，其中还有很多自己的一些知识总结。正是因为很麻烦，所以对以上这些学习复习资料感兴趣
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！