slf4j使用詳解

一、slf4j使用log4j和log4j2區別

slf4j本質上是一個日誌系統的抽象層，它可以和不同的具體日誌實現庫進行對接，比如log4j、logback等。

在使用slf4j和log4j進行對接時，需要注意log4j和log4j2的區別。log4j2是log4j的升級版，性能更加優秀，但log4j2不能直接被slf4j所使用，需要使用適配器(log4j-slf4j-impl)的依賴。

下面是slf4j和log4j的配置代碼示例：

    org.slf4j
    log4j-slf4j-impl
    1.7.30




    org.apache.logging.log4j
    log4j-core
    2.14.1




    org.slf4j
    slf4j-api
    1.7.30



    org.apache.logging.log4j
    log4j-slf4j18-impl
    2.14.1

二、slf4j註解

在使用slf4j時，可以使用註解來簡化代碼，這些註解在啟動時會自動為你生成相應的日誌對象。下面展示幾個常用的註解：

• @Slf4j：使用Lombok的@Slf4j註解可以為類生成一個名為log的日誌對象，從而可以使用log對象輸出日誌。
• @Log4j2：使用Lombok的@Log4j2註解也可以為類生成一個日誌對象，但是它使用的是log4j2作為日誌實現庫。
• @SneakyThrows：使用Lombok的@SneakyThrows註解可以在拋出checked異常時不用顯示地聲明或捕獲異常。

下面是使用@Slf4j註解簡化日誌代碼的示例：

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class UserService {
    public void createUser(String username, String password) {
        // 使用log輸出日誌
        log.info("Creating user: {} with password {}", username, password);
        // do something
    }
}

三、日誌slf4j使用教程

在使用slf4j進行日誌輸出時，常用的方法主要有以下幾個：

• debug()：輸出調試信息，一般在調試模式下使用。
• info()：輸出信息日誌，用於顯示業務處理的進展情況。
• warn()：輸出警告日誌，用於提醒開發人員需要注意的地方。
• error()：輸出錯誤日誌，用於記錄錯誤信息。
• trace()：輸出跟蹤信息，一般用於追蹤代碼執行流程。

下面是使用slf4j輸出日誌的示例：

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

public class UserService {
    private static final Logger LOGGER = LoggerFactory.getLogger(UserService.class);
    
    public void createUser(String username, String password) {
        // 使用Logger輸出日誌
        LOGGER.info("Creating user: {} with password {}", username, password);
        // do something
    }
}

四、slf4j的使用

在使用slf4j時，需要注意以下幾個問題：

• 使用正確的日誌級別：根據不同的日誌級別輸出不同的日誌信息。
• 使用正確的佔位符：佔位符可以使代碼更加簡潔易讀。
• 使用合適的日誌實現庫：根據實際情況選擇不同的日誌實現庫。
• 使用默認的日誌配置：使用默認的日誌配置可以避免配置出錯和衝突。

下面是使用slf4j輸出日誌的示例：

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

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

    public void createUser(String username, String password) {
        LOGGER.info("Creating user: {} with password {}", username, password);
        // do something
        try {
            // do something
        } catch (Exception e) {
            LOGGER.error("Failed to create user: {}", e.getMessage());
        }
    }
}

五、slf4j和log4j混合使用

在項目中，有時需要同時使用slf4j和log4j進行日誌輸出。為了避免衝突，在使用時需要注意以下幾點：

• 在pom.xml中只能使用一個日誌實現庫。
• 要去掉slf4j-jdk14和log4j-over-slf4j的依賴。
• 要使用log4j-slf4j-impl的適配器依賴。
• 在log4j的配置文件中添加bridge模式支持。

下面是使用slf4j和log4j混合輸出日誌的示例：

    org.slf4j
    slf4j-log4j12
    1.7.30



    org.slf4j
    log4j-slf4j-impl
    2.14.1




    org.apache.logging.log4j
    log4j-core
    2.14.1




    
        
    



    



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

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

    public void createUser(String username, String password) {
        LOGGER.info("Creating user: {} with password {}", username, password);
        // do something
    }
}


# log4j-over-slf4j
log4j.logger.org.slf4j.impl.Log4jLoggerFactory=INFO
log4j.logger.org.apache.logging.slf4j=INFO
log4j.logger.org.apache.logging.log4j.slf4j=INFO
log4j.logger.org.slf4j.bridge.SLF4JBridgeHandler=INFO

六、slf4j下載地址

如果需要下載最新版本的slf4j，請訪問以下地址：

• slf4j官方網站：https://www.slf4j.org/
• slf4j Maven倉庫：https://mvnrepository.com/artifact/org.slf4j
• GitHub：https://github.com/qos-ch/slf4j

七、用slf4j受影響嗎

使用slf4j對項目不會造成任何影響，甚至可以提高項目的可維護性和可擴展性。由於slf4j是一個日誌系統的抽象層，它可以和不同的具體日誌實現庫進行對接，使得項目可以自由選擇不同的日誌實現庫。

八、如何在spring應用中使用slf4j

在使用spring應用中使用slf4j時，常用的方式是在pom.xml中添加slf4j的依賴，在代碼中使用LoggerFactory來獲取日誌對象，並在logback.xml中配置logback。

下面是在spring應用中使用slf4j輸出日誌的示例：

    org.slf4j
    slf4j-api
    1.7.30



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

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

    public void createUser(String username, String password) {
        LOGGER.info("Creating user: {} with password {}", username, password);
        // do something
    }
}




    
    
        
            %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}} - %msg%n
        
    

    
        ${LOG_HOME}/logback.log
        
            ${LOG_HOME}/logback.%d{yyyy-MM-dd}.%i.log
            
                10MB
            
            30
        
        
            %d{ISO8601} %-5level [%thread] %logger{35} - %msg%n