SpringBoot默認日志logback配置解析

前言

今天來介紹下Spring Boot如何配置日志logback,我剛學習的時候，是帶著下面幾個問題來查資料的，你呢

• 如何引入日志？
• 日志輸出格式以及輸出方式如何配置？
• 代碼中如何使用？

正文

Spring Boot在所有內(nèi)部日志中使用Commons Logging，但是默認配置也提供了對常用日志的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每種Logger都可以通過配置使用控制臺或者文件輸出日志內(nèi)容。

默認日志Logback

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

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

默認情況下，Spring Boot會用Logback來記錄日志，并用INFO級別輸出到控制臺。在運行應用程序和其他例子時，你應該已經(jīng)看到很多INFO級別的日志了。

從上圖可以看到，日志輸出內(nèi)容元素具體如下：

• 時間日期：精確到毫秒
• 日志級別：ERROR, WARN, INFO, DEBUG or TRACE
• 進程ID
• 分隔符：--- 標識實際日志的開始
• 線程名：方括號括起來（可能會截斷控制臺輸出）
• Logger名：通常使用源代碼的類名
• 日志內(nèi)容

添加日志依賴

假如maven依賴中添加了spring-boot-starter-logging：

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

那么，我們的Spring Boot應用將自動使用logback作為應用日志框架，Spring Boot啟動的時候，由org.springframework.boot.logging.Logging-Application-Listener根據(jù)情況初始化并使用。

但是呢，實際開發(fā)中我們不需要直接添加該依賴，你會發(fā)現(xiàn)spring-boot-starter其中包含了 spring-boot-starter-logging，該依賴內(nèi)容就是 Spring Boot 默認的日志框架 logback。而博主這次項目的例子是基于上一篇的，工程中有用到了Thymeleaf，而Thymeleaf依賴包含了spring-boot-starter，最終我只要引入Thymeleaf即可。

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

默認配置屬性支持

Spring Boot為我們提供了很多默認的日志配置，所以，只要將spring-boot-starter-logging作為依賴加入到當前應用的classpath，則“開箱即用”。
下面介紹幾種在application.properties就可以配置的日志相關屬性。

控制臺輸出

日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置為WARN，則低于WARN的信息都不會輸出。
Spring Boot中默認配置ERROR、WARN和INFO級別的日志輸出到控制臺。您還可以通過啟動您的應用程序–debug標志來啟用“調(diào)試”模式（開發(fā)的時候推薦開啟）,以下兩種方式皆可：

• 在運行命令后加入--debug標志，如：$ java -jar springTest.jar --debug
• 在application.properties中配置debug=true，該屬性置為true的時候，核心Logger（包含嵌入式容器、hibernate、spring）會輸出更多內(nèi)容，但是你自己應用的日志并不會輸出為DEBUG級別。

文件輸出

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

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

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

注：二者不能同時使用，如若同時使用，則只有l(wèi)ogging.file生效

默認情況下，日志文件的大小達到10MB時會切分一次，產(chǎn)生新的日志文件，默認級別為：ERROR、WARN、INFO

級別控制

所有支持的日志記錄系統(tǒng)都可以在Spring環(huán)境中設置記錄級別（例如在application.properties中）
格式為：’logging.level.* = LEVEL’

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

舉例：

• logging.level.com.dudu=DEBUG：com.dudu包下所有class以DEBUG級別輸出
• logging.level.root=WARN：root日志以WARN級別輸出

自定義日志配置

由于日志服務一般都在ApplicationContext創(chuàng)建前就初始化了，它并不是必須通過Spring的配置文件控制。因此通過系統(tǒng)屬性和傳統(tǒng)的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根據(jù)不同的日志系統(tǒng)，你可以按如下規(guī)則組織配置文件名，就能被正確加載：

• 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官方推薦優(yōu)先使用帶有-spring的文件名作為你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名為logback-spring.xml的日志配置文件，spring boot可以為它添加一些spring boot特有的配置項（下面會提到）。

上面是默認的命名規(guī)則，并且放在src/main/resources下面即可。

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

logging.config=classpath:logging-config.xml

雖然一般并不需要改變配置文件的名字，但是如果你想針對不同運行時Profile使用不同的日
志配置，這個功能會很有用。

下面我們來看看一個普通的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="/Users/tengjun/Documents/log" /><!--輸出到控制臺--><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>ERROR</level></filter>--><encoder><pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %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.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern></rollingPolicy><encoder><pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender><root level="info"><appender-ref ref="console" /><appender-ref ref="file" /></root><!-- logback為java中的包 --><logger name="com.dudu.controller"/><!--logback.LogbackDemo：類的全路徑 --><logger name="com.dudu.controller.LearnController" level="WARN" additivity="false"><appender-ref ref="console"/></logger> </configuration>

根節(jié)點包含的屬性

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

根節(jié)點的子節(jié)點：下面一共有2個屬性，3個子節(jié)點，分別是：

屬性一：設置上下文名稱``

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

<contextName>logback</contextName>

屬性二：設置變量``

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

<property name="log.path" value="/Users/tengjun/Documents/log" />

子節(jié)點一``

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

控制臺輸出ConsoleAppender：

<!--輸出到控制臺--> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>ERROR</level></filter><encoder><pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern></encoder> </appender>

``表示對日志進行編碼：

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

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

輸出到文件RollingFileAppender

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

<!--輸出到文件--> <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern><maxHistory>30</maxHistory><totalSizeCap>1GB</totalSizeCap></rollingPolicy><encoder><pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern></encoder> </appender>

其中重要的是rollingPolicy的定義，上例中${log.path}/logback.%d{yyyy-MM-dd}.log定義了日志的切分方式——把每一天的日志歸檔到一個文件中，30表示只保留最近30天的日志，以防止日志填滿整個磁盤空間。同理，可以使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日志切分方式。1GB用來指定日志文件的上限大小，例如設置為1GB的話，那么到了這個值，就會刪除舊的日志。

補:如果你想把日志直接放到當前項目下，把${log.path}/去掉即可。

logback 每天生成和大小生成沖突的問題可以看這個解答：傳送門

子節(jié)點二

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

• level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設置為INHERITED或者同義詞NULL。
  默認是DEBUG。
  可以包含零個或多個元素，標識這個appender將會添加到這個logger。

  <root level="debug"><appender-ref ref="console" /><appender-ref ref="file" /> </root>

子節(jié)點三``

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

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

logger在實際使用的時候有兩種情況
先來看一看代碼中如何使用

package com.chenwei.cwblog.controller;@RestController public class testLogbackController1 {private Logger logger = LoggerFactory.getLogger(this.getClass());@RequestMapping(value = "/testLogbackController1",method = RequestMethod.GET)public void login(HttpServletRequest request, HttpServletResponse response){//日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置為WARN，則低于WARN的信息都不會輸出。logger.trace("日志輸出 trace");logger.debug("日志輸出 debug");logger.info("日志輸出 info");logger.warn("日志輸出 warn");logger.error("日志輸出 error");} }

這是一個登錄的判斷的方法，我們引入日志，并且打印不同級別的日志，然后根據(jù)logback-spring.xml中的配置來看看打印了哪幾種級別日志。

第一種：帶有l(wèi)ogger的配置，不指定級別，不指定appender

<logger name="com.chenwei.cwblog.controller"/>

將控制controller包下的所有類的日志的打印，但是并沒用設置打印級別，所以繼承他的上級的日志級別“info”；
沒有設置addtivity，默認為true，將此logger的打印信息向上級傳遞；
沒有設置appender，此logger本身不打印任何信息。
``將root的打印級別設置為“info”，指定了名字為“console”的appender。

當執(zhí)行com.chenwei.cwblog.controlle，testLogbackController1 在包com.chenwei.cwblog.controlle中，所以首先執(zhí)行``，將級別為“info”及大于“info”的日志信息傳遞給root，本身并不打印；
root接到下級傳遞的信息，交給已經(jīng)配置好的名為“console”的appender處理，“console”appender將信息打印到控制臺；

**打印結(jié)果如下：**在log文件中

16:40:51.466 logback [http-nio-8080-exec-1] INFO c.c.c.c.testLogbackController1 - 日志輸出 info 16:40:51.466 logback [http-nio-8080-exec-1] WARN c.c.c.c.testLogbackController1 - 日志輸出 warn 16:40:51.466 logback [http-nio-8080-exec-1] ERROR c.c.c.c.testLogbackController1 - 日志輸出 error

第二種：帶有多個logger的配置，指定級別，指定appender

<logger name="com.chenwei.cwblog.controller.testLogbackController1" level="WARN" additivity="false"><appender-ref ref="console"/> </logger>

將級別為“WARN”及大于“WARN”的日志信息交給此logger指定的名為“console”的appender處理，在控制臺中打出日志，不再向上級root傳遞打印信息。 **打印結(jié)果如下：**控制臺

16:59:51.559 logback [http-nio-8080-exec-1] WARN c.c.c.c.testLogbackController1 - 日志輸出 warn 16:59:51.559 logback [http-nio-8080-exec-1] ERROR c.c.c.c.testLogbackController1 - 日志輸出 error

當然如果你把additivity=”false”改成additivity=”true”的話，就會打印兩次，因為打印信息向上級傳遞，logger本身打印一次，root接到后又打印一次。

注：使用mybatis的時候，sql語句是debug下才會打印，而這里我們只配置了info，所以想要查看sql語句的話，有以下兩種操作：

• 第一種把改成這樣就會打印sql，不過這樣日志那邊會出現(xiàn)很多其他消息。

• 第二種就是單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql語句會打印，其他還是正常info級別：

  <logger name="com.dudu.dao" level="DEBUG" additivity="false"><appender-ref ref="console" /> </logger>

多環(huán)境日志輸出

據(jù)不同環(huán)境（prod:生產(chǎn)環(huán)境，test:測試環(huán)境，dev:開發(fā)環(huán)境）來定義不同的日志輸出，在 logback-spring.xml中使用 springProfile 節(jié)點來定義，方法如下：

文件名稱不是logback.xml，想使用spring擴展profile支持，要以logback-spring.xml命名

<!-- 測試環(huán)境+開發(fā)環(huán)境. 多個使用逗號隔開. --> <springProfile name="test,dev"><logger name="com.dudu.controller" level="info" /> </springProfile> <!-- 生產(chǎn)環(huán)境. --> <springProfile name="prod"><logger name="com.dudu.controller" level="ERROR" /> </springProfile>

可以啟動服務的時候指定 profile （如不指定使用默認），如指定prod 的方式為： java -jar xxx.jar –spring.profiles.active=prod 關于多環(huán)境配置可以參考

總結(jié)

到此為止終于介紹完日志框架了，平時使用的時候推薦用自定義logback-spring.xml來配置，代碼中使用日志也很簡單，類里面添加private Logger logger = LoggerFactory.getLogger(this.getClass());即可。

總結(jié)

以上是生活随笔為你收集整理的SpringBoot默认日志logback配置解析的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。