如何在Logback中自定义日志格式与参数配置？

Question

**问题描述：** 在使用 Logback 进行日志输出时，如何自定义日志格式（如添加线程名、类名、日志级别等）以及配置相关参数（如设置日志输出路径、文件滚动策略、最大保留天数等），以满足不同项目对日志可读性和管理的需求？

Answer 1

Logback 自定义日志格式与配置详解

在现代软件开发中，日志系统是不可或缺的组成部分。Logback 作为 Java 平台上的高性能日志框架，广泛应用于 Spring Boot、微服务架构等项目中。本文将从基础到高级逐步讲解如何自定义 Logback 的日志格式，并配置输出路径、文件滚动策略及保留策略。

1. 基础概念：Logback 的核心组件

• Logger： 日志记录器，用于获取日志实例。
• Appender： 定义日志输出的目的地（如控制台、文件）。
• Layout/Encoder： 控制日志输出格式。

Logback 支持多种类型的 Appender，例如 ConsoleAppender、FileAppender、RollingFileAppender 等。

2. 自定义日志格式：添加线程名、类名、日志级别

Logback 使用 PatternLayout 来定义日志输出格式。以下是一个常见的 pattern 示例：

%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n

占位符	说明
%d	日期时间
%thread	线程名称
%-5level	日志级别（左对齐，固定宽度为5）
%logger{36}	记录日志的类名，最多显示36个字符
%msg	日志消息内容
%n	换行符

3. 配置日志输出路径和文件滚动策略

Logback 提供了 RollingFileAppender 来支持日志文件的滚动策略。以下是基于 XML 配置的示例：

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>/var/log/myapp/app.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>/var/log/myapp/app.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <root level="info">
        <appender-ref ref="FILE" />
    </root>
</configuration>

该配置实现了以下功能：

• 日志写入路径：/var/log/myapp/app.log
• 按天滚动日志文件，命名格式为 app.2025-04-05.log
• 保留最近30天的日志文件

4. 高级配置：结合大小与时间双维度滚动策略

Logback 支持同时按时间和大小进行日志滚动。可以使用 SizeAndTimeBasedRollingPolicy：

<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
    <fileNamePattern>/var/log/myapp/app.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
    <maxFileSize>10MB</maxFileSize>
    <maxHistory>7</maxHistory>
    <totalSizeCap>1GB</totalSizeCap>
</rollingPolicy>

• %i 表示索引编号，当日志文件超过10MB时会生成新的文件。
• maxHistory 设置保留7天内的日志。
• totalSizeCap 限制总日志大小不超过1GB。

5. 架构图：Logback 核心流程示意

graph TD A[Application Code] --> B(Logger) B --> C(Appender) C --> D{Output Type} D -->|Console| E(ConsoleAppender) D -->|File| F(RollingFileAppender) F --> G[Rolling Policy] G --> H[Time or Size Based] C --> I(Layout/Encoder) I --> J[PatternLayout]