轉載宣告：商業轉載請聯絡作者獲得授權,非商業轉載請註明出處.原文來自 © 呆萌鍾 【SpringBoot學習之路】09.Spring Boot與日誌

日誌框架

市場上存在非常多的日誌框架。JUL（java.util.logging），JCL（Apache Commons Logging），Log4j，Log4j2，Logback、SLF4j、jboss-logging等。Spring Boot在框架內容部使用JCL，spring-boot-starter-logging採用了slf4j+logback的形式，Spring Boot也能自動適配（jul、log4j2、logback）並簡化配置 

SLF4j使用

如何在系統中使用SLF4j(https://www.slf4j.org)

以後開發的時候，日誌記錄方法的呼叫，不應該來直接呼叫日誌的實現類，而是呼叫日誌抽象層裡面的方法； 給系統裡面匯入slf4j的jar和 logback的實現jar

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(HelloWorld.class);
        logger.info("Hello World");
    }
}
 

每一個日誌的實現框架都有自己的配置檔案。使用slf4j以後，配置檔案還是做成日誌實現框架自己本身的配置檔案；

遺留問題

a（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx 統一日誌記錄，即使是別的框架和我一起統一使用slf4j進行輸出？ 如何讓系統中所有的日誌都統一到slf4j?

1. 將系統中其他日誌框架先排除出去；
2. 用中間包來替換原有的日誌框架；
3. 我們匯入slf4j其他的實現

SpringBoot日誌關係

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

SpringBoot使用它來做日誌功能；

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

底層依賴關係

總結：

1. SpringBoot底層也是使用slf4j+logback的方式進行日誌記錄
2. SpringBoot也把其他的日誌都替換成了slf4j；
3. 中間替換包

@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

    static LogFactory logFactory = new SLF4JLogFactory();

• 如果我們要引入其他框架,一定要把這個框架的預設日誌依賴移除掉
• Spring框架用的是commons-logging；

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring‐core</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>commons‐logging</groupId>
                    <artifactId>commons‐logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

SpringBoot能自動適配所有的日誌，而且底層使用slf4j+logback的方式記錄日誌，引入其他框架的時候，只需要把這個框架依賴的日誌框架排除掉即可；

日誌使用

預設配置

SpringBoot預設幫我們配置好了日誌

//記錄器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public void contextLoads() {
        //日誌的級別；
        //由低到高 trace<debug<info<warn<error
        //可以調整輸出的日誌級別；日誌就只會在這個級別以以後的高級別生效
        logger.trace("這是trace日誌。。。");
        logger.debug("這是debug日誌。。。");
        //SpringBoot預設給我們使用的是info級別的，沒有指定級別的就用SpringBoot預設規定的級別；root級別
        logger.info("這是info日誌。。。");
        logger.warn("這是warn日誌。。。");
        logger.error("這是error日誌。。。");
    }

日誌輸出格式：
%d表示日期時間，
%thread表示執行緒名，
%‐5level：級別從左顯示5個字元寬度
%logger{50} 表示logger名字最長50個字元，否則按照句點分割。
%msg：日誌訊息，
%n是換行符
‐‐>
%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n

SpringBoot修改日誌的預設配置

logging.level.com=trace

# 不指定路徑在當前專案下生成springboot.log日誌
# 可以指定完整的路徑；
#logging.file=D:/springboot.log

# 在當前磁碟的根路徑下建立spring資料夾和裡面的log資料夾；使用 spring.log 作為預設檔案
logging.path=/spring/log

# 在控制檯輸出的日誌的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定檔案中日誌輸出的格式
logging.pattern.file=file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

指定配置

給類路徑下放上每個日誌框架自己的配置檔案即可；SpringBoot就不使用他預設配置的了 

• logback.xml：直接就被日誌框架識別了；
• logback-spring.xml：日誌框架就不直接載入日誌的配置項，由SpringBoot解析日誌配置，可以使用SpringBoot的高階Profile功能

<springProfile name="staging">
    <!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
    可以指定某段配置只在某個環境下生效
</springProfile>

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日誌輸出格式：
			%d表示日期時間，
			%thread表示執行緒名，
			%-5level：級別從左顯示5個字元寬度
			%logger{50} 表示logger名字最長50個字元，否則按照句點分割。 
			%msg：日誌訊息，
			%n是換行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
</appender>

如果使用logback.xml作為日誌配置檔案，還要使用profile功能，會有以下錯誤: no applicable action for [springProfile]