Spring Boot 项目过程日志记录实战指南

基于 Spring Boot 项目的过程日志，可以使用 Spring Boot 自带的日志框架，即 SLF4J（Simple Logging Facade for Java）。

1. 添加依赖

在 Spring Boot 项目中，可以通过添加相关依赖来使用 SLF4J 和 logback 作为日志框架。在 pom.xml 文件中添加以下依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
    </dependency>
</dependencies>

2. 配置 Logback

然后，在 src/main/resources 目录下创建 logback.xml 文件，配置日志输出格式和文件路径。以下是一个简单的 logback.xml 配置示例：

<configuration>
    <appender name="STDOUT" 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.FileAppender">
        <file>logs/myapp.log</file>
        <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="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

以上配置将日志同时输出到控制台和 myapp.log 文件中。

3. 使用 Logger 对象

接下来，在需要记录日志的类中引入 Logger 对象，并在需要记录日志的地方使用 Logger 对象的相应方法，如下所示：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;

@Controller
public class MyController {
    private static final Logger logger = LoggerFactory.getLogger(MyController.class);

    public void doSomething() {
        logger.debug('This is a debug message');
        logger.info('This is an info message');
        logger.warn('This is a warning message');
        logger.error('This is an error message');
    }
}

4. 总结

通过使用 SLF4J 和 logback，可以在 Spring Boot 项目中方便地记录过程日志，并按照配置的格式和文件路径输出日志信息。