springboot下添加日志模塊和設(shè)置日志文件輸出的方法
前言
日志的使用將通過SLF4J來使用,SLF4J(Simple Logging Facade for Java)是一個為Java應(yīng)用提供簡單日志記錄的接口。它的主要目標(biāo)是在不同的日志系統(tǒng)之間提供一個簡單的抽象層,使得應(yīng)用能夠以一種靈活的方式切換日志實現(xiàn),而不需要修改應(yīng)用本身的代碼。SLF4J不是一個具體的日志實現(xiàn),而是一個橋接,它與其他具體的日志系統(tǒng)(如Log4J、Logback、Java Util Logging等)一起使用。在Spring框架中,SLF4J常常用于處理框架本身以及應(yīng)用程序的日志記錄。
使用
在pom文件添加以下依賴,使用logback,由于logback1.2.9以下存在漏洞,推薦使用1.2.9及以上版本
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.30</version> <optional>true</optional> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.2.9</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.2.9</version> </dependency>
在需要使用的類上面標(biāo)注@Slf4j,即可使用log的相關(guān)方法,比如在全局異常類可以這樣使用:
@Slf4j @RestControllerAdvice public class GlobalExceptionHandler { /******************************** * @function : 自定義從捕捉 * @parameter : [e:CustomException | 自定義異常] * @date : 2023/12/5 11:47 ********************************/ @ExceptionHandler(value = CustomException.class) public AjaxResult customExceptionHandler(HttpServletRequest request, CustomException e) { log.error("業(yè)務(wù)異常,url:{}, 異常內(nèi)容:{}" ,request.getRequestURI(), e); return new AjaxResult(e.getCode() , e.getMessage(), null); } /******************************** * @function : 空指針異常捕捉 * @parameter : [e:Exception | 異常] * @date : 2023/12/5 11:47 ********************************/ @ExceptionHandler(value = Exception.class) public AjaxResult exceptionHandler(HttpServletRequest request, Exception e) { log.error("服務(wù)器內(nèi)部異常異常,url:{}, 異常內(nèi)容:{}" ,request.getRequestURI(), e); return new AjaxResult(500 , e.getMessage(), null); } }
在try,catch中的使用,catch中不要使用e.printstacktrace,使用log代替:
try { ... } catch { log.error{"..發(fā)送了異常,參數(shù)是{},異常信息{}",id,e}; }
阿里巴巴的日志規(guī)范
【強制】應(yīng)用中不可直接使用日志系統(tǒng)(Log4j、Logback)中的API,而應(yīng)依賴使用日志框架SLF4J中的API,使用門面模式的日志框架,有利于維護和各個類的日志處理方式統(tǒng)一。
import org.slf4j.Logger;import org.slf4j.LoggerFactory;private static final Logger logger = LoggerFactory.getLogger(Abc.class);
【強制】日志文件推薦至少保存15天,因為有些異常具備以“周”為頻次發(fā)生的特點。
【強制】應(yīng)用中的擴展日志(如打點、臨時監(jiān)控、訪問日志等)命名方式:appName_logType_logName.log。logType:日志類型,推薦分類有stats/monitor/visit等;logName:日志描述。這種命名的好處:通過文件名就可知道日志文件屬于什么應(yīng)用,什么類型,什么目的,也有利于歸類查找。
正例:mppserver應(yīng)用中單獨監(jiān)控時區(qū)轉(zhuǎn)換異常,如: mppserver_monitor_timeZoneConvert.log
說明:推薦對日志進行分類,如將錯誤日志和業(yè)務(wù)日志分開存放,便于開發(fā)人員查看,也便于通過日志對系統(tǒng)進行及時監(jiān)控。
【強制】對trace/debug/info級別的日志輸出,必須使用條件輸出形式或者使用占位符的方式。
說明:logger.debug(“Processing trade with id: “ + id + “ and symbol: “ + symbol); 如果日志級別是warn,上述日志不會打印,但是會執(zhí)行字符串拼接操作,如果symbol是對象,會執(zhí)行toString()方法,浪費了系統(tǒng)資源,執(zhí)行了上述操作,最終日志卻沒有打印。
正例:
(條件) if (logger.isDebugEnabled()) { logger.debug("Processing trade with id: " + id + " and symbol: " + symbol); }
正例:
(占位符) logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);
【強制】避免重復(fù)打印日志,浪費磁盤空間,務(wù)必在log4j.xml中設(shè)置additivity=false。
正例:<logger name="com.taobao.dubbo.config" additivity="false">
【強制】異常信息應(yīng)該包括兩類信息:案發(fā)現(xiàn)場信息和異常堆棧信息。如果不處理,那么通過關(guān)鍵字throws往上拋出。
正例:
logger.error(各類參數(shù)或者對象toString + "_" + e.getMessage(), e);
【推薦】謹慎地記錄日志。生產(chǎn)環(huán)境禁止輸出debug日志;有選擇地輸出info日志;如果使用warn來記錄剛上線時的業(yè)務(wù)行為信息,一定要注意日志輸出量的問題,避免把服務(wù)器磁盤撐爆,并記得及時刪除這些觀察日志。
說明:大量地輸出無效日志,不利于系統(tǒng)性能提升,也不利于快速定位錯誤點。記錄日志時請思考:這些日志真的有人看嗎?看到這條日志你能做什么?能不能給問題排查帶來好處?
【推薦】可以使用warn日志級別來記錄用戶輸入?yún)?shù)錯誤的情況,避免用戶投訴時,無所適從。如非必要,請不要在此場景打出error級別,避免頻繁報警。
說明:注意日志輸出的級別,error級別只記錄系統(tǒng)邏輯出錯、異常或者重要的錯誤信息。
日志的配置文件
配置日志文件的持久化,示例如下:
<?xml version="1.0" encoding="UTF-8"?> <!-- 日志級別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果設(shè)置為WARN,則低于WARN的信息都不會輸出 --> <!-- scan:當(dāng)此屬性設(shè)置為true時,配置文檔如果發(fā)生改變,將會被重新加載,默認值為true --> <!-- scanPeriod:設(shè)置監(jiān)測配置文檔是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。 當(dāng)scan為true時,此屬性生效。默認的時間間隔為1分鐘。 --> <!-- debug:當(dāng)此屬性設(shè)置為true時,將打印出logback內(nèi)部日志信息,實時查看logback運行狀態(tài)。默認值為false。 --> <configuration scan="true" scanPeriod="10 seconds"> <contextName>logback</contextName> <!-- name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義后,可以使“${}”來使用變量。 --> <property name="log.path" value="./log" /> <!--0. 日志格式和顏色渲染 --> <!-- 彩色日志依賴的渲染類 --> <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" /> <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" /> <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" /> <!-- 彩色日志格式 --> <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/> <!--1. 輸出到控制臺--> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <!--此日志appender是為開發(fā)使用,只配置最底級別,控制臺輸出的日志級別是大于或等于此級別的日志信息--> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>debug</level> </filter> <encoder> <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}---[%thread] %-5level %logger{50} - %msg%n</Pattern> <!-- 設(shè)置字符集 --> <charset>UTF-8</charset> </encoder> </appender> <!--2. 輸出到文檔--> <!-- 2.1 level為 DEBUG 日志,時間滾動輸出 --> <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--日志文檔輸出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> <!-- 設(shè)置字符集 --> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 日志歸檔 --> <fileNamePattern>${log.path}/debug/web-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文檔保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文檔只記錄debug級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>debug</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 2.2 level為 INFO 日志,時間滾動輸出 --> <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--日志文檔輸出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 每天日志歸檔路徑以及格式 --> <fileNamePattern>${log.path}/info/web-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文檔保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文檔只記錄info級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>info</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 2.3 level為 WARN 日志,時間滾動輸出 --> <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--日志文檔輸出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> <!-- 此處設(shè)置字符集 --> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/warn/web-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文檔保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文檔只記錄warn級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>warn</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 2.4 level為 ERROR 日志,時間滾動輸出 --> <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> <!--日志文檔輸出格式--> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern> <charset>UTF-8</charset> <!-- 此處設(shè)置字符集 --> </encoder> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/error/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文檔保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy> <!-- 此日志文檔只記錄ERROR級別的 --> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- <logger>用來設(shè)置某一個包或者具體的某一個類的日志打印級別、 以及指定<appender>。<logger>僅有一個name屬性, 一個可選的level和一個可選的addtivity屬性。 name:用來指定受此logger約束的某一個包或者具體的某一個類。 level:用來設(shè)置打印級別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, 還有一個特俗值INHERITED或者同義詞NULL,代表強制執(zhí)行上級的級別。 如果未設(shè)置此屬性,那么當(dāng)前l(fā)ogger將會繼承上級的級別。 addtivity:是否向上級logger傳遞打印信息。默認是true。 <logger name="org.springframework.web" level="info"/> <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/> --> <!-- 使用mybatis的時候,sql語句是debug下才會打印,而這里我們只配置了info,所以想要查看sql語句的話,有以下兩種操作: 第一種把<root level="info">改成<root level="DEBUG">這樣就會打印sql,不過這樣日志那邊會出現(xiàn)很多其他消息 第二種就是單獨給dao下目錄配置debug模式,代碼如下,這樣配置sql語句會打印,其他還是正常info級別: 【logging.level.org.mybatis=debug logging.level.dao=debug】 --> <!-- root節(jié)點是必選節(jié)點,用來指定最基礎(chǔ)的日志輸出級別,只有一個level屬性 level:用來設(shè)置打印級別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF, 不能設(shè)置為INHERITED或者同義詞NULL。默認是DEBUG 可以包含零個或多個元素,標(biāo)識這個appender將會添加到這個logger。 --> <!-- 4. 最終的策略 --> <!-- 4.1 開發(fā)環(huán)境:打印控制臺--> <!-- <springProfile name="dev">--> <!-- <logger name="com" level="debug"/>--> <!-- </springProfile>--> <root level="info"> <appender-ref ref="CONSOLE" /> <appender-ref ref="DEBUG_FILE" /> <appender-ref ref="INFO_FILE" /> <appender-ref ref="WARN_FILE" /> <appender-ref ref="ERROR_FILE" /> </root> <!-- 4.2 生產(chǎn)環(huán)境:輸出到文檔 <springProfile name="pro"> <root level="info"> <appender-ref ref="CONSOLE" /> <appender-ref ref="DEBUG_FILE" /> <appender-ref ref="INFO_FILE" /> <appender-ref ref="ERROR_FILE" /> <appender-ref ref="WARN_FILE" /> </root> </springProfile> --> </configuration>
其中,日志文件的大小和路徑名稱可以通過這塊進行修改:
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <fileNamePattern>${log.path}/error/web-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> <maxFileSize>10MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> <!--日志文檔保留天數(shù)--> <maxHistory>15</maxHistory> </rollingPolicy>
通過以上配置,產(chǎn)生的日志文件結(jié)構(gòu)如下:
第一層是log文件夾:
第二層是各個級別文件夾:
第三層是每個日期的文件
到此這篇關(guān)于springboot下添加日志模塊和設(shè)置日志文件輸出的方法的文章就介紹到這了,更多相關(guān)springboot日志文件輸出內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
java高級用法之綁定CPU的線程Thread?Affinity簡介
java線程thread affinity是用來將java代碼中的線程綁定到CPU特定的核上,用來提升程序運行的性能,這篇文章主要介紹了java高級用法之綁定CPU的線程thread affinity的相關(guān)知識,需要的朋友可以參考下2022-05-05Java中invokedynamic字節(jié)碼指令問題
這篇文章主要介紹了Java中invokedynamic字節(jié)碼指令問題,非常不錯,具有一定的參考借鑒價值,需要的朋友可以參考下2019-04-04Java定時調(diào)用.ktr文件的示例代碼(解決方案)
這篇文章主要介紹了Java定時調(diào)用.ktr文件的示例代碼,本文給大家分享遇到問題及解決方法,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-04-04Spring Boot 動態(tài)數(shù)據(jù)源示例(多數(shù)據(jù)源自動切換)
本篇文章主要介紹了Spring Boot 動態(tài)數(shù)據(jù)源示例(多數(shù)據(jù)源自動切換),小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-02-02Java泛型模擬scala實現(xiàn)自定義ArrayList方式
這篇文章主要介紹了Java泛型模擬scala實現(xiàn)自定義ArrayList方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-10-10IntelliJ IDEA 2017.1.4 x64配置步驟(介紹)
下面小編就為大家?guī)硪黄狪ntelliJ IDEA 2017.1.4 x64配置步驟(介紹)。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-06-06