當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

【spring boot】8.spring boot的日志框架logback使用

發布時間：2023/12/6 编程问答 32 豆豆

生活随笔收集整理的這篇文章主要介紹了【spring boot】8.spring boot的日志框架logback使用小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

?在繼續上一篇的Debug調試之后，把spring boot的日志框架使用情況逐步蠶食。

參考：http://tengj.top/2017/04/05/springbo

開篇之前，貼上完整application.properties日志相關配置

=============================================================================================

簡介：spring boot的默認日志框架Logback

SLF4J——Simple Logging Facade For Java，它是一個針對于各類Java日志框架的統一Facade抽象。Java日志框架眾多——常用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定義了統一的日志抽象接口，而真正的日志實現則是在運行時決定的——它提供了各類日志框架的binding。

Logback是log4j框架的作者開發的新一代日志框架，它效率更高、能夠適應諸多的運行環境，同時天然支持SLF4J。

默認情況下，Spring Boot會用Logback來記錄日志，并用INFO級別輸出到控制臺。在剛開始運行一個嶄新的spring boot項目時，你就可以在控制臺看到INFO級別的日志了。

有如下的7各部分：

①時間日期：精確到毫秒
②日志級別：ERROR> WARN>INFO>DEBUG > TRACE　　優先級如前面，默認情況下是INFO，則INFO以及優先級更高的WARN和ERROR會被顯示
③進程ID　　就是PID
④分隔符：--- 標識實際日志的開始
⑤線程名：方括號括起來（可能會截斷控制臺輸出）
⑥Logger名：通常使用源代碼的類名
⑦日志內容

可以從上面看到，這個spring boot是啟動在8928這個進程上的。

在任務管理器中可以看到【如果任務管理的的進程選項卡中看不到PID，http://www.cnblogs.com/sxdcgaq8080/p/7853081.html】

?======================================================================================================

一、在項目application.properties配置就可以使用log功能

1.要在spring boot中使用日志功能，在pom.xml中配置maven架包

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

但是其實是不用配置的，因為在spring-boot-starter-web下已經引用了日志的架包，如下圖：

?2.兩種使用情況

日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置為WARN，則低于WARN的信息都不會輸出。

　　2.1　控制臺輸出

Spring Boot中默認配置ERROR、WARN和INFO級別的日志輸出到控制臺。您還可以通過啟動您的應用程序--debug標志來啟用“調試”模式（開發的時候推薦開啟）,以下兩種方式：

　　　　2.1.1在運行命令后加入--debug標志，如：$ java -jar springTest.jar --debug

　　　　2.1.2在application.properties中配置debug=true，該屬性置為true的時候，核心Logger（包含嵌入式容器、hibernate、spring）會輸出更多內容，但是你自己應用的日志并不會輸出為DEBUG級別。

如下：

配置文件application.properties中配置：

debug=true

啟動，觀察控制臺打印出來的日志如下：

　　2.2文件輸出

默認情況下，Spring Boot將日志輸出到控制臺，不會寫到日志文件。如果要編寫除控制臺輸出之外的日志文件，則需在application.properties中設置logging.file或logging.path屬性。

logging.file，設置文件，可以是絕對路徑，也可以是相對路徑。如：logging.file=my.log
logging.path，設置目錄，會在該目錄下創建spring.log文件，并寫入日志內容，如：logging.path=/var/log

如果只配置 logging.file，會在項目的當前路徑下生成一個 xxx.log 日志文件。

如果只配置 logging.path，在 /var/log文件夾生成一個日志文件為 spring.log

注：二者不能同時使用，如若同時使用，則只有logging.file生效

①默認情況下，日志文件的大小達到10MB時會切分一次，產生新的日志文件

②默認級別為：ERROR、WARN、INFO

　　　　2.2.1　　logging.file，設置文件

　　　　　　2.2.1.1?配置文件application.properties中配置【logging.file ?相對路徑】

logging.file = myloggin.log

生成日志文件在項目【相當于項目根目錄下的相對路徑】

　　　　　　　　2.2.1.2　在配置文件applicarion.properties中配置【logging.file ?絕對路徑】

logging.file = d:/myloggin.log

生成日志文件，位置如下：

　　　　　　2.2.2　logging.path，設置目錄

?　　　　　　　　2.2.2.1　在配置文件appilication.properties中設置【logging.path ?相對路徑】

logging.path = /log

生成日志文件在當前項目所在的磁盤的根目錄下生成一個log文件夾，在文件夾中生成spring.log日志文件【特定名字就是spring.log】

?　　　　　　　　2.2.2.2　在配置文件application.properties中配置【logging.path 絕對路徑】

logging.path = e:/log

會在指定目錄的文件夾中生成spring.log日志文件【特定文件名spring.log】

?=========================================================================================================

二、日志等級在application.properties的控制

?根據開篇貼上的配置文件中的配置屬性，可以看到在application.properties中配置日志等級就是一個配置，

格式為：logging.level.* = LEVEL

logging.level：日志級別控制前綴，*為包名或Logger名
LEVEL：選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例：

logging.level.com.sxd=DEBUG　　com.sxd包下所有class以DEBUG級別輸出，包括其優先級以上
logging.level.root=WARN　　　　root日志以WARN級別輸出，包括其優先級以上

=====================================================================================================

三、完全控制和解析日志配置

1.正經的提出問題：

上面兩步，可以看到日志可以在控制臺或者文件中顯示出來，但是都是統一的樣式，統一的等級，或者只能配置一個路徑。

如果想完全控制日志，

　　　　①例如：我想在控制臺輸出的日志格式是這樣的，但是在文件中能不能以另外一種格式輸出？

?　　　　②例如：我的日志文件輸出，能不能自己控制文件的大小，文件名，日志文件總共多少就得清理？

　　　　③例如：能不能在不同的環境下，有不同的日志操作，比如在生產環境下，我的Service層的日志不會被打印，但是在開發環境下就要被打印出來

等等等等的，如果想完全控制日志的使用，往下看----->

2.慢慢的分析問題：

由于日志服務一般都在ApplicationContext創建前就初始化了，它并不是必須通過Spring的配置文件控制。那現在在application.properties中配置些許的屬性已經不能完全滿足了。

所以通過系統屬性和傳統的Spring Boot外部配置文件才可以很好的支持日志控制和管理。

　　問題1：外部的日志配置文件應該叫什么名字呢？

根據不同的日志系統，你可以按如下規則組織配置文件名，就能被正確加載：

Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2：log4j2-spring.xml, log4j2.xml
JDK (Java Util Logging)：logging.properties

注意：Spring Boot官方推薦優先使用帶有-spring的文件名作為你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名為logback-spring.xml的日志配置文件，spring boot可以為它添加一些spring boot特有的配置項【特有的就是spring boot的profile多環境配置】

　　問題2：日志配置文件應該放在哪里呢？

放在src/main/resources下面即可。

　　問題3：那不使用logback-spring.xml名字，使用自己定義的日志配置文件名行不行？

如果你即想完全掌控日志配置，但又不想用logback.xml作為Logback配置的名字，可以通過logging.config屬性指定自定義的名字：

logging.config=classpath:logging-自定義.xml

　　問題4：那我想使用spring boot的profile多環境配置，日志配置文件應該用什么名字？使用流程是怎么樣？

如果想使用profile多環境配置，

　　第一：日志配置文件名應該定義成logback-spring.xml。

　　第二：然后在日志配置文件中，使用<springProfile name="dev"> ?</springProfile>標簽來包住想要在這種環境下使用的配置。使用如下截圖：

　　第三：最后application.properties配置文件中，選擇激活哪一種或哪幾種環境即可

附錄：?

?在沒有設置profile的情況下，一般啟動情況下，控制臺打印出的日志都能看到這么一句話：

3.拆析一個基本的logback-spring.xml文件

下面粘上一個基本的文件代碼：

<?xml version="1.0" encoding="UTF-8"?><configuration scan="true" scanPeriod="60 seconds" debug="false"><contextName>logback</contextName><property name="log.path" value="E:\\log\\logback.log" /><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>INFO</level></filter><encoder><pattern>控制臺-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger - %msg%n</pattern><charset>GBK</charset></encoder></appender><appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern><maxHistory>30</maxHistory><totalSizeCap>1GB</totalSizeCap></rollingPolicy><encoder><pattern>文件記錄-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern><charset>GBK</charset></encoder></appender><root level="info"><appender-ref ref="console" /><appender-ref ref="file" /></root><logger name="com.sxd.controller"/><logger name="com.sxd.util.LogTestController" level="WARN" additivity="false"><appender-ref ref="console" /></logger></configuration> View Code

根節點<configuration>包含的屬性

scan:當此屬性設置為true時，配置文件如果發生改變，將會被重新加載，默認值為true。
scanPeriod:設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan為true時，此屬性生效。默認的時間間隔為1分鐘。
debug:當此屬性設置為true時，將打印出logback內部日志信息，實時查看logback運行狀態。默認值為false。

根節點<configuration>的子節點：

<configuration>下面一共有2個屬性，3個子節點，分別是：

屬性一：設置上下文名稱<contextName>

每個logger都關聯到logger上下文，默認上下文名稱為“default”。但可以使用<contextName>設置成其他名字，用于區分不同應用程序的記錄。一旦設置，不能修改,可以通過%contextName來打印日志上下文名稱。

<contextName>logback</contextName>

屬性二：設置變量<property>

用來定義變量值的標簽，<property> 有兩個屬性，name和value；其中name的值是變量的名稱，value的值時變量定義的值。通過<property>定義的值會被插入到logger上下文中。定義變量后，可以使“${}”來使用變量。

子節點一<appender>

appender用來格式化日志輸出節點，有倆個屬性name和class，class用來指定哪種輸出策略，常用就是控制臺輸出策略和文件輸出策略。

控制臺輸出ConsoleAppender：

<encoder>表示對日志進行編碼：

%d{HH: mm:ss.SSS}——日志輸出時間
%thread——輸出日志的進程名字，這在Web應用以及異步任務處理中很有用
%-5level——日志級別，并且使用5個字符靠左對齊
%logger{36}——日志輸出者的名字
%msg——日志消息
%n——平臺的換行符

ThresholdFilter為系統定義的攔截器，例如我們用ThresholdFilter來過濾掉ERROR級別以下的日志不輸出到文件中。如果不用記得注釋掉，不然你控制臺會發現沒日志~

輸出到文件RollingFileAppender

另一種常見的日志輸出到文件，隨著應用的運行時間越來越長，日志也會增長的越來越多，將他們輸出到同一個文件并非一個好辦法。RollingFileAppender用于切分文件日志：

其中重要的是rollingPolicy的定義，上例中

<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>定義了日志的切分方式——把每一天的日志歸檔到一個文件中，

<maxHistory>30</maxHistory>表示只保留最近30天的日志，以防止日志填滿整個磁盤空間。

同理，可以使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日志切分方式。

<totalSizeCap>1GB</totalSizeCap>用來指定日志文件的上限大小，例如設置為1GB的話，那么到了這個值，就會刪除舊的日志。

子節點二<root>

root節點是必選節點，用來指定最基礎的日志輸出級別，只有一個level屬性。

level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設置為INHERITED或者同義詞NULL，默認是DEBUG。

<root>可以包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個logger。

子節點三<logger>

<logger>用來設置某一個包或者具體的某一個類的日志打印級別、以及指定<appender>。<loger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。

name:用來指定受此loger約束的某一個包或者具體的某一個類。
level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。如果未設置此屬性，那么當前loger將會繼承上級的級別。
addtivity:是否向上級logger傳遞打印信息。默認是true。

從上面可以看到，logger在實際使用的時候有兩種情況。

然后分別在com.sxd.controller中和com.sxd.util.LogTestController中添加相同的日志打印，分別看看對應上面兩種<logger>的使用情況：

com.sxd.controller.MainController

package com.sxd.controller;import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody;@Controller public class MainController {@RequestMapping("/toLogin")public String hello(){return "login";}Logger logger = LoggerFactory.getLogger(this.getClass());@RequestMapping("/log")@ResponseBodypublic void logTest(){System.out.println("進入Controller日志控制中心----》》》");//日志級別從低到高分別為// TRACE < DEBUG < INFO < WARN < ERROR < FATAL//如果設置為WARN，則WARN以及往上的才能打印出來logger.trace("日志輸出：trace[所有痕跡]");logger.debug("日志輸出：debug[debug調試]");logger.info("日志輸出：info[信息級別]");logger.warn("日志輸出：warn[警告級別]");logger.error("日志輸出：error[錯誤級別]");} } View Code

com.sxd.util.LogTestController

package com.sxd.util;import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody;@Controller public class LogTestController {Logger logger = LoggerFactory.getLogger(this.getClass());@ResponseBody@RequestMapping("/log2")public void logTest(){System.out.println("進入util日志控制中心----》》》");//日志級別從低到高分別為// TRACE < DEBUG < INFO < WARN < ERROR < FATAL//如果設置為WARN，則WARN以及往上的才能打印出來logger.trace("日志輸出：trace[所有痕跡]");logger.debug("日志輸出：debug[debug調試]");logger.info("日志輸出：info[信息級別]");logger.warn("日志輸出：warn[警告級別]");logger.error("日志輸出：error[錯誤級別]");} } View Code

我們引入日志，并且打印不同級別的日志，然后根據logback-spring.xml中的配置來看看打印了哪幾種級別日志。

第一種：帶有loger的配置，不指定級別，不指定appender[對應com.sxd.controller.MainController]

<logger name="com.sxd.controller"/>將控制controller包下的所有類的日志的打印，但是并沒用設置打印級別，所以繼承他的上級<root>的日志級別“info”；

沒有設置addtivity，默認為true，將此loger的打印信息向上級傳遞；

沒有設置appender，此loger本身不打印任何信息。

<root level="info">將root的打印級別設置為“info”，指定了名字為“console”的appender。

當執行com.sxd.controller.MainController類的log方法時，MainController在包com.sxd.controllerr中，所以首先執行<logger name="com.sxd.controller"/>，將級別為“info”及大于“info”的日志信息傳遞給root，本身并不打印；

root接到下級傳遞的信息，交給已經配置好的名為“console”的appender處理，“console”appender將信息打印到控制臺；

打印結果如下：【spring boot日志亂碼的問題】

root接到下級傳遞的信息，交給已經配置好的名為“file”的appender處理，“file”appender將信息寫入到日志文件中，如下；

第二種：帶有多個loger的配置，指定級別，指定appender【對應com.sxd.util.LogTestController】

控制com.sxd.util.LogTestController類的日志打印，打印級別為“WARN”

additivity屬性為false，表示此loger的打印信息不再向上級傳遞

指定了名字為“console”的appender

這時候執行com.sxd.util.LogTestController類的log方法時，先執行<logger name="com.sxd.util.LogTestController" level="WARN" additivity="false">,

將級別為“WARN”及大于“WARN”的日志信息交給此loger指定的名為“console”的appender處理，在控制臺中打出日志，不再向上級root傳遞打印信息。

打印結果如下：

注意1：

當然，此時日志文件中是沒有本次日志的，因為本<logger>中指定了<appender-ref ref="console" />,特意的指出來，在console打印。所以file中并沒有。

注意2：

如果你把additivity="false"改成additivity="true"的話，就會打印兩次，因為打印信息向上級傳遞，logger本身打印一次，root接到后又打印一次。此時，file中也會有日志。

==================================================================完結=================================================================================、

所以，最后的最后。

如果你要在代碼中使用日志的話，僅需要添加

Logger logger = LoggerFactory.getLogger(this.getClass());

然后就可以使用了。

附錄1：spring boot中使用logback日志亂碼處理

附錄2：spring boot中使用logback日志顏色渲染

附錄3：spring boot使用logback-spring.xml文件后，application.properties文件中關于logging的配置還會起作用么？

總結

以上是生活随笔為你收集整理的【spring boot】8.spring boot的日志框架logback使用的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇： Rabbitmq~对Vhost的配置
下一篇： centos 新建swap区文件