基于logback 實現(xiàn)springboot超級詳細的日志配置
前言
java web 下有好幾種日志框架,比如:logback,log4j,log4j2(slj4f 并不是一種日志框架,它相當(dāng)于定義了規(guī)范,實現(xiàn)了這個規(guī)范的日志框架就能夠用 slj4f 調(diào)用)。其中性能最高的應(yīng)該使 logback 了,而且 springboot 默認使用的也是 logback 日志,所以本篇將會詳細的講解 logback 的日志配置方案。
本篇主要內(nèi)容如下:
•logback 配置文件的構(gòu)成
•如何將日志輸出到文件
•如何按時間,按大小切分日志
•如何將讓一個日志文件中只有一種日志級別
•如何將指定包下的日志輸出到指定的日志文件中
簡單使用
如果無需復(fù)雜的日志配置,執(zhí)行簡單設(shè)置日志打印級別,打印方式可直接再 application.yml 中配置。
默認情況下 Spring Boot 將 info 級別的日志輸出到控制臺中,不會寫到日志文件,且不能進行復(fù)雜配置。
打印到文件中
想要將日志輸出到文件中,可通過如下兩個配置:
logging: # 配置輸出額日志文件名,可以帶路徑 # file: out.log # 配置日志存放路徑,日志文件名為:spring.log path: ./log file: # 設(shè)置日志文件大小 max-size: 10MB
注意:file 和 path 是不能同時配置的,如果同時配置path不會生效。
打印級別控制
可通過配置控制日志打印級別,格式如下:
logging.level.*=TRACE/DEBUG/INFO/... *可以為包名或 Logger 名,如下: logging: level: # root日志以WARN級別輸出 root: info # 此包下所有class以DEBUG級別輸出 com.example.log_demo.log1: warn
logback 詳細配置
接下來說明如何通過獨立的 xml 配置文件來配置日志打印。雖然 springboot 是要消滅 xml 的,但是有些復(fù)雜功能還是得編寫 xml。使用 xml 后要將 application.yml 中的配置去掉,避免沖突.
根據(jù)不同的日志系統(tǒng),按照指定的規(guī)則組織配置文件名,并放在 resources 目錄下,就能自動被 spring boot 加載:
•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
想要自定義文件名的可配置:logging.config指定配置文件名:
logging.config=classpath:logging-config.xml
Spring Boot 官方推薦優(yōu)先使用帶有 -spring 的文件名作為你的日志配置(如使用 logback-spring.xml ,而不是 logback.xml ),命名為 logback-spring.xml 的日志配置文件, spring boot 可以為它添加一些 spring boot 特有的配置項(下面會提到)。
logback 配置文件的組成
根節(jié)點<configuration>有 5 個子節(jié)點,下面來進行一一介紹。
<root>節(jié)點
root 節(jié)點是必選節(jié)點,用來指定最基礎(chǔ)的日志輸出級別,只有一個 level 屬性,用于設(shè)置打印級別,可選如下:TRACE,DEBUG,INFO,WARN,ERROR,ALL,OFF。
root 節(jié)點可以包含 0 個或多個元素,將appender添加進來。如下:
<root level="debug"> <appender-ref ref="console" /> <appender-ref ref="file" /> </root>
appender 也是子節(jié)點之一,將會在后面說明。
<contextName>節(jié)點
設(shè)置上下文名稱,默認為default,可通過%contextName來打印上下文名稱,一般不使用此屬性。
<property>節(jié)點
用于定義變量,方便使用。有兩個屬性:name,value。定義變量后,可以使用${}來使用變量。如下:
<property name="path" value="./log"/> <property name="appname" value="app"/>
<appender>節(jié)點
appender 用來格式化日志輸出的節(jié)點,這個最重要。有兩個屬性:
•name:該本 appender 命名
•class:指定輸出策略,通常有兩種:控制臺輸出,文件輸出
下面通過例子來說明這個怎么用:
1.輸出到控制臺/按時間輸出日志
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!--設(shè)置存儲路徑變量-->
<property name="LOG_HOME" value="./log"/>
<!--控制臺輸出appender-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<!--設(shè)置輸出格式-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日志消息,%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<!--設(shè)置編碼-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--文件輸出,時間窗口滾動-->
<appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--日志名,指定最新的文件名,其他文件名使用FileNamePattern -->
<File>${LOG_HOME}/timeFile/out.log</File>
<!--文件滾動模式-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件輸出的文件名,可設(shè)置文件類型為gz,開啟文件壓縮-->
<FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
<!--日志文件保留天數(shù)-->
<MaxHistory>30</MaxHistory>
<!--按大小分割同一天的-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!--輸出格式-->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級別從左顯示5個字符寬度%msg:日志消息,%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<!--設(shè)置編碼-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--指定基礎(chǔ)的日志輸出級別-->
<root level="INFO">
<!--appender將會添加到這個loger-->
<appender-ref ref="console"/>
<appender-ref ref="timeFileOutput"/>
</root>
</configuration>
1.設(shè)置只輸出單個級別
在 appender 中設(shè)置,filter 子節(jié)點,在默認級別上再此過濾,配置 onMatch,onMismatch 可實現(xiàn)只輸出單個級別
<appender ...>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<!--接受匹配-->
<onMatch>ACCEPT</onMatch>
<!--拒絕不匹配的-->
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<logger>節(jié)點
構(gòu)成
此節(jié)點用來設(shè)置一個包或具體的某一個類的日志打印級別、以及指定<appender>,有以下三個屬性:
•name: 必須。用來指定受此 loger 約束的某個包或者某個具體的類
•level:可選。設(shè)置打印級別。默認為 root 的級別。
•addtivity: 可選。是否向上級 loger(也就是 root 節(jié)點)傳遞打印信息。默認為 true。
使用示例如下:
1.不指定級別,不指定 appender
<!-- 控制com.example.service下類的打印,使用root的level和appender --> <logger name="com.example.service"/>
2.指定級別,不指定 appender
<!-- 控制com.example.service下類的打印,使用root的appender打印warn級別日志 --> <logger name="com.example.service" level="WARN"/>
3.指定級別,指定 appender
<!-- 控制com.example.service下類的打印,使用console打印warn級別日志 --> <!-- 設(shè)置addtivity是因為這里已經(jīng)指定了appender,如果再向上傳遞就會被root下的appender再次打印 --> <logger name="com.example.service" level="WARN" addtivity="false"> <appender-ref ref="console"> </logger>
通過指定 appender 就能將指定的包下的日志打印到指定的文件中。
多環(huán)境日志輸出
通過設(shè)置文件名為-spring 結(jié)尾,可分環(huán)境配置 logger,示例如下:
<configuration>
<!-- 測試環(huán)境+開發(fā)環(huán)境. 多個使用逗號隔開. -->
<springProfile name="test,dev">
<logger name="com.example.demo.controller" level="DEBUG" additivity="false">
<appender-ref ref="console"/>
</logger>
</springProfile>
<!-- 生產(chǎn)環(huán)境. -->
<springProfile name="prod">
<logger name="com.example.demo" level="INFO" additivity="false">
<appender-ref ref="timeFileOutput"/>
</logger>
</springProfile>
</configuration>
通過配置spring.profiles.active也能做到切換上面的 logger 打印設(shè)置
結(jié)束
日志打印可以很復(fù)雜, 這里只是說明了常用的 logback 配置,代碼詳見:github
總結(jié)
以上所述是小編給大家介紹的基于logback 實現(xiàn)springboot超級詳細的日志配置,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持!
如果你覺得本文對你有幫助,歡迎轉(zhuǎn)載,煩請注明出處,謝謝!
相關(guān)文章
JDK文件目錄結(jié)構(gòu)及配置環(huán)境變量全過程
這篇文章主要介紹了JDK文件目錄結(jié)構(gòu)及配置環(huán)境變量全過程,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-05-05
mybatis的坑-integer類型為0的數(shù)據(jù)if?test失效問題
這篇文章主要介紹了mybatis的坑-integer類型為0的數(shù)據(jù)if?test失效問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-01-01
使用SpringBoot整合Sharding Sphere實現(xiàn)數(shù)據(jù)脫敏的示例
Apache ShardingSphere數(shù)據(jù)脫敏模塊,通過SQL攔截與改寫實現(xiàn)敏感信息加密存儲,解決手動處理繁瑣及系統(tǒng)改造難題,支持Spring和Spring Boot配置,本文通過實例代碼介紹如何使用SpringBoot整合Sharding Sphere實現(xiàn)數(shù)據(jù)脫敏,感興趣的朋友一起看看吧2025-06-06
詳解使用Mybatis-plus + velocity模板生成自定義的代碼
這篇文章主要介紹了詳解使用Mybatis-plus + velocity模板生成自定義的代碼,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-03-03
基于OpenCv與JVM實現(xiàn)加載保存圖像功能(JAVA?圖像處理)
openCv有一個名imread的簡單函數(shù),用于從文件中讀取圖像,本文給大家介紹JAVA?圖像處理基于OpenCv與JVM實現(xiàn)加載保存圖像功能,感興趣的朋友一起看看吧2022-01-01
Spring Cloud Feign實現(xiàn)文件上傳下載的示例代碼
Feign框架對于文件上傳消息體格式并沒有做原生支持,需要集成模塊feign-form來實現(xiàn),本文就詳細的介紹一下如何使用,感興趣的可以了解一下2022-02-02
一篇文章帶你了解Maven的坐標(biāo)概念以及依賴管理
這篇文章主要為大家介紹了Maven的坐標(biāo)概念以及依賴管理,具有一定的參考價值,感興趣的小伙伴們可以參考一下,希望能夠給你帶來幫助2022-01-01

