浅谈Java库之SLF4j

一、SLF4J 介绍

        SLF4J（Simple Logging Facade for Java）是一个简单日志门面，它为各种日志框架提供了一个统一的抽象层。SLF4J 允许开发者在部署时选择所需的日志框架，而不需要在代码中硬编码具体的日志实现。这种设计使得在不同的日志框架之间切换变得非常简单，只需更换绑定的日志实现库即可，无需修改代码。

二、SLF4J 功能

1、统一的API：

SLF4J 提供了一个统一的API，使得开发者可以使用相同的方法记录日志，而无需关心底层日志框架的具体实现。

2、多种日志框架支持：

SLF4J 支持多种日志框架，包括 Logback、Log4j、Java Util Logging 等。

3、参数化日志记录：

SLF4J 支持使用 {} 作为占位符的参数化日志记录消息，提高了日志记录的效率和可读性。

4、灵活的配置：

日志的格式、记录级别、输出方式等都可以通过具体的日志系统配置来实现，而不是硬编码在代码中。

三、SLF4J 使用方法

环境配置

1、引入依赖：在 Maven 的 pom.xml 文件中引入 SLF4J 的依赖。

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.32</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>

如果是使用 Gradle，则在 build.gradle 文件中添加相应的依赖。

2、配置日志框架：以 Logback 为例，需要创建一个 logback.xml 配置文件，并放置在 src/main/resources 目录下。

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

3、编写日志代码：使用 SLF4J 提供的 Logger 和 LoggerFactory 来记录日志。

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

public class LoggerTest {
    private static final Logger logger = LoggerFactory.getLogger(LoggerTest.class);
    public static void main(String[] args) {
        logger.info("Current Time: {}", System.currentTimeMillis());
    }
}

SLF4J 支持使用 {} 作为占位符，这样可以避免字符串拼接，提高效率。

四、SLF4J 完整代码示例

1. Maven 依赖配置（pom.xml）

首先，你需要在你的 pom.xml 文件中添加 SLF4J API 和 Logback 的依赖。

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>slf4j-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <!-- SLF4J API -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.32</version>
        </dependency>
        <!-- Logback Classic Implementation -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>
</project>

2. 日志配置文件（logback.xml）

在 src/main/resources 目录下创建 logback.xml 文件，用于配置 Logback。

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

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

3. Java 代码示例

创建一个 Java 类来使用 SLF4J 记录日志。

package com.example.slf4jdemo;

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

public class LoggingExample {
    // 创建一个 Logger 实例
    private static final Logger logger = LoggerFactory.getLogger(LoggingExample.class);

    public static void main(String[] args) {
        // 记录不同级别的日志
        logger.trace("Trace message: {}", 123);
        logger.debug("Debug message: {}", 123);
        logger.info("Info message: {}", 123);
        logger.warn("Warn message: {}", 123);
        logger.error("Error message: {}", 123);

        // 抛出异常并记录
        try {
            int divisionResult = 10 / 0;
        } catch (Exception e) {
            logger.error("Exception occurred", e);
        }
    }
}

4、运行程序

当你运行 LoggingExample 类时，Logback 会根据 logback.xml 中的配置将日志输出到控制台。你将看到不同级别的日志消息，以及异常信息。

这个示例展示了如何配置和使用 SLF4J 与 Logback 在 Java 应用程序中记录日志。你可以根据需要调整日志级别和输出格式。