Spring Boot 中 Logback 日志输出对齐实践

SLF4J 与日志实现的解耦

首先，需要明确 slf4j (simple logging facade for java) 并非一个具体的日志实现框架，而是一个日志门面（facade/abstraction）。它的主要作用是提供一套统一的 api 接口，允许开发者在不绑定特定日志框架的情况下编写日志代码。在运行时，slf4j 会桥接到实际的日志实现框架，如 logback、log4j2 或 java.util.logging 等。

在 Spring Boot 应用中，默认集成的日志实现是 Logback。这意味着，虽然我们在代码中使用 org.slf4j.Logger 进行日志记录，但实际的日志格式化和输出是由 Logback 负责的。因此，要调整日志的输出格式，我们需要配置 Logback。

Logback 日志模式格式化基础

Logback 通过其模式布局（PatternLayout）来定义日志的输出格式。在 Spring Boot 中，通常通过 application.properties 或 application.yml 文件中的 logging.pattern.console 属性来配置控制台日志的输出模式。

原始问题中使用的模式是：

logging.pattern.console=%c{1}           --- %m%n

这里：

• %c{1}：表示输出日志记录器（Logger）的名称，{1} 表示只显示全限定类名的最后一个组件（例如 d.e.e.s.SmallService 会显示为 SmallService）。
• ---：一个固定的分隔符。
• %m：表示日志消息本身。
• %n：表示换行符。

然而，这种简单的模式并不能保证 --- 分隔符的对齐，因为 %c{1} 输出的类名长度是可变的。

实现日志对齐的关键：宽度与对齐修饰符

为了实现日志输出的对齐，我们需要利用 Logback 模式格式化中的宽度和对齐修饰符。这些修饰符允许我们为输出的各个部分指定最小宽度、最大宽度以及对齐方式（左对齐或右对齐）。

Logback 的格式修饰符通常以 %- 或 % 开头，后跟可选的宽度和精度修饰符，再跟转换字符。

• - (左对齐): 默认情况下，如果输出内容小于指定宽度，会右对齐并用空格填充左侧。使用 - 会使内容左对齐，并用空格填充右侧。
• min.max (最小宽度.最大宽度):
  • min: 指定输出的最小宽度。如果内容短于此宽度，将用空格填充。
  • max: 指定输出的最大宽度。如果内容长于此宽度，将从开头截断。如果希望从末尾截断，可以使用 max 而不指定 min，例如 %.20c。

为了使 --- 对齐，我们需要确保 %c{1} 部分始终占据一个固定的宽度。

标书对比王

标书对比王是一款标书查重工具，支持多份投标文件两两相互比对，重复内容高亮标记，可快速定位重复内容原文所在位置，并可导出比对报告。

58

查看详情

示例代码与详细解析

假设我们希望类名部分最多占据 28 个字符，并且左对齐，如果不足 28 字符则用空格填充右侧。如果超过 28 字符，则从开头截断。我们可以这样修改 logging.pattern.console：

修改后的 application.properties 配置：

logging.pattern.console=%-28.28c{1} --- %m%n

解析：

• %: 引入转换字符。
• -: 指示左对齐。这意味着如果 %c{1} 输出的字符串长度小于 28，会在其右侧填充空格。
• 28: 最小宽度。无论 %c{1} 的实际输出长度是多少，它都将至少占用 28 个字符的空间。
• .28: 最大宽度。如果 %c{1} 的实际输出长度超过 28 个字符，它将从开头被截断，只保留最后 28 个字符。例如，d.e.e.Eva04p2Beanlifecycle 可能会被截断为 e.Eva04p2Beanlifecycle。对于 c{1} 这种只显示最后一部分的，这意味着如果 Eva04p2Beanlifecycle 本身超过 28 字符，它会被截断。但通常，c{1} 已经很短了。如果希望截断的是完整的 logger name，则需要使用 %.-28c。对于 c{1}，%-28.28c{1} 的效果是，如果 c{1} 的结果超过 28 字符，它会被截断以适应 28 字符的宽度。
• c{1}：如前所述，表示日志记录器名称的最后一部分。

使用上述配置后的日志输出示例：

Eva04p2Beanlifecycle           --- No active profile set, falling back to default profiles: default
SmallService                   --- doBeforeInitializing before upadating ... what's my personal name? frieda
SmallService                   --- doBeforeInitializing ... what's my personal name? marga
Eva04p2Beanlifecycle           --- Started Eva04p2Beanlifecycle in 0.628 seconds (JVM running for 0.824)
SmallService                   --- doSomething ... what's my personal name? marga
SmallService                   --- doBeforeDestroying ... what's my personal name? elisa

通过这种方式，Eva04p2Beanlifecycle 和 SmallService 后的空格会被自动填充，使得所有的 --- 符号都精确对齐。

注意事项

1. 宽度选择： 28 这个宽度值需要根据实际应用中最长的类名（或 c{1} 的输出）来确定。如果你的类名普遍很长，可能需要更大的宽度值，反之则可以适当减小。
2. 截断行为： .-max 这样的修饰符对于不同的转换字符有不同的截断行为。对于 %c (logger name)，默认是从开头截断。如果希望完全避免截断，可以只设置最小宽度而不设置最大宽度，例如 %-28c{1}，但这可能导致日志行过长。
3. 其他日志元素： 除了类名，你还可以对时间戳、线程名等其他日志元素应用类似的宽度和对齐修饰符，以实现更全面的日志格式化。
4. Logback 文档： Logback 提供了非常详细的模式布局文档，其中包含了所有可用的转换字符和格式修饰符。强烈建议查阅官方文档（logback.qos.ch/manual/layouts.html#formatModifiers），以根据具体需求进行更高级的定制。
5. XML 配置： 对于更复杂的 Logback 配置，或者当 application.properties 不足以满足需求时，可以创建 logback-spring.xml 或 logback.xml 文件进行配置。

总结

实现 SLF4J 日志输出的对齐，本质上是对其底层日志实现（Spring Boot 默认为 Logback）进行配置。通过理解 Logback 模式布局中的宽度和对齐修饰符，我们可以精确控制日志输出中各个元素的空间占用，从而显著提高日志的可读性。关键在于使用 %-min.max 这样的格式修饰符，为变长元素（如类名）预留固定空间并进行左对齐。这种精细化的控制，对于在开发和调试阶段快速定位问题至关重要。

以上就是Spring Boot 中 Logback 日志输出对齐实践的详细内容，更多请关注php中文网其它相关文章！