详解Springboot之Logback的使用学习

详解Springboot之Logback的使用学习

什么是Logback

Logback是一种开源的日志记录框架，是log4j框架的继任者。Springboot使用Logback作为默认的日志记录框架。
Logback由3个模块构成，分别为logback-core、logback-classic和logback-access。其中，logback-core是其他两个模块的基本组件：logback-classic完全实现SLF4J API，而logback-access构建在logback-core和Servlet API的基础上。

如何使用Logback

在Springboot中要使用Logback，只需要在pom.xml中引入相关依赖即可。如下代码所示，它会引入logback-classic、logback-core和slf4j-api。其中，logback-classic完全实现了SLF4J API, 为应用程序提供了日志的功能。

<dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>

    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-core</artifactId>
        <version>1.2.3</version>
    </dependency>

    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
    </dependency>

配置Logback

在logback.xml文件中可以配置Logback。下面是一个基本的logback.xml配置示例。

<configuration>
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
        </layout>
    </appender>

    <root level="debug">
        <appender-ref ref="console" />
    </root>
</configuration>

在上面的示例中使用了ConsoleAppender，它会将日志输出到控制台。PatternLayout是Logback的格式化输出方式，指定了输出信息的格式。%d代表日期，%thread代表线程名，%-5level代表日志级别，%logger{36}代表日志分类，%msg表示日志内容，%n代表换行。

root标签中的level指定了日志的级别，在debug级别下可以输出所有级别的日志。具体的日志级别从高到低分别为TRACE、DEBUG、INFO、WARN、ERROR。

示例1：使用Logback输出日志

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

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

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

在上面的示例中，我们使用LoggerFactory的getLogger方法获取了一个日志记录器Logger，并使用Logger.info()方法输出了一条日志。

示例2：将日志输出到指定文件

<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>C:/logs/example.log.%d{yyyy-MM-dd}</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="file" />
    </root>

在上面的示例中，我们使用了RollingFileAppender将日志输出到指定的文件，FileNamePattern指定了输出的文件名。TimeBasedRollingPolicy会根据时间将日志存储到不同的文件中。

结论

通过上述示例，我们可以看到Logback的使用方法和配置方式。在实际的开发中，我们可以根据项目需求选择不同的日志处理方式，使日志输出更加美观清晰。