【Java】【SpringBoot】logback开发环境配置

LogBack开发环境配置

Logback是一个开源的日志记录库，它是log4j的一个改进版本 。Logback被设计为易于使用，同时提供强大的日志管理功能。

1.添加依赖

在pom.xml文件中添加依赖：

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

2.创建Logback配置文件

在你的资源目录（通常是src/main/resources）中创建一个名为logback.xml的文件。这个文件将包含你的日志配置。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            </encoder>
        </appender>
        <root level="info">
            <appender-ref ref="STDOUT" />
        </root>
</configuration>

3.使用logback记录日志

在你的Java代码中，你可以通过导入logback的Logger类来记录日志。

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

@SpringBootTest
public class LogbackTest {
    private static final Logger log = LoggerFactory.getLogger(LogbackTest.class);

    /**
     * 测试log4J的使用
     * @author lyj
     * @date 2024-10-28
     */
    @Test
    public void test(){
        log.error("hello, Logback!");
    }
}

4.运行你的应用程序

logback高级特性

1. 配置多个Appender

你可以配置多个Appender，以便将日志输出到不同的目的地，比如控制台、文件、远程服务器等。 这里配置的文件路径为，当前项目的logs文件夹下。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志存放路径 -->
    <property name="log_path" value="./logs" />

    <!--  输出到控制台-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <!--输出到文件-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log_path}/logFile.log</file>
        <encoder>
            <pattern>${log_path}/%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log_path}/logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
    </appender>
    <root level="info">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

打开logs日志。可以看到输出已经写logFile.log文件下：

2. 日志级别的控制

Logback支持TRACE, DEBUG, INFO, WARN, ERROR和FATAL等日志级别。你可以在配置文件中为不同的Logger设置不同的日志级别，以便控制日志的详细程度。

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

3. 异步日志记录

对于需要高性能日志记录的应用程序，Logback提供了异步Appender。使用异步Appender可以减少日志记录对应用程序性能的影响。

 <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
	<queueSize>512</queueSize>
	<discardingThreshold>0</discardingThreshold>
	<appender-ref ref="STDOUT" />
</appender>
 <root level="info">
	<appender-ref ref="file_info" />
	<appender-ref ref="file_error" />
</root>

在这个例子中，所有的日志都会先被发送到异步Appender的队列中，然后由一个单独的线程从队列中取出并处理（即发送到控制台）。

4. 日志格式的自定义

Logback允许你自定义日志消息的格式，以满足特定的格式化需求。你可以通过修改encoder部分的pattern属性来实现这一点。例如，如果你希望在日志中包含线程名称和类名，你可以这样配置：

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

5. 日志文件的压缩和清理

随着时间的推移，日志文件会不断增长，可能会占用大量的磁盘空间。Logback的TimeBasedRollingPolicy已经提供了一种按日期分割日志文件的机制，但你还可以进一步配置日志文件的压缩和清理策略。

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
	<fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
	<maxHistory>30</maxHistory> <!-- 保留最近30天的日志文件 -->
	<totalSizeCap>3GB</totalSizeCap> <!-- 最多保留3GB的日志数据 -->
</rollingPolicy>

在这个配置中，maxHistory属性指定了保留日志文件的最大天数，而totalSizeCap属性则限制了日志文件的总大小。一旦达到这些限制，旧的日志文件将被自动删除或压缩，从而帮助你管理磁盘空间。

6. 日志的归档

有时候，你可能希望将日志文件归档到一个单独的目录中，以便于备份和管理。你可以通过配置rollingPolicy来实现这一点：

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

在这个例子中，日志文件将被归档到/var/log/myapp/archive/目录下。你可以根据实际需要调整归档路径。
通过这些高级配置，你可以进一步优化Logback的使用，以满足复杂和特定的日志记录需求。灵活地运用这些技巧，可以帮助你更好地管理和分析应用程序的日志数据。