SpringBoot 日誌框架

胖先森發表於2018-12-27

日誌框架

日誌框架就是為了更好的記錄日誌使用的，記錄日誌是為了我們在工作中可以更好的查詢相對應的問題，也算是以中留痕操作！

以前我們剛開始學習的時候都是用System.out.println()去在控制檯記錄，怎麼說呢？這種方式伴隨著我們很長時間，之後我們就遇到了斷點除錯的方式，逐漸不在使用System.out.println()進行除錯，但是你別忘記，那是一種記錄不管是否有用，你都應該去記錄！

**市面上的日誌框架；**JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....

日誌門面（日誌的抽象層）	日誌實現
~~JCL（Jakarta Commons Logging）~~ SLF4j（Simple Logging Facade for Java） ~~jboss-logging~~	Log4j JUL（java.util.logging） Log4j2 Logback

SpringBoot：底層是Spring框架，Spring框架預設是用JCL；‘

<==SpringBoot選用 SLF4j和logback；==>

1.SLF4j使用

1.1 如何在系統中使用SLF4j

SLF4J的官方網站手冊

以後開發的時候，日誌記錄方法的呼叫，不應該來直接呼叫日誌的實現類，而是呼叫日誌抽象層裡面的方法；

給系統裡面匯入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以後，配置檔案還是做成日誌實現框架自己本身的配置檔案；

1.2 歷史遺留問題

我們接觸過的框架使用的日誌框架都有所不同，因此，統一日誌記錄，即使是別的框架和我一起統一使用slf4j進行輸出？

1.3 slf4j統一“天下”

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

2. Spring Boot 日誌配置

SpringBoot使用它來做日誌功能:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>
複製程式碼

SpringBoot底層也是使用slf4j+logback的方式進行日誌記錄
SpringBoot也把其他的日誌都替換成了slf4j

中間替換包？

@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>
複製程式碼

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

3. 日誌的使用

Spring Boot 預設給我們已經配置好了日誌，測試如下：

//記錄器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
    //System.out.println();

    //日誌的級別；
    //由低到高   trace<debug<info<warn<error
    //可以調整輸出的日誌級別；日誌就只會在這個級別以以後的高階別生效
    logger.trace("這是trace日誌...");
    logger.debug("這是debug日誌...");
    //SpringBoot預設給我們使用的是info級別的，沒有指定級別的就用SpringBoot預設規定的級別；root級別
    logger.info("這是info日誌...");
    logger.warn("這是warn日誌...");
    logger.error("這是error日誌...");
}
複製程式碼

3.1 日誌格式說明

 日誌輸出格式：
     %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.hanpang=trace
# com.hanpang是說明的包名

#logging.path=
# 不指定路徑在當前專案下生成springboot.log日誌
# 可以指定完整的路徑；
#logging.file=G:/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=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
複製程式碼

logging.file	logging.path	Example	Description
(none)	(none)		只在控制檯輸出
指定檔名	(none)	my.log	輸出日誌到my.log檔案
(none)	指定目錄	/var/log	輸出到指定目錄的 spring.log 檔案中

3.2 指定配置

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

Logging System	Customization
Logback	`logback-spring.xml`, `logback-spring.groovy`, `logback.xml` or `logback.groovy`
Log4j2	`log4j2-spring.xml` or `log4j2.xml`
JDK (Java Util Logging)	`logging.properties`

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]

4. 切換日誌框架

可以按照slf4j的日誌適配圖，進行相關的切換；

slf4j+log4j的方式，pom.xml配置如下:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>logback-classic</artifactId>
            <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
            <artifactId>log4j-over-slf4j</artifactId>
            <groupId>org.slf4j</groupId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
</dependency>
複製程式碼

如果切換為log4j2，pom.xml配置如下：

log4j2配置的參考文章

log4j2的配置說明

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

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
複製程式碼

5.“坑”

logging.path和logging.file不可以同時配置,同時配置也只有logging.file起效
配置logging.path將會在指定資料夾下面生成spring.log檔案,檔名字無法控制
配置logging.file,如果只是檔名如:demo.log只會在專案的根目錄下生成指定檔名的日誌檔案,,如果想控制日誌路徑,可以選擇完整路徑，如:E:\demo\demo.log

接下來看看自定義配置檔案,這個就要方便很多了,還是喜歡自定義配置檔案的方式

在src/main/resources下面新建檔案logback.xml這個也是spring boot預設的配置檔名,
如果需要自定義檔名,如:logback-test.xml需要在application.properties新增配置
================但是，我們習慣使用logback-spring.xml==========================
logging.config=classpath:logback-test.xml
spring boot預設載入的相關配置檔案,詳見jar包;spring-boot-1.*.*.RELEASE.jar下面
org/springframework/boot/logging/logback/
詳細檔案:

base.xml      			//基礎包,引用了下面所有的配置檔案
console-appender.xml    //控制檯輸出配置
defaults.xml            //預設的日誌檔案配置
file-appender.xml       //檔案輸出配置

複製程式碼

附錄

logback-spring.xml 配置說明

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	
	<!--定義日誌檔案的儲存地址 勿在 LogBack的配置中使用相對路徑 -->
	<property name="LOG_HOME" value="/tmp/log" />
 
	<!-- 控制檯輸出 -->
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern>
		</encoder>
	</appender>
 
	<!-- 按照每天生成日誌檔案 -->
	<appender name="FILE"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<FileNamePattern>${LOG_HOME}/logs/smsismp.log.%d{yyyy-MM-dd}.log</FileNamePattern>
			<!--日誌檔案保留天數 -->
			<MaxHistory>30</MaxHistory>
		</rollingPolicy>
		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
			<!--格式化輸出：%d表示日期，%thread表示執行緒名，%-5level：級別從左顯示5個字元寬度%msg：日誌訊息，%n是換行符 -->
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern>
		</encoder>
		<!--日誌檔案最大的大小 -->
		<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
			<MaxFileSize>10MB</MaxFileSize>
		</triggeringPolicy>
	</appender>
	 
	<!-- 日誌輸出級別 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
 
	<!-- 定義各個包的詳細路徑，繼承root寶的值 -->
	<logger name="com.hry.spring.log" level="INFO" />
	<logger name="com.hry.spring" level="TRACE" />
 	
 	<!-- 此值由 application.properties的spring.profiles.active=dev指定-->
	<springProfile name="dev">
		<!--定義日誌檔案的儲存地址 勿在 LogBack 的配置中使用相對路徑 -->
		<property name="LOG_HOME" value="/tmp/log" />
		<logger name="org.springboot.sample" level="DEBUG" />
	</springProfile>
 
	<springProfile name="pro">
		<!--定義日誌檔案的儲存地址 勿在 LogBack 的配置中使用相對路徑 -->
		<property name="LOG_HOME" value="/home" />
		<logger name="org.springboot.sample2" level="INFO" />
	</springProfile>
	
</configuration>

複製程式碼

部分說明

appender name="STDOUT": 日誌列印到控制檯

appender name="FILE"： 日誌按日列印到檔案中，最多保留MaxHistory天，每個檔案大水為MaxFileSize

encoder：定義輸出格式

<root level="INFO">： 定義根logger，通過appender-ref指定前方定義的appender

<logger name="com.hry.spring.log" level="INFO" />：在繼承root的logger上對com.hry.spring.log包日誌作特殊處理

<springProfile name="dev">： 定義profile的值，只有特定profile的情況下，此間定義的內容才啟作用
application.properties 啟動dev配置資訊 
    server.port=8080
    spring.profiles.active=dev
spring.profiles.active指定本次啟動的active的值是什麼。本次是dev，則logback-spring.xml裡<springProfile name="dev">的內容啟作用
複製程式碼

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class LogApplication {
	private static final Logger log = LoggerFactory.getLogger(LogApplication.class);
	public static void main(String[] args) {
		String str1 = "string1";
		String str2 = "string2";
		log.info("Begin Start {}...{}", str1, str2);
		SpringApplication.run(LogApplication.class, args);
		log.info("Stop ...");
	}
}
複製程式碼

logback-spring.xml 其他的寫法


<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <logger name="org.springframework.web" level="INFO"/>
    <logger name="org.springboot.sample" level="TRACE" />
   
    <!-- 測試環境+開發環境. 多個使用逗號隔開. -->
     <springProfile name="test,dev">
        <logger name="org.springframework.web" level="DEBUG"/>
        <logger name="org.springboot.sample" level="DEBUG" />
        <logger name="com.example" level="DEBUG" />
    </springProfile>
 
   
    <!-- 生產環境. -->
    <springProfile name="prod">
        <logger name="org.springframework.web" level="ERROR"/>
        <logger name="org.springboot.sample" level="ERROR" />
        <logger name="com.example" level="ERROR" />
    </springProfile>
</configuration>
複製程式碼

這裡說明一下：

引入的base.xml是Spring Boot的日誌系統預先定義了一些系統變數的基礎配置檔案
在application.properties中設定環境為prod，則只會列印error級別日誌
如果在application.properties中定義了相同的配置，則application.properties的日誌優先順序更高

可以在內部進行引用

<?xml version="1.0" encoding="utf-8"?>
<configuration scan="true" scanPeriod="10 seconds">

    <!-- 檔案輸出格式 -->
    <property name="pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} -%5p ${PID:-} [%15.15t] %-40.40logger{39} : %m%n" />
    <property name="charsetEncoding" value="UTF-8" />
    <!--<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>-->

    <!--控制檯日誌-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="file" class="ch.qos.logback.core.FileAppender">
        <file>./logback/logfile.log</file>
        <append>true</append>
        <encoder>
            <pattern>${pattern}</pattern>
            <charset>${charsetEncoding}</charset>
        </encoder>
    </appender>

    <appender name="dailyRollingFileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>./logback/log.log</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- daily rollover -->
            <FileNamePattern>logback.%d{yyyy-MM-dd_HH}.log</FileNamePattern>
            <!-- keep 30 days' worth of history -->
            <maxHistory>7</maxHistory>
        </rollingPolicy>
        <encoder>
            <Pattern>${pattern}</Pattern>
        </encoder>
    </appender>

    <logger name="org.springframework.web" level="debug"/>
    <!-- show parameters for hibernate sql 專為 Hibernate 定製 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />

    <!--myibatis log configure-->
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>

    <root level="debug">
        <appender-ref ref="console"/>
        <appender-ref ref="dailyRollingFileAppender"/>
        <appender-ref ref="file"/>
    </root>
</configuration>
複製程式碼

SpringBoot切換預設日誌框架
2020-10-12
Spring Boot框架
Springboot 整合logback 日誌框架簡介
2019-03-04
Spring Boot框架
SpringBoot 整合 Log4j2 日誌框架
2021-01-22
Spring Boot框架
SpringBoot整合Log4j2日誌框架
2024-03-06
Spring Boot框架
SpringBoot日誌管理
2020-12-16
Spring Boot
springboot日誌篇
2017-09-10
Spring Boot
SpringBoot接入輕量級分散式日誌框架（GrayLog）
2022-03-14
Spring Boot分散式框架
日誌框架學習
2022-01-28
框架
55.SpringBoot日誌
2020-12-21
Spring Boot
Springboot日誌相關
2020-10-28
Spring Boot
SpringBoot日誌實現
2020-10-09
Spring Boot
日誌採集框架Flume
2020-10-06
框架
SpringBoot使用ELK日誌收集
2019-03-01
Spring Boot
SpringBoot專案整合日誌
2019-02-12
Spring Boot
logstash收集springboot日誌
2021-04-28
Spring Boot
Springboot漫遊日誌（1）
2020-12-06
Spring Boot
日誌框架SLF4J
2020-04-05
框架
Java日誌框架演化歷史
2021-09-09
Java框架
掌握Java各種日誌框架
2022-02-23
Java框架
Java 日誌框架 Logback
2018-05-13
Java框架
Java日誌框架那些事兒
2017-11-28
Java框架
jdon框架日誌資訊錯誤
2007-06-07
框架
delphi xe 好用的日誌框架
2024-03-09
框架
SpringBoot | SpringBoot 是如何實現日誌的？
2019-03-24
Spring Boot
SpringBoot指定日誌檔案和日誌Profile功能
2018-11-10
Spring Boot
java 日誌脫敏框架 sensitive，優雅的列印脫敏日誌
2019-01-19
Java框架
Spring Boot日誌框架實踐
2019-03-04
Spring Boot框架
日誌框架體系整理( 基礎 )
2022-05-24
框架
SpringBoot記錄HTTP請求日誌
2018-08-29
Spring BootHTTP
SpringBoot | 第二十四章：日誌管理之AOP統一日誌
2021-09-09
Spring Boot
SLF4J記錄日誌&&日誌檔案的滾動策略__SpringBoot
2024-03-22
Spring Boot
【知識點】C++的日誌框架
2021-07-10
C++框架
帶你掌握Java各種日誌框架
2022-02-21
Java框架
Java日誌框架：logback詳解
2018-04-01
Java框架
CocoaLumberjack（DDLog）日誌框架使用
2017-12-14
框架
SpringBoot自定義註解、AOP列印日誌
2019-05-11
Spring Boot
SpringBoot第十三篇：日誌處理
2019-06-04
Spring Boot
SpringBoot 實戰 (七) | 預設日誌配置
2019-02-18
Spring Boot