默認(rèn)日志 Logback :
默認(rèn)情況下,Spring Boot會用Logback來記錄日志瘟判,并用INFO級別輸出到控制臺给郊。在運行應(yīng)用程序和其他例子時,你應(yīng)該已經(jīng)看到很多INFO級別的日志了锨能。
從上圖可以看到,日志輸出內(nèi)容元素具體如下:
時間日期:精確到毫秒
日志級別:ERROR, WARN, INFO, DEBUG or TRACE
進程ID
分隔符:— 標(biāo)識實際日志的開始
線程名:方括號括起來(可能會截斷控制臺輸出)
Logger名:通常使用源代碼的類名
日志內(nèi)容
添加日志依賴
假如maven依賴中添加了 spring-boot-starter-logging :
<dependency>
? ? <groupId>org.springframework.boot</groupId>
? ? <artifactId>spring-boot-starter-logging</artifactId>
</dependency>
但是呢芍耘,實際開發(fā)中我們不需要直接添加該依賴址遇。
你會發(fā)現(xiàn) spring-boot-starter 其中包含了 spring-boot-starter-logging ,該依賴內(nèi)容就是 Spring Boot 默認(rèn)的日志框架 logback 斋竞。工程中有用到了 Thymeleaf 倔约,而 Thymeleaf 依賴包含了 spring-boot-starter ,最終我只要引入 Thymeleaf 即可坝初。(不了解Thymeleaf可以查看我上篇文章 )
控制臺輸出
日志級別從低到高分為:
? ? TRACE < DEBUG < INFO < WARN < ERROR < FATAL
如果設(shè)置為 WARN 浸剩,則低于 WARN 的信息都不會輸出钾军。
Spring Boot 中默認(rèn)配置 ERROR 、 WARN 和 INFO 級別的日志輸出到控制臺绢要。
您還可以通過啟動您的應(yīng)用程序 --debug 標(biāo)志來啟用“調(diào)試”模式(開發(fā)的時候推薦開啟),以下兩種方式皆可:
在運行命令后加入 --debug 標(biāo)志吏恭,如: $ java -jar springTest.jar --debug
在 application.properties 中配置 debug=true ,該屬性置為 true 的時候重罪,核心 Logger (包含嵌入式容器樱哼、hibernate、spring)會輸出更多內(nèi)容剿配,但是你 自己應(yīng)用的日志并不會輸出為 DEBUG 級別 搅幅。
如果每次都寫這行代碼會很麻煩,可以使用注解呼胚,但是需要使用 lombok :
添加依賴:
//注解
compile 'org.projectlombok:lombok:1.16.18'
安裝 lombok 的插件:
Go to File > Settings > Plugins
Click on Browse repositories…
Search for?Lombok Plugin
Click on Install plugin
Restart Android Studio
允許注解處理茄唐,Settings -> Compiler -> Annotation Processors
可以使用 {} 占位符來拼接字符串,而不需要使用 ““+”” 來連接字符串蝇更。
文件輸出
默認(rèn)情況下沪编,Spring Boot將日志輸出到控制臺,不會寫到日志文件年扩。
使用 Spring Boot 喜歡在 application.properties 或 application.yml 配置漾抬,這樣只能配置簡單的場景,保存路徑常遂、日志格式等纳令,復(fù)雜的場景(區(qū)分 info 和 error 的日志、每天產(chǎn)生一個日志文件等)滿足不了克胳,只能自定義配置平绩,下面會演示。
默認(rèn)會在設(shè)置的 path 生成一個 spring.log 文件漠另。
如果要編寫除控制臺輸出之外的日志文件捏雌,則需在 application.properties 中設(shè)置 logging.file 或 logging.path 屬性。
logging.file 笆搓,設(shè)置文件性湿,可以是絕對路徑,也可以是相對路徑满败。如: logging.file=my.log
logging.path 肤频,設(shè)置目錄,會在該目錄下創(chuàng)建 spring.log 文件算墨,并寫入日志內(nèi)容宵荒,如: logging.path=/var/log
如果只配置 logging.file ,會在項目的當(dāng)前路徑下生成一個 xxx.log 日志文件。
如果只配置 logging.path 报咳,在 /var/log 文件夾生成一個日志文件為 spring.log
注:二者不能同時使用侠讯,如若同時使用,則只有 logging.file 生效
默認(rèn)情況下暑刃,日志文件的大小達到 10MB 時會切分一次厢漩,產(chǎn)生新的日志文件,默認(rèn)級別為: ERROR岩臣、WARN溜嗜、INFO
級別控制
所有支持的日志記錄系統(tǒng)都可以在 Spring 環(huán)境中設(shè)置記錄級別(例如在 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級別輸出
自定義日志配置
根據(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 特有的配置項(下面會提到)鸿脓。
默認(rèn)的命名規(guī)則抑钟,并且放在 src/main/resources 下面即可
如果你即想完全掌控日志配置,但又不想用 logback.xml 作為 Logback 配置的名字野哭, application.yml 可以通過 logging.config 屬性指定自定義的名字:
1logging.config=classpath:logging-config.xml
雖然一般并不需要改變配置文件的名字在塔,但是如果你想針對不同運行時 Profile 使用不同的日志配置,這個功能會很有用拨黔。
一般不需要這個屬性蛔溃,而是直接在 logback-spring.xml 中使用 springProfile 配置,不需要 logging.config 指定不同環(huán)境使用不同配置文件篱蝇。 springProfile 配置在下面介紹贺待。
根節(jié)點包含的屬性
scan:當(dāng)此屬性設(shè)置為 true 時,配置文件如果發(fā)生改變零截,將會被重新加載麸塞,默認(rèn)值為 true 。
scanPeriod:設(shè)置監(jiān)測配置文件是否有修改的時間間隔涧衙,如果沒有給出時間單位哪工,默認(rèn)單位是毫秒。當(dāng) scan 為 true 時弧哎,此屬性生效雁比。默認(rèn)的時間間隔為1分鐘。
debug:當(dāng)此屬性設(shè)置為 true 時撤嫩,將打印出 logback 內(nèi)部日志信息章贞,實時查看 logback 運行狀態(tài)。默認(rèn)值為 false 。
根節(jié)點 <configuration> 有5個子節(jié)點鸭限,下面一一會詳細介紹蜕径。
子節(jié)點一 <root>
root節(jié)點是必選節(jié)點,用來指定最基礎(chǔ)的日志輸出級別败京,只有一個level屬性兜喻。
level:用來設(shè)置打印級別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF赡麦,不能設(shè)置為INHERITED或者同義詞NULL朴皆。
默認(rèn)是DEBUG。
可以包含零個或多個元素泛粹,標(biāo)識這個appender將會添加到這個loger遂铡。
<root level="debug">
?<appender-ref ref="console"?/>
?<appender-ref ref="file"?/>
</root>
子節(jié)點二: <contextName> 設(shè)置上下文名稱
每個logger都關(guān)聯(lián)到logger上下文,默認(rèn)上下文名稱為“default”晶姊。但可以使用設(shè)置成其他名字扒接,用于區(qū)分不同應(yīng)用程序的記錄。一旦設(shè)置们衙,不能修改,可以通過 %contextName 來打印日志上下文名稱钾怔,一般來說我們不用這個屬性,可有可無蒙挑。
<contextName>logback</contextName>
子節(jié)點三: <property> 設(shè)置變量
用來定義變量值的標(biāo)簽宗侦, 有兩個屬性,name和value忆蚀;其中name的值是變量的名稱矾利,value的值時變量定義的值。通過定義的值會被插入到logger上下文中馋袜。定義變量后男旗,可以使“${}”來使用變量。
<property name="logback.logdir"?value="/Users/inke/dev/log/tomcat"/>
<property name="logback.appname"?value="app"/>
子節(jié)點四: <appender>
appender用來格式化日志輸出節(jié)點桃焕,有倆個屬性name和class剑肯,class用來指定哪種輸出策略,常用就是控制臺輸出策略和文件輸出策略观堂。
控制臺輸出 ConsoleAppender :
示例一:
<?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>
?<!--指定最基礎(chǔ)的日志輸出級別-->
?<root level="INFO">
?<!--appender將會添加到這個loger-->
?<appender-ref ref="consoleLog1"/>
?<appender-ref ref="consoleLog2"/>
?</root>
</configuration>
可以看到 layout 和 encoder 让网,都可以將事件轉(zhuǎn)換為格式化后的日志記錄,但是控制臺輸出使用 layout 师痕,文件輸出使用 encoder 溃睹。
示例二:
<?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>
?<!--指定最基礎(chǔ)的日志輸出級別-->
?<root level="INFO">
?<!--appender將會添加到這個loger-->
?<appender-ref ref="consoleLog1"/>
?<appender-ref ref="consoleLog2"/>
?</root>
</configuration>
輸出日志:
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應(yīng)用以及異步任務(wù)處理中很有用
%-5level——日志級別胰坟,并且使用5個字符靠左對齊
%logger{36}——日志輸出者的名字
%msg——日志消息
%n——平臺的換行符
ThresholdFilter為系統(tǒng)定義的攔截器因篇,例如我們用ThresholdFilter來過濾掉ERROR級別以下的日志不輸出到文件中。如果不用記得注釋掉,不然你控制臺會發(fā)現(xiàn)沒日志~
輸出到文件 RollingFileAppender
另一種常見的日志輸出到文件竞滓,隨著應(yīng)用的運行時間越來越長咐吼,日志也會增長的越來越多,將他們輸出到同一個文件并非一個好辦法商佑。 RollingFileAppender 用于切分文件日志:
<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的文件路徑規(guī)則
?如果同時有<File>和<FileNamePattern>喂急,那么當(dāng)天日志是<File>,明天會自動把今天
?的日志改名為今天的日期笛求。即廊移,<File> 的日志都是當(dāng)天的。
?-->
?<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 級別的日志新症,那么需要過濾一下,默認(rèn)是 info 級別的响禽,ThresholdFilter-->
?<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
?<level>Error</level>
?</filter>
?<!--日志名稱徒爹,如果沒有File 屬性,那么只會使用FileNamePattern的文件路徑規(guī)則
?如果同時有<File>和<FileNamePattern>芋类,那么當(dāng)天日志是<File>隆嗅,明天會自動把今天
?的日志改名為今天的日期。即侯繁,<File> 的日志都是當(dāng)天的胖喳。
?-->
?<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> ,根據(jù)日期分割日志咕别,代碼注釋寫的很清楚了技健。
如果要區(qū)分 Info 和 Error 級別的日志,那么需要使用過濾規(guī)則的策略惰拱,代碼注釋寫的很清楚了雌贱。
子節(jié)點五 <loger>
<loger> 用來設(shè)置某一個包或者具體的某一個類的日志打印級別、以及指定 <appender> 。 <loger> 僅有一個 name 屬性欣孤,一個可選的 level 和一個可選的 addtivity 屬性馋没。
name :用來指定受此loger約束的某一個包或者具體的某一個類。
level :用來設(shè)置打印級別降传,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF披泪,還有一個特俗值INHERITED或者同義詞NULL,代表強制執(zhí)行上級的級別搬瑰。如果未設(shè)置此屬性款票,那么當(dāng)前l(fā)oger將會繼承上級的級別。
addtivity :是否向上級loger傳遞打印信息泽论。默認(rèn)是true艾少。
loger在實際使用的時候有兩種情況
先來看一看代碼中如何使用
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,如果設(shè)置為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;
?}
}
這是一個登錄的判斷的方法,我們引入日志鹦赎,并且打印不同級別的日志谍椅,然后根據(jù)logback-spring.xml中的配置來看看打印了哪幾種級別日志。
第一種:帶有 loger 的配置古话,不指定級別雏吭,不指定 appender
logback-spring.xml 增加 loger 配置如下:
<logger name="com.dudu.controller"/>
<logger name="com.dudu.controller"?/> 將控制 controller 包下的所有類的日志的打印,但是并沒用設(shè)置打印級別陪踩,所以繼承他的上級的日志級別 “info” 杖们;
沒有設(shè)置 addtivity ,默認(rèn)為true肩狂,將此 loger 的打印信息向上級傳遞摘完;
沒有設(shè)置 appender ,此 loger 本身不打印任何信息傻谁。
<root level="info">?將 root 的打印級別設(shè)置為 “info” 孝治,指定了名字為 “console” 的 appender 。
當(dāng)執(zhí)行 com.dudu.controller.LearnController 類的 login 方法時审磁, LearnController 在包com.dudu.controller中谈飒,所以首先執(zhí)行<logger name="com.dudu.controller"/>,將級別為 “info” 及大于 “info” 的日志信息傳遞給 root 力图,本身并不打硬匠瘛;
root 接到下級傳遞的信息吃媒,交給已經(jīng)配置好的名為“console”的 appender 處理瓤介, “console” appender 將信息打印到控制臺吕喘;
打印結(jié)果如下:
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 配置如下:
<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 ;
這時候執(zhí)行 com.dudu.controller.LearnController 類的login方法時祠斧,先執(zhí)行<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">?,將級別為“ WARN ”及大于“WARN”的日志信息交給此 loger 指定的名為“ console ”的 appender 處理闻察,在控制臺中打出日志,不再向上級 root 傳遞打印信息琢锋。
打印結(jié)果如下:
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
當(dāng)然如果你把 additivity="false" 改成 additivity="true" 的話辕漂,就會打印兩次,因為打印信息向上級傳遞吴超,logger本身打印一次钉嘹,root接到后又打印一次。
注意:
<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>
范圍有重疊的話鲸阻,范圍小的跋涣,有效。
多環(huán)境日志輸出
<configuration>
?<!-- 測試環(huán)境+開發(fā)環(huán)境. 多個使用逗號隔開. -->
?<springProfile name="test,dev">
?<logger name="com.example.demo.controller"?level="DEBUG"?additivity="false">
??<appender-ref ref="consoleLog"/>
?</logger>
?</springProfile>
?<!-- 生產(chǎn)環(huán)境. -->
?<springProfile name="prod">
?<logger name="com.example.demo.controller"?level="INFO"?additivity="false">
??<appender-ref ref="consoleLog"/>
?</logger>
?</springProfile>
</configuration>
application.yml 增加環(huán)境選擇的配置 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】 ,根據(jù) active 的環(huán)境细诸,自動采用上面配置的 springProfile 的 logger 日志