一文掌握 Spring Boot 日志文件

在 Spring Boot 应用中，日志文件是非常重要的一部分，它可以帮助我们实时监控应用运行过程中发生的错误和异常，同时也便于开发人员分析问题并进行调试。本文将分享如何使用 Spring Boot 内置的日志框架 Logback 来配置日志文件。

添加 Logback 依赖

首先，在项目的 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
    <scope>runtime</scope>
</dependency>

配置日志文件

在项目的 src/main/resources 下新建一个 logback.xml 配置文件，并添加以下内容：

<configuration>

    <!--控制台输出日志-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%-d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--按照每天生成日志文件-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/spring-boot-logger.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>logs/spring-boot-logger.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%-d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--设置日志记录级别-->
    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="file"/>
    </root>

</configuration>

在上述配置文件中，我们定义了两个 appender 分别为 console 和 file，分别代表控制台输出和日志文件输出。其中，file 用于按照每天生成日志文件，文件名格式为 spring-boot-logger.xxxx-xx-xx.log。

最后，我们通过 root 配置将日志级别设置为 info，同时将 console 和 file 的 appender 引用到 root 中。

示例

下面，我们来使用一个简单的示例来说明如何使用配置好的日志文件。

首先，在控制器类 ExampleController 中，我们添加以下代码：

@RestController
@RequestMapping("/example")
public class ExampleController {

    private static final Logger log = LoggerFactory.getLogger(ExampleController.class);

    @GetMapping("/hello")
    public String hello() {
        log.info("hello world!");
        return "hello world!";
    }

}

在上述代码中，我们首先获取了 ExampleController 的 Logger 对象，然后在 hello 方法中输出了一条 info 级别的日志信息。

当我们运行 Spring Boot 应用时，启动后将在控制台输出以下信息：

2021-12-31 11:22:33.123 [main] INFO  c.e.c.ExampleController - hello world!

同时，应用将在 logs 文件夹下生成一个以日期命名的日志文件，文件名格式为 spring-boot-logger.xxxx-xx-xx.log，以记录当天的日志信息。

总结

本文通过添加 Logback 依赖和配置日志文件两个步骤，详细介绍了如何使用 Spring Boot 内置的日志框架 Logback 来配置日志文件。同时，通过示例演示了如何在控制器中输出和记录日志信息。希望本文对你了解 Spring Boot 日志文件有所帮助。