012-日志

springboot默認(rèn)日志?Logback。

默認(rèn)情況下,Spring Boot會(huì)用Logback來記錄日志,并用INFO級(jí)別輸出到控制臺(tái)。在運(yùn)行應(yīng)用程序和其他例子時(shí),你應(yīng)該已經(jīng)看到很多INFO級(jí)別的日志了。



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

1 時(shí)間日期:精確到毫秒

2 日志級(jí)別:ERROR, WARN, INFO, DEBUG or TRACE

3 進(jìn)程ID

4 分隔符:— 標(biāo)識(shí)實(shí)際日志的開始

5 線程名:方括號(hào)括起來(可能會(huì)截?cái)嗫刂婆_(tái)輸出)

6 Logger名:通常使用源代碼的類名

7 日志內(nèi)容


日志功能也需要添加依賴:


但是實(shí)際開發(fā)中,我們常用的spring-boot-starter-web,spring-boot-starter等等常用的依賴中都包含了日志依賴,所以我們不需要再顯式的依賴日志。


日志級(jí)別從低到高分為:

TRACE?<?DEBUG?<?INFO?<?WARN?<?ERROR?<?FATAL。

如果設(shè)置為?WARN?,則低于?WARN?的信息都不會(huì)輸出。?Spring Boot中默認(rèn)配置ERROR、WARN和INFO級(jí)別的日志輸出到控制臺(tái)。?

還可以通過啟動(dòng)應(yīng)用程序?--debug?標(biāo)志來啟用“調(diào)試”模式(開發(fā)的時(shí)候推薦開啟),以下兩種方式皆可:

1?在運(yùn)行命令后加入--debug標(biāo)志,如:$ java -jar springTest.jar --debug

2?在application.properties中配置debug=true,該屬性置為true的時(shí)候,核心Logger(包含嵌入式容器、hibernate、spring)會(huì)輸出更多內(nèi)容,但是你自己應(yīng)用的日志并不會(huì)輸出為DEBUG級(jí)別。




默認(rèn)情況下,Spring Boot將日志輸出到控制臺(tái),不會(huì)寫到日志文件。如果使用Spring Boot只在application.properties或application.yml配置,這樣只能配置簡單的場景,保存路徑、日志格式等,復(fù)雜的場景(區(qū)分 info 和 error 的日志、每天產(chǎn)生一個(gè)日志文件等)滿足不了,只能自定義配置,下面會(huì)演示。


在配置文件配置格式


在配置文件配置路徑

如果要編寫除控制臺(tái)輸出之外的日志文件,則需在application.properties中設(shè)置logging.file或logging.path屬性。

1? logging.file,設(shè)置文件,可以是絕對(duì)路徑,也可以是相對(duì)路徑。如:logging.file=my.log

2? logging.path,設(shè)置目錄,會(huì)在該目錄下創(chuàng)建spring.log文件,并寫入日志內(nèi)容,如:logging.path=/var/log?

3? 如果只配置?logging.file,會(huì)在項(xiàng)目的當(dāng)前路徑下生成一個(gè)?xxx.log?日志文件。?

4? 如果只配置?logging.path,在?/var/log文件夾生成一個(gè)日志文件為?spring.log


注:二者不能同時(shí)使用,如若同時(shí)使用,則只有l(wèi)ogging.file生效?

默認(rèn)情況下,日志文件的大小達(dá)到10MB時(shí)會(huì)切分一次,產(chǎn)生新的日志文件,默認(rèn)級(jí)別為:ERROR、WARN、INFO






所有支持的日志記錄系統(tǒng)都可以在Spring環(huán)境中設(shè)置記錄級(jí)別(例如在application.properties中)?

格式為:logging.level.路徑或者Logger名 = 等級(jí)

logging.level:日志級(jí)別控制前綴,*為包名或Logger名?

LEVEL:選項(xiàng)TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例:

logging.level.com.dudu=DEBUG? #com.dudu包下所有class以DEBUG級(jí)別輸出

logging.level.root=WARN? #root日志以WARN級(jí)別輸出





自定義日志配置

可以單獨(dú)定義一個(gè)日志的配置文件,格式為XML。

根據(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特有的配置項(xiàng)(下面會(huì)提到)。?

默認(rèn)的命名規(guī)則,并且放在?src/main/resources?下面即可

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

1? logging.config=classpath:logging-config.xml


雖然一般并不需要改變配置文件的名字,但是如果你想針對(duì)不同運(yùn)行時(shí)Profile使用不同的日志配置,這個(gè)功能會(huì)很有用。?

一般不需要這個(gè)屬性,而是直接在logback-spring.xml中使用springProfile配置,不需要logging.config指定不同環(huán)境使用不同配置文件。springProfile配置在下面介紹。




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

日志自定義配置文件為xml文件,根節(jié)點(diǎn)為<configuration>,有幾個(gè)默認(rèn)屬性。

scan:當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會(huì)被重新加載,默認(rèn)值為true。

scanPeriod:設(shè)置監(jiān)測配置文件是否有修改的時(shí)間間隔,如果沒有給出時(shí)間單位,默認(rèn)單位是毫秒。當(dāng)scan為true時(shí),此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。

debug:當(dāng)此屬性設(shè)置為true時(shí),將打印出logback內(nèi)部日志信息,實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。

根節(jié)點(diǎn)有5個(gè)子節(jié)點(diǎn),下面一一會(huì)詳細(xì)介紹。




子節(jié)點(diǎn)一?

root節(jié)點(diǎn)是必選節(jié)點(diǎn),用來指定最基礎(chǔ)的日志輸出級(jí)別,只有一個(gè)level屬性。

level:用來設(shè)置打印級(jí)別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設(shè)置為INHERITED或者同義詞NULL。?

默認(rèn)是DEBUG。?

可以包含零個(gè)或多個(gè)元素,標(biāo)識(shí)這個(gè)appender將會(huì)添加到這個(gè)logger。

<root level="debug">

? ? <appender-ref ref="console" />

? ? <appender-ref ref="file" />

</root>





子節(jié)點(diǎn)二:?設(shè)置上下文名稱

每個(gè)logger都關(guān)聯(lián)到logger上下文,默認(rèn)上下文名稱為“default”。但可以使用設(shè)置成其他名字,用于區(qū)分不同應(yīng)用程序的記錄。一旦設(shè)置,不能修改,可以通過%contextName來打印日志上下文名稱,一般來說我們不用這個(gè)屬性,可有可無。

1? <contextName>logback</contextName>



子節(jié)點(diǎn)三:?設(shè)置變量

用來定義變量值的標(biāo)簽, 有兩個(gè)屬性,name和value;其中name的值是變量的名稱,value的值時(shí)變量定義的值。通過定義的值會(huì)被插入到logger上下文中。定義變量后,可以使“${}”來使用變量。

1? <property name="logback.logdir" value="/Users/inke/dev/log/tomcat"/>

2? <property name="logback.appname" value="app"/>

這里可以看后通過 application.yml 傳遞參數(shù)過來。





子節(jié)點(diǎn)四:

appender用來格式化日志輸出節(jié)點(diǎn),有倆個(gè)屬性name和class,class用來指定哪種輸出策略,常用就是控制臺(tái)輸出策略和文件輸出策略。

控制臺(tái)輸出ConsoleAppender:



可以看到layout和encoder,都可以將事件轉(zhuǎn)換為格式化后的日志記錄,但是控制臺(tái)輸出使用layout,文件輸出使用encoder,具體原因可以看http://blog.csdn.net/cw_hello1/article/details/51969554



輸出日志:

18:15:22.148 logback-demo [http-nio-9010-exec-1] INFO c.e.demo.controller.UserContorller - 日志輸出 info

18:15:22.148 logback-demo [http-nio-9010-exec-1] WARN c.e.demo.controller.UserContorller - 日志輸出 warn

18:15:22.148 logback-demo [http-nio-9010-exec-1] ERROR c.e.demo.controller.UserContorller - 日志輸出 error

18:15:22.148 logback-demo [http-nio-9010-exec-1] INFO c.e.demo.controller.UserContorller - name:inke , age:33

18:15:22.149 logback-demo [http-nio-9010-exec-1] INFO c.e.demo.controller.UserContorller - name:inke , age:33


針對(duì)上面兩個(gè)例子的格式進(jìn)行說明:

<encoder>表示對(duì)日志進(jìn)行編碼:

%d{HH: mm:ss.SSS}——日志輸出時(shí)間

%thread——輸出日志的進(jìn)程名字,這在Web應(yīng)用以及異步任務(wù)處理中很有用

%-5level——日志級(jí)別,并且使用5個(gè)字符靠左對(duì)齊

%logger{36}——日志輸出者的名字

%msg——日志消息

%n——平臺(tái)的換行符?

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



輸出到文件?RollingFileAppender

另一種常見的是日志輸出到文件,隨著應(yīng)用的運(yùn)行時(shí)間越來越長,日志也會(huì)增長的越來越多,將他們輸出到同一個(gè)文件并非一個(gè)好辦法。RollingFileAppender用于切分文件日志:



如果同時(shí)有<File>和<FileNamePattern>,根據(jù)日期分割日志,代碼注釋寫的很清楚了。?




子節(jié)點(diǎn)五<loger>

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

1? name:用來指定受此loger約束的某一個(gè)包或者具體的某一個(gè)類。

2? level:用來設(shè)置打印級(jí)別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個(gè)特俗值INHERITED或者同義詞NULL,代表強(qiáng)制執(zhí)行上級(jí)的級(jí)別。如果未設(shè)置此屬性,那么當(dāng)前l(fā)oger將會(huì)繼承上級(jí)的級(jí)別。

3? addtivity:是否向上級(jí)loger傳遞打印信息。默認(rèn)是true。


loger在實(shí)際使用的時(shí)候有兩種情況 ,先來看一看代碼中如何使用:


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


第一種:帶有l(wèi)oger的配置,不指定級(jí)別,不指定appender

logback-spring.xml增加?loger?配置如下:

<logger name="com.dudu.controller"/>


<logger name="com.dudu.controller" />將控制controller包下的所有類的日志的打印,但是并沒用設(shè)置打印級(jí)別,所以繼承他的上級(jí)的日志級(jí)別“info”;?

沒有設(shè)置addtivity,默認(rèn)為true,將此loger的打印信息向上級(jí)傳遞;?

沒有設(shè)置appender,此loger本身不打印任何信息。?

<root level="info">將root的打印級(jí)別設(shè)置為“info”,指定了名字為“console”的appender。

當(dāng)執(zhí)行com.dudu.controller.LearnController類的login方法時(shí),LearnController?在包c(diǎn)om.dudu.controller中,所以首先執(zhí)行<logger name="com.dudu.controller"/>,將級(jí)別為“info”及大于“info”的日志信息傳遞給root,本身并不打?。?

root接到下級(jí)傳遞的信息,交給已經(jīng)配置好的名為“console”的appender處理,“console”?appender?將信息打印到控制臺(tái);

打印結(jié)果如下:



第二種:帶有多個(gè)loger的配置,指定級(jí)別,指定appender

logback-spring.xml增加?loger?配置如下:


控制com.dudu.controller.LearnController類的日志打印,打印級(jí)別為“WARN”;?

additivity屬性為false,表示此loger的打印信息不再向上級(jí)傳遞;?

指定了名字為“console”的appender;

這時(shí)候執(zhí)行com.dudu.controller.LearnController類的login方法時(shí),先執(zhí)行<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">,將級(jí)別為“WARN”及大于“WARN”的日志信息交給此loger指定的名為“console”的appender處理,在控制臺(tái)中打出日志,不再向上級(jí)root傳遞打印信息。

打印結(jié)果如下:


當(dāng)然如果你把a(bǔ)dditivity="false"改成additivity="true"的話,就會(huì)打印兩次,因?yàn)榇蛴⌒畔⑾蛏霞?jí)傳遞,logger本身打印一次,root接到后又打印一次。

注意:


范圍有重疊的話,范圍小的,有效。




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


application.yml增加環(huán)境選擇的配置active: dev


active: 【test、dev、prod】,根據(jù)?active?的環(huán)境,自動(dòng)采用上面配置的springProfile的?logger?日志




自定義日志路徑(application.yml)

application.yml增加日志相關(guān)自定義配置


在logback-spring.xml:


最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 談到日志,目前常用的Log4J和LogBack,還有Log4J2,其實(shí)這些都是一個(gè)人寫的,這個(gè)高人到底是誰,網(wǎng)上搜...
    孔垂云閱讀 1,075評(píng)論 1 1
  • 現(xiàn)在是凌晨一點(diǎn)多,喜歡夜生活的人,這個(gè)時(shí)間才是他們精彩生活的開始,今天酒吧里的人很多,在舞池中間里形形色色...
    為佳人zhang閱讀 317評(píng)論 3 2
  • 今天其實(shí)有點(diǎn)不開心,早上跟藍(lán)老師聊了下,他也認(rèn)為我們是玩心太重造成,昨天范老師也是這么認(rèn)為,其實(shí)我心里早也暗暗有這...
    LilyM_海蕾閱讀 154評(píng)論 1 2
  • 101 塵土受人羞辱鄙視, 卻以鮮花回報(bào)世界。 The dust receives insult and in r...
    已惘齋主人閱讀 235評(píng)論 0 1
  • 太多的時(shí)候,我是一個(gè)找不到存在感的、很自卑的人。然而,也有一些時(shí)候,我又會(huì)極度的膨脹,覺得天地間,乃至宇宙,再也找...
    半朽閱讀 881評(píng)論 11 30

友情鏈接更多精彩內(nèi)容