Slf4j + Logback 配置多个日志文件

最新推荐文章于 2025-03-30 19:51:43 发布

原创最新推荐文章于 2025-03-30 19:51:43 发布 · 3.5k 阅读

11 ·

本内容遵循CC 4.0 BY-SA版权协议

Java 同时被 2 个专栏收录

5 篇文章

订阅专栏

spring

2 篇文章

订阅专栏

本文介绍了如何使用Slf4j+Logback在项目中配置多个日志文件，包括单日志实例的配置步骤和多日志实例的详细配置，涉及logback.xml的修改以及测试类的调整，确保不同类型的日志能被正确地记录到不同的文件中。

开发板推荐：天空星STM32F407VET6开发板

超高性价比 STM32主控 | 超高主频 | 一板兼容百芯 | 比赛神器 | 沉金彩色丝印

点击查看

背景

项目开发中，有些业务比较重要，或者可能容易出错，需要我们对其进行额外的监控。然而系统控制台默认打印的日志与操作日志都无法满足我们的需求。此时我们需要自己配一套日志模板，并独立存放。

简言之就是要配置多个日志文件。开始不会配置，便写了个IO输出日志文件。

IO自定义日志文件输出

下面主要讲Slf4j + Logback 配置多个日志文件。

一、单日志实例

1、引入依赖

添加slf4j日志api

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

添加logback-classic依赖

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

<?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.4.1</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

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

        <!-- 添加slf4j日志api -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.20</version>
        </dependency>
        <!-- 添加logback-classic依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>

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

</project>

2、添加 logback.xml 配置

在 src\main\resources\ 目录下创建 logback.xml 文件。

<?xml version="1.0" encoding="UTF-8"?>
<!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
     scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
     debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 上下文变量设置,用来定义变量值,其中name的值是变量的名称，value的值时变量定义的值。
        通过<property>定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
    <property name="CONTEXT_NAME" value="logback-test" />

    <!-- 上下文名称：<contextName>, 每个logger都关联到logger上下文，
        默认上下文名称为“default”。但可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。
        一旦设置，不能修改。 -->
    <contextName>${CONTEXT_NAME}</contextName>

    <!-- <appender>是<configuration>的子节点，是负责写日志的组件。
        有两个必要属性name和class。
        name指定appender名称，
        class指定appender的实现类。 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 对日志进行格式化。 -->
        <encoder>
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
            </pattern>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。 -->
        <file>${logs.dir}/logback-test.log</file>

        <!-- 当发生滚动时的行为  -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <!-- 必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip -->
            <FileNamePattern>${logs.dir}/logback-test.%i.log</FileNamePattern>
            <!-- 窗口索引最小值 -->
            <minIndex>1</minIndex>
            <!-- 窗口索引最大值 -->
            <maxIndex>1</maxIndex>
        </rollingPolicy>

        <!-- 激活滚动的条件。 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <!-- 活动文件的大小，默认值是10MB -->
            <maxFileSize>30MB</maxFileSize>
        </triggeringPolicy>

        <!-- 对记录事件进行格式化。 -->
        <encoder>
            <charset>UTF-8</charset>
            <Pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n
            </Pattern>
        </encoder>
    </appender>

    <!-- 特殊的<logger>元素，是根logger。只有一个level属性，应为已经被命名为"root".
        level:设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。
        <root>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger。 -->
    <root>
        <level value="WARN" />
        <appender-ref ref="stdout" />
        <appender-ref ref="file" />
    </root>

    <!-- 用来设置某一个 包 或者具体的某一个 类 的日志打印级别、以及指定<appender>,
        name:用来指定受此logger约束的某一个包或者具体的某一个类。
        level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
        additivity:是否向上级logger传递打印信息。默认是true。(这个logger的上级就是上面的root)
        <logger>可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。-->
    <logger name="log" level="INFO" additivity="true"></logger>

</configuration>

3、测试类

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

import java.text.SimpleDateFormat;
import java.util.Calendar;

@SpringBootTest
class DemoApplicationTests {

    private Logger log = LoggerFactory.getLogger("log");

    @Test
    public void contextLoads() {
        log.info("日志测试");
    }
}

日志打印结果如下：
在这里插入图片描述

二、多日志实例

1、自定义log文件

1）修改 logback.xml 配置信息

在配置文件中添加一下内容

    <!-- 测试文件 -->
    <appender name="testFile" class="ch.qos.logback.core.FileAppender">
        <!-- 可以是相对路径，可以是绝对路径 -->
        <file>${logs.dir}/testLog.log</file>
        <append>true</append>
        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 测试多文件日志打印 -->
    <logger name="testLog" level="INFO" additivity="false">
        <appender-ref ref="testFile" />
    <!-- 添加控制台打印 -->
        <appender-ref ref="stdout" />
    </logger>

2）测试类修改

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

import java.text.SimpleDateFormat;
import java.util.Calendar;

@SpringBootTest
class DemoApplicationTests {

    private Logger log = LoggerFactory.getLogger("log");
    private Logger testLog = LoggerFactory.getLogger("testLog");

    @Test
    public void contextLoads() {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        Calendar calendar=Calendar.getInstance();
        String now = sdf.format(calendar.getTime());
        
        log.info(now + "日志测试");
        testLog.info(now + " 自定义日志文件");
    }
}

可以看到新增了 testLog.xml 的日志文件，多日志文件打印成功。

在这里插入图片描述

2、class 类 log 文件

1）修改 logback.xml 配置信息

logger name 填写某个类的全路径。

  <!-- class日志文件 -->
    <appender name="classFile" class="ch.qos.logback.core.FileAppender">
        <!-- 可以是相对路径，可以是绝对路径 -->
        <file>${logs.dir}/classLog.log</file>
        <append>true</append>
        <encoder>
            <!-- 配置日志输出格式-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}|%level|%class|%thread|%method|%line|%msg%n</pattern>
           <!-- <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>-->
        </encoder>
    </appender>

    <!-- 指定具体的某个类日志文件打印 -->
    <logger name="com.example.demo.DemoApplicationTests" level="INFO" additivity="false">
        <appender-ref ref="classFile"/>
    </logger>

2）测试类修改

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

import java.text.SimpleDateFormat;
import java.util.Calendar;

@SpringBootTest
class DemoApplicationTests {

    private Logger log = LoggerFactory.getLogger("log");

    private Logger testLog = LoggerFactory.getLogger("testLog");

    private static Logger logger = LoggerFactory.getLogger(DemoApplicationTests.class);


    @Test
    public void contextLoads() {

        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        Calendar calendar=Calendar.getInstance();
        String now = sdf.format(calendar.getTime());

        log.info(now + " 日志测试");
        testLog.info(now + " 自定义日志文件");
        logger.info(now + " class类 日志文件");

    }

}