使用Spring Boot输出日志的方法

解释的目的是什么？

学习并深入理解在Spring Boot中输出日志的步骤。

实现

将日志输出配置集成到本地环境的Spring Boot应用中，并将日志同时输出到标准输出和文件中。使用Logback作为用于输出日志的SLF4J实现库。

技术背景 (jì shù

SLF4J（Simple Logging Facade for Java）是什么？

软件开发环境

• Windows 11 Home 22H2 を使用しています。

WSL の Ubuntu を操作していきますので macOS の方も参考にして頂けます。

在这篇文章中，我们主要使用Ubuntu终端进行操作。

输出日志的步骤 de

创建一个最小限的Spring Boot应用程序。

添加处理日志的库

我将编辑pom.xml文件。

$ vim pom.xml

文件的内容

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.8</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>hello-spring-log</artifactId>
    <version>1.0</version>
    <name>hello-spring-log</name>

    <properties>
        <java.version>11</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

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

        <!-- Log -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.6</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.6</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.30</version>
        </dependency>
    </dependencies>

    <build>
        <finalName>app</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

创建Spring Boot配置文件

$ mkdir -p src/main/resources
$ vim src/main/resources/application.properties

文件的内容 de

spring.profiles.active=develop

添加日志设置文件

在Spring Boot应用程序中，默认会自动加载位于src/main/resources目录下的logback-spring.xml文件。

创建logback-spring.xml.

$ vim src/main/resources/logback-spring.xml

文件的内容

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <springProfile name="develop">
        <include resource="org/springframework/boot/logging/logback/defaults.xml" />
        <include resource="org/springframework/boot/logging/logback/console-appender.xml" />

        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>[%-5le] %lo{0}.%M:%L - %msg%n</pattern>
            </encoder>
        </appender>

        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>./log/app.log</file>
            <append>true</append>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>./log/app.%d{yyyy-MM-dd}_%i.log.gz</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>5MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <maxHistory>31</maxHistory>
                <cleanHistoryOnStart>true</cleanHistoryOnStart>
            </rollingPolicy>
            <encoder>
                <pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} [%-5le] [%t] %C.%M:%L - %m%n</pattern>
            </encoder>
        </appender>

        <logger name="org.springframework" level="INFO" />
        <logger name="com.example" level="DEBUG" />

        <root level="WARN">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="FILE" />
        </root>
    </springProfile>

</configuration>

在Java代码中添加输出日志的代码

$ vim src/main/java/com/example/spring/SpringbootApplication.java

文件的内容 de

package com.example.spring;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@SpringBootApplication
public class SpringbootApplication {

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

    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }

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

目录文件结构

$ tree -I log -I target
.
├── pom.xml
└── src
    └── main
        ├── java
        │   └── com
        │       └── example
        │           └── spring
        │               └── SpringbootApplication.java
        └── resources
            ├── application.properties
            └── logback-spring.xml

运行Spring Boot应用

Java 应用程序构建

$ mvn clean install

使用Java启动应用程序（按Ctrl + C停止）

$ mvn spring-boot:run

请使用其他终端命令进行确认。

$ curl http://localhost:8080/hello
Hello World!

在终端上显示了以下日志信息。

[INFO ] SpringbootApplication.hello:23 - Hello World!

另外，以下内容已在/log/app.log中记录。

2023-02-21 17:25:33.785 [INFO ] [http-nio-8080-exec-1] com.example.spring.SpringbootApplication.hello:23 - Hello World!

设置异步输出日志

简要总结

Ubuntu の 最小構成の Java 開発環境で Spring Boot アプリにログ出力機能を組みこむことが出来ました。