主頁 > 後端開發 > SpringBoot 使用 slf4j+logback 進行日志管理

SpringBoot 使用 slf4j+logback 進行日志管理

2021-10-28 06:05:12 後端開發

一、基礎知識:

1.日志系統

  系統日志是記錄系統中硬體、軟體和系統問題的資訊,同時還可以監視系統中發生的事件,用戶可以通過它來檢查錯誤發生的原因,或者尋找受到攻擊時攻擊者留下的痕跡,系統日志包括系統日志、應用程式日志和安全日志,-- 百度百科

  日志的管理是系統很重要的一部分,千萬不可忽略其重要性,完整的日志將會在系統維護中起著例外重要的作用,就好像磨刀不誤砍柴工一樣,日志就像對系統進行分析的工具,工具便捷了,對系統分析起來就能達到事半功倍的效果,

  現代的應用程式已經離不開日志系統,所以學會正確高效地配置一套日志系統是一位后端開發工程師必備的技能,本篇文章我將逐步講解使用 slf4j+logback 來對 SpringBoot 專案進行日志管理,僅作為參考,歡迎大家提出意見,

2.主流框架

  當今Java程式中常見的日志框架有:Log4j、J.U.L(jdk-logging)、J.C.L(commons-logging)、Slf4j、Logback、Log4j2,一共是2個日志介面標準和4個具體的實作,具體內容可參見大佬文章 -- Java日志框架演化歷史

  之前最流行的搭配是使用 J.C.L+Log4j 的形式,從目前趨勢來看,越來越多的開源專案逐步轉向了 slf4j+logback,所以本篇文章主要講解 slf4j+logback 的實作方式,其它實作形式大家感興趣可以自行百度,

3.logback

  logback 是一個開源的日志組件,同樣是由log4j的作者設計完成的,擁有更好的特性,是用來取代log4j的一個日志框架,它擁有更快的實作、更充分的測驗、更充分的檔案、更細粒度的日志管理,所以讓它現在變得越來越受歡迎,

二、在 SpringBoot 專案中使用 logback :

1.添加依賴

  logback 有三個主要模塊:   

    logback-core:是logback-access,logback-classic兩個模塊的基礎,

    logback-classic:它是log4j的一個改良版本,同時它完整實作了slf4j API,使我們可以在其他日志系統,如log4j和JDK14 Logging中進行轉換,

    logback-access:訪問模塊和Servlet容器集成,為tomcat等提供通過Http來訪問日志的功能,

  如果專案使用了 spring-boot-starter,那么依賴已經添加不必再手動引入,否則需要自己手動添加依賴:

  

   否則要手動添加maven依賴:

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.7.21</version>
</dependency>

<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-core</artifactId>
  <version>1.1.7</version>
</dependency>
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.1.7</version>
</dependency>

 

2.添加組態檔

  在 resources 檔案夾下新建 logback-spring.xml 檔案:

<?xml version="1.0" encoding="UTF-8"?>
<!--
    scan: 當此屬性設定為true時,組態檔如果發生改變,將會被重新加載,默認值為true,
    scanPeriod: 設定監測組態檔是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒,當scan為true時,此屬性生效,默認的時間間隔為1分鐘,
    debug: 當此屬性設定為true時,將列印出logback內部日志資訊,實時查看logback運行狀態,默認值為false,
    configuration 子節點為 appender、logger、root
-->
<configuration scan="true" scanPeriod="60 seconds" debug="true">

    <!--用于區分不同應用程式的記錄-->
    <contextName>test-logback</contextName>

    <!--日志檔案所在目錄,如果是tomcat,如下寫法日志檔案會在則為${TOMCAT_HOME}/bin/logs/目錄下-->
    <property name="LOG_HOME_WINDOWS" value="F:/logs"/>
    <property name="LOG_HOME_LINUX" value="./logs"/>

    <!-- 彩色日志 -->
    <!-- 彩色日志依賴的渲染類 -->
    <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" />
    <!-- 彩色日志格式   [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n  -->
    <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}}"/>

    <!--控制臺輸出-->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--格式化輸出:%d表示日期,%thread表示執行緒名,%-5level:級別從左顯示5個字符寬度,%logger:輸出日志的logger名,%msg:日志訊息,%n是換行符 -->
            <pattern>${CONSOLE_LOG_PATTERN}</pattern><!--彩打日志-->
            <!--解決亂碼問題-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--滾動檔案,即隨指定策略記錄日志到指定檔案-->
    <appender name="infoFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- ThresholdFilter:臨界值過濾器,過濾掉 TRACE 和 DEBUG 級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level><!--等級從低到高分別是ALL < TRACE < DEBUG < INFO < WARN < ERROR < OFF-->
        </filter>
        <!--滾動策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME_WINDOWS}/info/info.%d{yyyy-MM-dd}.log</fileNamePattern><!--檔案名-->
            <maxHistory>30</maxHistory><!--保存最近30天的日志-->
            <totalSizeCap>20GB</totalSizeCap><!--所有的日志檔案最大20G,超過就會洗掉舊的日志-->
            <cleanHistoryOnStart>true</cleanHistoryOnStart><!--appender 啟動的時候,是否洗掉歸檔檔案-->
        </rollingPolicy>
        <!--日志格式化策略-->
        <encoder>
            <charset>UTF-8</charset>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern>
        </encoder>
    </appender>

    <!--另一個滾動檔案寫法-->
    <appender name="errorFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>test.log</file>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>test.%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
        </rollingPolicy>
        <!--當檔案大小超過5MB時,通知RollingPolicy輪轉-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>5MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{36} : %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--配置多環境日志輸出  可以在application.properties中配置選擇哪個profiles-->
    <!--開發環境:列印控制臺-->
    <springProfile name="dev">
        <root level="debug">
            <appender-ref ref="stdout" />
            <appender-ref ref="infoFile" />
            <appender-ref ref="errorFile" />
        </root>
    </springProfile>
    <!--生產環境:只輸出到檔案-->
    <springProfile name="pro">
        <root level="info">
            <appender-ref ref="infoFile" />
            <appender-ref ref="errorFile" />
        </root>
    </springProfile>

</configuration>

  配合多環境組態檔:application.yml、application-dev.yml、application-pro.yml

  在主組態檔中具體選擇使用不同的環境,application.yml:

spring:
  profiles:
    active: dev

三、組態檔 logback-spring.xml 詳解:

  基本結構如下:

<?xml version="1.0" encoding="UTF-8"?>
<!-- 根節點 -->
<configuration scan="true" scanPeriod="60 seconds" debug="true">
    <!-- 用于區分不同應用程式的記錄 -->
    <contextName>xxx</contextName>
    <!-- 定義引數常量 -->
    <property name="xxx" value="yyy"/>
    <!-- 用于說明輸出介質,此處說明控制臺輸出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>xxx</pattern><!-- 列印格式 -->
            <charset>UTF-8</charset><!-- 解決亂碼問題 -->
        </encoder>
    </appender>
    <!-- 用于說明輸出介質,此處說明檔案輸出 -->
    <appender name="fileout" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 過濾器,用于篩選不同級別的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level><!-- 等級從低到高分別是ALL < TRACE < DEBUG < INFO < WARN < ERROR < OFF -->
        </filter>
        <!--滾動策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>xxx</fileNamePattern><!-- 日志檔案名 -->
            <maxHistory>xxx</maxHistory><!-- 最大保存周期,超過洗掉舊的日志 -->
            <totalSizeCap>xxx</totalSizeCap><!-- 總日志大小,超過洗掉舊的日志 -->
            <cleanHistoryOnStart>false</cleanHistoryOnStart><!-- appender 啟動的時候,是否洗掉歸檔檔案,默認false -->
        </rollingPolicy>
        <encoder>
            <charset>xxx</charset>
            <pattern>xxx</pattern>
        </encoder>
    </appender>
    <!-- 用于存放日志物件,同時指定關聯的package位置 -->
    <logger name="xxx" level="xxx" additivity="true">
        <appender-ref ref="stdout" />
        <appender-ref ref="fileout" />
    </logger>
    <!-- 特殊的logger,根logger -->
    <root lever="info">
        <appender-ref ref="stdout" /><!-- 指定默認的日志輸出 -->
    </root>
</configuration>

 

這里推薦一個學習地址 -- Javaschool

關于 logback.xml 和 logback-spring.xml 的區別,參見大佬文章 -- logback.xml 和 logback-spring.xml 的區別

四、效果演示

在專案中使用log有兩種方法:1.添加Lombok依賴,通過注解引入;2.通過工廠方式使用,

簡單效果如下:

 輸出日志:

到這里本文章基本就結束了,最后再給大家推薦一個B站up視頻 -- 使用 logback 輸出日志

參考文章:https://www.cnblogs.com/ergwang/p/14600913.html

轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/338904.html

標籤:Java

上一篇:redis集群詳解

下一篇:這才是責任鏈模式的優雅使用方式

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more