012-日志

springboot默認日志?Logback。

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



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

1 時間日期:精確到毫秒

2 日志級別:ERROR, WARN, INFO, DEBUG or TRACE

3 進程ID

4 分隔符:— 標識實際日志的開始

5 線程名:方括號括起來(可能會截斷控制臺輸出)

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

7 日志內容


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


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


日志級別從低到高分為:

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

如果設置為?WARN?,則低于?WARN?的信息都不會輸出。?Spring Boot中默認配置ERROR、WARN和INFO級別的日志輸出到控制臺。?

還可以通過啟動應用程序?--debug?標志來啟用“調試”模式(開發的時候推薦開啟),以下兩種方式皆可:

1?在運行命令后加入--debug標志,如:$ java -jar springTest.jar --debug

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




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


在配置文件配置格式


在配置文件配置路徑

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

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

2? logging.path,設置目錄,會在該目錄下創建spring.log文件,并寫入日志內容,如:logging.path=/var/log?

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

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


注:二者不能同時使用,如若同時使用,則只有logging.file生效?

默認情況下,日志文件的大小達到10MB時會切分一次,產生新的日志文件,默認級別為:ERROR、WARN、INFO






所有支持的日志記錄系統都可以在Spring環境中設置記錄級別(例如在application.properties中)?

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

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級別輸出





自定義日志配置

可以單獨定義一個日志的配置文件,格式為XML。

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

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特有的配置項(下面會提到)。?

默認的命名規則,并且放在?src/main/resources?下面即可

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

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


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

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




根節點包含的屬性

日志自定義配置文件為xml文件,根節點為<configuration>,有幾個默認屬性。

scan:當此屬性設置為true時,配置文件如果發生改變,將會被重新加載,默認值為true。

scanPeriod:設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan為true時,此屬性生效。默認的時間間隔為1分鐘。

debug:當此屬性設置為true時,將打印出logback內部日志信息,實時查看logback運行狀態。默認值為false。

根節點有5個子節點,下面一一會詳細介紹。




子節點一?

root節點是必選節點,用來指定最基礎的日志輸出級別,只有一個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>





子節點二:?設置上下文名稱

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

1? <contextName>logback</contextName>



子節點三:?設置變量

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

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

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

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





子節點四:

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

控制臺輸出ConsoleAppender:



可以看到layout和encoder,都可以將事件轉換為格式化后的日志記錄,但是控制臺輸出使用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


針對上面兩個例子的格式進行說明:

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

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

%thread——輸出日志的進程名字,這在Web應用以及異步任務處理中很有用

%-5level——日志級別,并且使用5個字符靠左對齊

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

%msg——日志消息

%n——平臺的換行符?

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



輸出到文件?RollingFileAppender

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



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




子節點五<loger>

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

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

2? level:用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。如果未設置此屬性,那么當前loger將會繼承上級的級別。

3? addtivity:是否向上級loger傳遞打印信息。默認是true。


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


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


第一種:帶有loger的配置,不指定級別,不指定appender

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

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


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

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

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

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

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

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

打印結果如下:



第二種:帶有多個loger的配置,指定級別,指定appender

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


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

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

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

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

打印結果如下:


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

注意:


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




多環境日志輸出


application.yml增加環境選擇的配置active: dev


active: 【test、dev、prod】,根據?active?的環境,自動采用上面配置的springProfile的?logger?日志




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

application.yml增加日志相關自定義配置


在logback-spring.xml:


最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

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