默認日志 logback :
默認情況下,spring boot會用logback來記錄日志,并用info級別輸出到控制臺。在運行應用程序和其他例子時,你應該已經看到很多info級別的日志了。
從上圖可以看到,日志輸出內容元素具體如下:
- 時間日期:精確到毫秒
- 日志級別:error, warn, info, debug or trace
- 進程id
- 分隔符:— 標識實際日志的開始
- 線程名:方括號括起來(可能會截斷控制臺輸出)
- logger名:通常使用源代碼的類名
- 日志內容
添加日志依賴
假如maven依賴中添加了 spring-boot-starter-logging :
1
2
3
4
|
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-logging</artifactid> </dependency> |
但是呢,實際開發中我們不需要直接添加該依賴。
你會發現 spring-boot-starter 其中包含了 spring-boot-starter-logging ,該依賴內容就是 spring boot 默認的日志框架 logback 。工程中有用到了 thymeleaf ,而 thymeleaf 依賴包含了 spring-boot-starter ,最終我只要引入 thymeleaf 即可。
1
2
3
4
|
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-thymeleaf</artifactid> </dependency> |
控制臺輸出
日志級別從低到高分為:
1
|
trace < debug < info < warn < error < fatal 。 |
如果設置為 warn ,則低于 warn 的信息都不會輸出。
spring boot 中默認配置 error 、 warn 和 info 級別的日志輸出到控制臺。
您還可以通過啟動您的應用程序 --debug 標志來啟用“調試”模式(開發的時候推薦開啟),以下兩種方式皆可:
- 在運行命令后加入 --debug 標志,如: $ java -jar springtest.jar --debug
- 在 application.properties 中配置 debug=true ,該屬性置為 true 的時候,核心 logger (包含嵌入式容器、hibernate、spring)會輸出更多內容,但是你 自己應用的日志并不會輸出為 debug 級別 。
如果每次都寫這行代碼會很麻煩,可以使用注解,但是需要使用 lombok :
- 添加依賴:
1
2
|
//注解 compile 'org.projectlombok:lombok:1.16.18' |
- 安裝 lombok 的插件:
1
2
3
4
5
|
go to file > settings > plugins click on browse repositories… search for lombok plugin click on install plugin restart android studio |
允許注解處理,settings -> compiler -> annotation processors
可以使用 {} 占位符來拼接字符串,而不需要使用 ““+”” 來連接字符串。
文件輸出
默認情況下,spring boot將日志輸出到控制臺,不會寫到日志文件。
使用 spring boot 喜歡在 application.properties 或 application.yml 配置,這樣只能配置簡單的場景,保存路徑、日志格式等,復雜的場景(區分 info 和 error 的日志、每天產生一個日志文件等)滿足不了,只能自定義配置,下面會演示。
默認會在設置的 path 生成一個 spring.log 文件。
如果要編寫除控制臺輸出之外的日志文件,則需在 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
級別控制
所有支持的日志記錄系統都可以在 spring 環境中設置記錄級別(例如在 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級別輸出
自定義日志配置
根據不同的日志系統,你可以按如下規則組織配置文件名,就能被正確加載:
- 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 配置在下面介紹。
根節點包含的屬性
- scan:當此屬性設置為 true 時,配置文件如果發生改變,將會被重新加載,默認值為 true 。
- scanperiod:設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當 scan 為 true 時,此屬性生效。默認的時間間隔為1分鐘。
- debug:當此屬性設置為 true 時,將打印出 logback 內部日志信息,實時查看 logback 運行狀態。默認值為 false 。
根節點 <configuration> 有5個子節點,下面一一會詳細介紹。
子節點一 <root>
root節點是必選節點,用來指定最基礎的日志輸出級別,只有一個level屬性。
level:用來設置打印級別,大小寫無關:trace, debug, info, warn, error, all 和 off,不能設置為inherited或者同義詞null。
默認是debug。
可以包含零個或多個元素,標識這個appender將會添加到這個loger。
1
2
3
4
|
<root level= "debug" > <appender-ref ref= "console" /> <appender-ref ref= "file" /> </root> |
子節點二: <contextname> 設置上下文名稱
每個logger都關聯到logger上下文,默認上下文名稱為“default”。但可以使用設置成其他名字,用于區分不同應用程序的記錄。一旦設置,不能修改,可以通過 %contextname 來打印日志上下文名稱,一般來說我們不用這個屬性,可有可無。
1
|
<contextname>logback</contextname> |
子節點三: <property> 設置變量
用來定義變量值的標簽, 有兩個屬性,name和value;其中name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量后,可以使“${}”來使用變量。
1
2
|
<property name= "logback.logdir" value= "/users/inke/dev/log/tomcat" /> <property name= "logback.appname" value= "app" /> |
子節點四: <appender>
appender用來格式化日志輸出節點,有倆個屬性name和class,class用來指定哪種輸出策略,常用就是控制臺輸出策略和文件輸出策略。
控制臺輸出 consoleappender :
示例一:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
<?xml version= "1.0" encoding= "utf-8" ?> <configuration scan= "true" scanperiod= "60 seconds" debug= "false" > <contextname>logback-demo</contextname> <!--輸出到控制臺 consoleappender--> <appender name= "consolelog1" class = "ch.qos.logback.core.consoleappender" > <!--展示格式 layout--> <layout class = "ch.qos.logback.classic.patternlayout" > <pattern>%d - 1 %msg%n</pattern> </layout> </appender> <!--輸出到控制臺 consoleappender--> <appender name= "consolelog2" class = "ch.qos.logback.core.consoleappender" > <encoder> <pattern>%d - 2 %msg%n</pattern> </encoder> </appender> <!--指定最基礎的日志輸出級別--> <root level= "info" > <!--appender將會添加到這個loger--> <appender-ref ref= "consolelog1" /> <appender-ref ref= "consolelog2" /> </root> </configuration> |
可以看到 layout 和 encoder ,都可以將事件轉換為格式化后的日志記錄,但是控制臺輸出使用 layout ,文件輸出使用 encoder 。
示例二:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
<?xml version= "1.0" encoding= "utf-8" ?> <configuration scan= "true" scanperiod= "60 seconds" debug= "false" > <contextname>logback-demo</contextname> <!--輸出到控制臺 consoleappender--> <appender name= "consolelog1" class = "ch.qos.logback.core.consoleappender" > <!--展示格式 layout--> <layout class = "ch.qos.logback.classic.patternlayout" > <pattern> <pattern>%d{hh:mm:ss.sss} %contextname [%thread] %-5level %logger{ 36 } - %msg%n</pattern> </pattern> </layout> <!-- <filter class = "ch.qos.logback.classic.filter.thresholdfilter" > <level>error</level> </filter> --> </appender> <!--指定最基礎的日志輸出級別--> <root level= "info" > <!--appender將會添加到這個loger--> <appender-ref ref= "consolelog1" /> <appender-ref ref= "consolelog2" /> </root> </configuration> |
輸出日志:
1
2
3
4
5
|
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 用于切分文件日志:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
<appender name= "fileinfolog" class = "ch.qos.logback.core.rolling.rollingfileappender" > <!--如果只是想要 info 級別的日志,只是過濾 info 還是會輸出 error 日志,因為 error 的級別高, 所以我們使用下面的策略,可以避免輸出 error 的日志--> <filter class = "ch.qos.logback.classic.filter.levelfilter" > <!--過濾 error--> <level>error</level> <!--匹配到就禁止--> <onmatch>deny</onmatch> <!--沒有匹配到就允許--> <onmismatch>accept</onmismatch> </filter> <!--日志名稱,如果沒有file 屬性,那么只會使用filenamepattern的文件路徑規則 如果同時有<file>和<filenamepattern>,那么當天日志是<file>,明天會自動把今天 的日志改名為今天的日期。即,<file> 的日志都是當天的。 --> <file>${logback.logdir}/info.${logback.appname}.log</file> <!--滾動策略,按照時間滾動 timebasedrollingpolicy--> <rollingpolicy class = "ch.qos.logback.core.rolling.timebasedrollingpolicy" > <!--文件路徑,定義了日志的切分方式——把每一天的日志歸檔到一個文件中,以防止日志填滿整個磁盤空間--> <filenamepattern>${logback.logdir}/info.${logback.appname}.%d{yyyy-mm-dd}.log</filenamepattern> <!--只保留最近 90 天的日志--> <maxhistory> 90 </maxhistory> <!--用來指定日志文件的上限大小,那么到了這個值,就會刪除舊的日志--> <!--<totalsizecap>1gb</totalsizecap>--> </rollingpolicy> <!--日志輸出編碼格式化--> <encoder> <charset>utf- 8 </charset> <pattern>%d [%thread] %-5level %logger{ 36 } %line - %msg%n</pattern> </encoder> </appender> <appender name= "fileerrorlog" class = "ch.qos.logback.core.rolling.rollingfileappender" > <!--如果只是想要 error 級別的日志,那么需要過濾一下,默認是 info 級別的,thresholdfilter--> <filter class = "ch.qos.logback.classic.filter.thresholdfilter" > <level>error</level> </filter> <!--日志名稱,如果沒有file 屬性,那么只會使用filenamepattern的文件路徑規則 如果同時有<file>和<filenamepattern>,那么當天日志是<file>,明天會自動把今天 的日志改名為今天的日期。即,<file> 的日志都是當天的。 --> <file>${logback.logdir}/error.${logback.appname}.log</file> <!--滾動策略,按照時間滾動 timebasedrollingpolicy--> <rollingpolicy class = "ch.qos.logback.core.rolling.timebasedrollingpolicy" > <!--文件路徑,定義了日志的切分方式——把每一天的日志歸檔到一個文件中,以防止日志填滿整個磁盤空間--> <filenamepattern>${logback.logdir}/error.${logback.appname}.%d{yyyy-mm-dd}.log</filenamepattern> <!--只保留最近 90 天的日志--> <maxhistory> 90 </maxhistory> <!--用來指定日志文件的上限大小,那么到了這個值,就會刪除舊的日志--> <!--<totalsizecap>1gb</totalsizecap>--> </rollingpolicy> <!--日志輸出編碼格式化--> <encoder> <charset>utf- 8 </charset> <pattern>%d [%thread] %-5level %logger{ 36 } %line - %msg%n</pattern> </encoder> </appender> |
如果同時有 <file> 和 <filenamepattern> ,根據日期分割日志,代碼注釋寫的很清楚了。
如果要區分 info 和 error 級別的日志,那么需要使用過濾規則的策略,代碼注釋寫的很清楚了。
子節點五 <loger>
<loger> 用來設置某一個包或者具體的某一個類的日志打印級別、以及指定 <appender> 。 <loger> 僅有一個 name 屬性,一個可選的 level 和一個可選的 addtivity 屬性。
name :用來指定受此loger約束的某一個包或者具體的某一個類。
level :用來設置打印級別,大小寫無關:trace, debug, info, warn, error, all 和 off,還有一個特俗值inherited或者同義詞null,代表強制執行上級的級別。如果未設置此屬性,那么當前loger將會繼承上級的級別。
addtivity :是否向上級loger傳遞打印信息。默認是true。
loger在實際使用的時候有兩種情況
先來看一看代碼中如何使用
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
package com.dudu.controller; @controller public class learncontroller { private logger logger = loggerfactory.getlogger( this .getclass()); @requestmapping (value = "/login" ,method = requestmethod.post) @responsebody public map<string,object> 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" ); map<string,object> map = new hashmap<string,object>(); string username=request.getparameter( "username" ); string password=request.getparameter( "password" ); if (!username.equals( "" ) && password!= "" ){ user user = new user(username,password); request.getsession().setattribute( "user" ,user); map.put( "result" , "1" ); } else { map.put( "result" , "0" ); } return map; } } |
這是一個登錄的判斷的方法,我們引入日志,并且打印不同級別的日志,然后根據logback-spring.xml中的配置來看看打印了哪幾種級別日志。
第一種:帶有 loger 的配置,不指定級別,不指定 appender
logback-spring.xml 增加 loger 配置如下:
1
2
|
<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 將信息打印到控制臺;
打印結果如下:
1
2
3
|
16 : 00 : 17.407 logback [http-nio- 8080 -exec- 8 ] info com.dudu.controller.learncontroller - 日志輸出 info 16 : 00 : 17.408 logback [http-nio- 8080 -exec- 8 ] warn com.dudu.controller.learncontroller - 日志輸出 warn 16 : 00 : 17.408 logback [http-nio- 8080 -exec- 8 ] error com.dudu.controller.learncontroller - |
第二種:帶有多個 loger 的配置,指定級別,指定 appender
logback-spring.xml 增加 loger 配置如下:
1
2
3
4
5
6
7
|
<configuration> ... <!--logback.logbackdemo:類的全路徑 --> <logger name= "com.dudu.controller.learncontroller" level= "warn" additivity= "false" > <appender-ref ref= "console" /> </logger> </configuration> |
控制 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 傳遞打印信息。
打印結果如下:
1
2
|
16 : 00 : 17.408 logback [http-nio- 8080 -exec- 8 ] warn com.dudu.controller.learncontroller - 日志輸出 warn 16 : 00 : 17.408 logback [http-nio- 8080 -exec- 8 ] error com.dudu.controller.learncontroller - 日志輸出 error |
當然如果你把 additivity="false" 改成 additivity="true" 的話,就會打印兩次,因為打印信息向上級傳遞,logger本身打印一次,root接到后又打印一次。
注意:
1
2
3
4
5
6
7
8
|
<configuration> ... <logger name= "com.example.demo.controller" level= "warn" additivity= "false" > <appender-ref ref= "consolelog" /> </logger> <logger name= "com.example.demo.controller" /> <logger name= "com.example.demo" /> </configuration> |
范圍有重疊的話,范圍小的,有效。
多環境日志輸出
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
<configuration> ... <!-- 測試環境+開發環境. 多個使用逗號隔開. --> <springprofile name= "test,dev" > <logger name= "com.example.demo.controller" level= "debug" additivity= "false" > <appender-ref ref= "consolelog" /> </logger> </springprofile> <!-- 生產環境. --> <springprofile name= "prod" > <logger name= "com.example.demo.controller" level= "info" additivity= "false" > <appender-ref ref= "consolelog" /> </logger> </springprofile> </configuration> |
application.yml 增加環境選擇的配置 active: dev
server:
port: 9010
spring:
profiles:
active: dev
datasource:
url: jdbc:mysql://localhost:3306/test?characterencoding=utf8
username: root
password: root
mybatis:
type-aliases-package: org.larry.springboot.entity
mapper-locations: classpath:mapper/**/*.xml
check-config-location: true
active: 【test、dev、prod】 ,根據 active 的環境,自動采用上面配置的 springprofile 的 logger 日志
原文鏈接:http://blog.csdn.net/inke88/article/details/75007649#comments?utm_source=tuicool&utm_medium=referral