maven如何使用slf4j输出日志到文件

使用 Maven 来构建项目时，常常需要对项目的运行状态进行日志记录，方便项目的调试和交付。SLF4J 是一个 Java 日志框架，具有轻量级、可扩展的特点，同时提供了多种日志实现的接口，便于灵活选择。本文将介绍如何使用 SLF4J 日志框架，在项目中输出日志到文件。

1. 引入依赖

首先，需要在项目中引入 SLF4J 的依赖。在工程的 pom.xml 文件中加入以下依赖声明：

<dependencies>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.32</version>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.32</version>
    <scope>runtime</scope>
  </dependency>
</dependencies>

其中，slf4j-api 是 SLF4J 框架的核心包，jcl-over-slf4j 是日志实现的适配器。上述示例中，使用了 Java Commons Logging 来实现日志输出，因此需要添加 jcl-over-slf4j 包的依赖声明。

2. 配置日志输出

经过上一步引入依赖之后，SLF4J 就可以被使用了。需要针对不同的日志实现做出配置，如对 Log4j 来说，可以在工程的资源目录中添加一个 log4j.properties 文件，并在文件中配置日志相关的属性：

# Log4j configuration
log4j.rootLogger=TRACE, file
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.file=log/output.log
log4j.appender.file.maxFileSize=10MB
log4j.appender.file.maxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ISO8601} %-5p [%t] %c{1}:%L - %m%n

上述配置文件指定了日志输出到一个名为 log/output.log 的文件，最大大小不超过 10 MB，最多备份 10 个文件，同时指定了日志记录格式。

如果使用的是其他日志实现方式，请参考相应的官方文档进行配置。

3. 编写 Java 代码

SLF4J 提供了日志输出的多种方法，例如 debug、info、warn 等方法，分别对应不同级别的日志信息。下面是一个简单的 Java 代码示例，演示如何在程序中使用 SLF4J 输出日志信息到文件：

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

public class Main {
  private static final Logger LOGGER = LoggerFactory.getLogger(Main.class);

  public static void main(String[] args) {

    LOGGER.debug("Debugging message");
    LOGGER.info("Information message");
    LOGGER.warn("Warning message");
    LOGGER.error("Error message");
 }
}

上述示例代码中，首先通过 LoggerFactory 获取到一个 logger 实例，然后通过调用相应级别的日志输出方法，输出不同的日志信息。

在使用 SLF4J 进行日志输出时，需要注意以下几点：

• 始终使用占位符的方式输出日志，避免字符串拼接的性能问题。
• 不要手动捕获异常并记录，而是让异常信息直接传递给 logging façade，让其自行处理。
• 如果使用代码混淆，需要保留 logger 的名字字符串，以便在 ProGuard 进行混淆时保留住 logger 的名字。

4. 查看日志输出

当程序运行时，就会将日志信息输出到指定的文件中（如上述示例的 log/output.log 文件）。可以使用 tail 命令对文件进行动态查看：

tail -f log/output.log

也可以使用 Visual Studio Code 等现代 IDE 自带的日志查看器插件，对日志进行即时查看。

示例1

1. 引入依赖

在项目的 pom.xml 文件中加入以下依赖声明：

<dependencies>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.32</version>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
    <version>1.7.32</version>
    <scope>runtime</scope>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-jdk14</artifactId>
    <version>1.7.32</version>
  </dependency>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
  </dependency>
</dependencies>

2. 配置日志输出

SLF4J提供默认的日志实现方式，不需要进行配置。

3. 编写Java代码

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LoggingTest {
    private static final Logger LOGGER = LoggerFactory.getLogger(LoggingTest.class);

    @Test
    public void testLogging() {
        LOGGER.debug("This is a debug log.");
        LOGGER.info("This is an info log.");
        LOGGER.warn("This is a warn log.");
        LOGGER.error("This is an error log.");
    }
}

4. 查看日志输出

在 Linux shell 上，可以使用以下命令来查看日志输出：

$ mvn clean test
$ tail -f target/surefire-reports/*.txt

示例2

1. 引入依赖

在项目的 pom.xml 文件中加入以下依赖声明：

<dependencies>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.32</version>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
    <version>1.7.32</version>
  </dependency>
  <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
  </dependency>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
  </dependency>
</dependencies>

2. 配置日志输出

在项目的 resources 目录下，创建一个名为 log4j.properties 的文件，添加以下内容：

log4j.rootLogger=TRACE, file
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=output.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{HH:mm:ss} %-5p [%t] %c{1}:%L - %m%n

上述配置文件指定了日志输出到一个名为 output.log 的文件，最大大小不超过 10 MB，最多备份 10 个文件，同时指定了日志记录格式。

3. 编写Java代码

import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LoggingTest {
    private static final Logger LOGGER = LoggerFactory.getLogger(LoggingTest.class);

    @Test
    public void testLogging() {
        LOGGER.debug("This is a debug log.");
        LOGGER.info("This is an info log.");
        LOGGER.warn("This is a warn log.");
        LOGGER.error("This is an error log.");
    }
}

4. 查看日志输出

在 Linux shell 上，可以使用以下命令来查看日志输出：

$ mvn clean test
$ tail -f output.log

本文重点讲解了如何使用 Maven 构建 SLF4J 日志框架，输出日志到文件。同时，还介绍了如何使用默认的日志实现方式以及常见的 Log4j 的日志实现方式。通过上述示例和步骤，您应该可以在项目中使用 SLF4J 来输出日志，并便利地记录和调试工程的运行状态。