Spring Boot 日志配置方法(超詳細)
默認日志 Logback ：
默認情況下，Spring Boot會用Logback來記錄日志，并用INFO級別輸出到控制臺。在運行應用程序和其他例子時，你應該已經(jīng)看到很多INFO級別的日志了。
從上圖可以看到，日志輸出內容元素具體如下：
- 時間日期：精確到毫秒
- 日志級別：ERROR, WARN, INFO, DEBUG or TRACE
- 進程ID
- 分隔符：— 標識實際日志的開始
- 線程名：方括號括起來（可能會截斷控制臺輸出）
- Logger名：通常使用源代碼的類名
- 日志內容
添加日志依賴
假如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 ，該依賴內容就是 Spring Boot 默認的日志框架 logback 。工程中有用到了 Thymeleaf ，而 Thymeleaf 依賴包含了 spring-boot-starter ，最終我只要引入 Thymeleaf 即可。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency>
控制臺輸出
日志級別從低到高分為：
TRACE < DEBUG < INFO < WARN < ERROR < FATAL 。
如果設置為 WARN ，則低于 WARN 的信息都不會輸出。
Spring Boot 中默認配置 ERROR 、 WARN 和 INFO 級別的日志輸出到控制臺。
您還可以通過啟動您的應用程序 --debug 標志來啟用“調試”模式（開發(fā)的時候推薦開啟）,以下兩種方式皆可：
- 在運行命令后加入 --debug 標志，如： $ java -jar springTest.jar --debug
- 在 application.properties 中配置 debug=true ，該屬性置為 true 的時候，核心 Logger （包含嵌入式容器、hibernate、spring）會輸出更多內容，但是你 自己應用的日志并不會輸出為 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
可以使用 {} 占位符來拼接字符串，而不需要使用 ““+”” 來連接字符串。
文件輸出
默認情況下，Spring Boot將日志輸出到控制臺，不會寫到日志文件。
使用 Spring Boot 喜歡在 application.properties 或 application.yml 配置，這樣只能配置簡單的場景，保存路徑、日志格式等，復雜的場景（區(qū)分 info 和 error 的日志、每天產(chǎn)生一個日志文件等）滿足不了，只能自定義配置，下面會演示。
默認會在設置的 path 生成一個 spring.log 文件。
如果要編寫除控制臺輸出之外的日志文件，則需在 application.properties 中設置 logging.file 或 logging.path 屬性。
- logging.file ，設置文件，可以是絕對路徑，也可以是相對路徑。如： logging.file=my.log
- logging.path ，設置目錄，會在該目錄下創(chuàng)建 spring.log 文件，并寫入日志內容，如： logging.path=/var/log
如果只配置 logging.file ，會在項目的當前路徑下生成一個 xxx.log 日志文件。
如果只配置 logging.path ，在 /var/log 文件夾生成一個日志文件為 spring.log
注：二者不能同時使用，如若同時使用，則只有 logging.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級別輸出
自定義日志配置
根據(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.yml 可以通過 logging.config 屬性指定自定義的名字：
logging.config=classpath:logging-config.xml
雖然一般并不需要改變配置文件的名字，但是如果你想針對不同運行時 Profile 使用不同的日志配置，這個功能會很有用。
一般不需要這個屬性，而是直接在 logback-spring.xml 中使用 springProfile 配置，不需要 logging.config 指定不同環(huán)境使用不同配置文件。 springProfile 配置在下面介紹。
根節(jié)點包含的屬性
- scan:當此屬性設置為 true 時，配置文件如果發(fā)生改變，將會被重新加載，默認值為 true 。
- scanPeriod:設置監(jiān)測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當 scan 為 true 時，此屬性生效。默認的時間間隔為1分鐘。
- debug:當此屬性設置為 true 時，將打印出 logback 內部日志信息，實時查看 logback 運行狀態(tài)。默認值為 false 。
根節(jié)點 <configuration> 有5個子節(jié)點，下面一一會詳細介紹。
子節(jié)點一 <root>
root節(jié)點是必選節(jié)點，用來指定最基礎的日志輸出級別，只有一個level屬性。
level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設置為INHERITED或者同義詞NULL。
默認是DEBUG。
可以包含零個或多個元素，標識這個appender將會添加到這個loger。
<root level="debug"> <appender-ref ref="console" /> <appender-ref ref="file" /> </root>
子節(jié)點二： <contextName> 設置上下文名稱
每個logger都關聯(lián)到logger上下文，默認上下文名稱為“default”。但可以使用設置成其他名字，用于區(qū)分不同應用程序的記錄。一旦設置，不能修改,可以通過 %contextName 來打印日志上下文名稱，一般來說我們不用這個屬性，可有可無。
<contextName>logback</contextName>
子節(jié)點三： <property> 設置變量
用來定義變量值的標簽， 有兩個屬性，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> <!--指定最基礎的日志輸出級別--> <root level="INFO"> <!--appender將會添加到這個loger--> <appender-ref ref="consoleLog1"/> <appender-ref ref="consoleLog2"/> </root> </configuration>
可以看到 layout 和 encoder ，都可以將事件轉換為格式化后的日志記錄，但是控制臺輸出使用 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>
<!--指定最基礎的日志輸出級別-->
<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應用以及異步任務處理中很有用
%-5level——日志級別，并且使用5個字符靠左對齊
%logger{36}——日志輸出者的名字
%msg——日志消息
%n——平臺的換行符
ThresholdFilter為系統(tǒng)定義的攔截器，例如我們用ThresholdFilter來過濾掉ERROR級別以下的日志不輸出到文件中。如果不用記得注釋掉，不然你控制臺會發(fā)現(xiàn)沒日志~
輸出到文件 RollingFileAppender
另一種常見的日志輸出到文件，隨著應用的運行時間越來越長，日志也會增長的越來越多，將他們輸出到同一個文件并非一個好辦法。 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>，那么當天日志是<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的文件路徑規(guī)則
如果同時有<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> ，根據(jù)日期分割日志，代碼注釋寫的很清楚了。
如果要區(qū)分 Info 和 Error 級別的日志，那么需要使用過濾規(guī)則的策略，代碼注釋寫的很清楚了。
子節(jié)點五 <loger>
<loger> 用來設置某一個包或者具體的某一個類的日志打印級別、以及指定 <appender> 。 <loger> 僅有一個 name 屬性，一個可選的 level 和一個可選的 addtivity 屬性。
name :用來指定受此loger約束的某一個包或者具體的某一個類。
level :用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執(zhí)行上級的級別。如果未設置此屬性，那么當前l(fā)oger將會繼承上級的級別。
addtivity :是否向上級loger傳遞打印信息。默認是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，如果設置為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 包下的所有類的日志的打印，但是并沒用設置打印級別，所以繼承他的上級的日志級別 “info” ；
沒有設置 addtivity ，默認為true，將此 loger 的打印信息向上級傳遞；
沒有設置 appender ，此 loger 本身不打印任何信息。
<root level="info"> 將 root 的打印級別設置為 “info” ，指定了名字為 “console” 的 appender 。
當執(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 將信息打印到控制臺；
打印結果如下：
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 傳遞打印信息。
打印結果如下：
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接到后又打印一次。
注意：
<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 日志
- 在SpringBoot下讀取自定義properties配置文件的方法
- SpringBoot + Spring Security 基本使用及個性化登錄配置詳解
- springboot如何讀取配置文件（application.yml）中的屬性值
- 詳解SpringBoot配置連接池
- SpringBoot獲取yml和properties配置文件的內容
- spring boot Logging的配置以及使用詳解
- spring boot的maven配置依賴詳解
- spring boot開發(fā)遇到坑之spring-boot-starter-web配置文件使用教程
- Springboot配置doris連接的實現(xiàn)示例
相關文章
這篇文章主要為大家詳細介紹了javaweb分頁的原理，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-04-04
SpringBoot優(yōu)雅的進行全局異常處理的實現(xiàn)步驟
在軟件開發(fā)的世界里,異常處理是保證系統(tǒng)穩(wěn)定性和用戶體驗的關鍵因素之一,尤其是在構建基于微服務架構的應用時,SpringBoot提供了一套強大的工具來幫助開發(fā)者管理這些異常,所以本文給大家介紹了SpringBoot如何優(yōu)雅的進行全局異常處理,需要的朋友可以參考下2025-02-02
在本篇文章里小編給大家整理了關于java字符串的重要使用方法以及實例代碼，需要的朋友們可以跟著學習參考下。2019-03-03
這篇文章主要為大家詳細介紹了Spring Boot快速搭建Spring框架教程，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-10-10
創(chuàng)建ExceptionTest類，在該類的main()方法中，使用反射獲得String類的所有域，不要使用setAccessible方法修改這些域的可見性，然后通過反射獲得私有域中與”hash”相匹配的int值，并使用try-catch語句塊捕獲非法訪問異常2014-02-02
在數(shù)據(jù)庫操作過程中,經(jīng)常有修改表名的需求,下面這篇文章主要給大家介紹了關于mybatis插件實現(xiàn)自定義改寫表名的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2022-04-04
這篇文章主要介紹了Spring AOP執(zhí)行先后順序實例詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-01-01
這篇文章主要介紹了SpringBoot 發(fā)送郵件功能實現(xiàn)，本文以163郵箱為例通過這個小案例給大家介紹,需要的朋友可以參考下2019-12-12
這篇文章主要為大家詳細介紹了Java實現(xiàn)猜拳游戲，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2020-08-08
這篇文章主要介紹了SpringBoot中的響應式web應用詳解,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-11-11