一. 整合背景

請移步log4j架構的介紹文章：《一個著名的日誌系統是怎麼設計出來的？》

每個日誌框架系統都有期優劣之處, logback作爲log4j 原作者的升級版本, 存在諸多優勢:

Logback同樣是由Log4j的作者設計完成的，擁有更好的特性，用來取代Log4j的一個日誌框架，是Slf4j的原生實現（Native implementations）

使用日誌框架的最佳實踐是選擇一款日誌門面+一款日誌實現，這裏選擇Slf4j+Logback, Slf4j作者也是Logback的作者

SpringBoot從1.4版本開始，內置的日誌框架就是Logback

方便的配置日誌輸出至console, 並同時在磁盤上以文件形式留存，還可以按日誌Level 來分別生產日誌文件夾, 如: info/debug/error/warn，日誌可以按照配置規則, 方面的進行按天/時/分鐘不同粒度的歸檔操作.

logback在springboot maven繼承樹中的位置:

①. pom.xml 中parent

<parent>標籤作用:
.
現在有這樣一個場景，有兩個web項目A、B，一個java項目C，它們都需要用到同一個jar包：common.jar。如果分別在三個項目的pom文件中定義各自對common.jar的依賴，那麼當common.jar的版本發生變化時，三個項目的pom文件都要改，項目越多要改的地方就越多，很麻煩。
這時候就需要用到parent標籤, 我們創建一個parent項目，打包類型爲pom，parent項目中不存放任何代碼，只是管理多個項目之間公共的依賴。在parent項目的pom文件中定義對common.jar的依賴，ABC三個子項目中只需要定義，parent標籤中寫上parent項目的pom座標就可以引用到common.jar了。
`
同理, springboot項目構建時, 也用到了這一特性, 會從parent繼承過來通用的配置.

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.6.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>test-project</artifactId>
	<version>1.0.0-SNAPSHOT</version>
	<name>test-project</name>
	<description>Demo project for Spring Boot</description>

②. 查看其上一層的依賴(按住ctrl + 鼠標點擊artifactId), 如下:
由下面的artifactId中的名字(spring-boot-dependencies)可以看出, 這裏包含的都是spring-boot項目所需的公共依賴, 不存放任何代碼.

依賴文件名: spring-boot-dependencies-2.1.6.RELEASE.pom

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.1.6.RELEASE</version>
    <relativePath>../../spring-boot-dependencies</relativePath>
  </parent>
  <artifactId>spring-boot-starter-parent</artifactId>
  <packaging>pom</packaging>
  <name>Spring Boot Starter Parent</name>
  <description>Parent pom providing dependency and plugin management for applications
		built with Maven</description>
  <url>https://projects.spring.io/spring-boot/#/spring-boot-starter-parent</url>



# 向下翻, 可以看到 spring-boot-starter-logging 這個依賴包

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-logging</artifactId>
        <version>2.1.6.RELEASE</version>
      </dependency>

③. 繼續查看(spring-boot-starter-logging) 其上一層的依賴(按住ctrl + 鼠標點擊artifactId), 如下:

依賴文件名: spring-boot-starter-logging-2.1.6.RELEASE.pom

<dependencies>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-to-slf4j</artifactId>
      <version>2.11.2</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jul-to-slf4j</artifactId>
      <version>1.7.26</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>

可以清楚的看到, logback/ log4j-to-slf4j 門面轉換器 / jul-to-slf4j 門面轉換器, 都已包含在spring-boot的公共依賴中.

④. pom.xml 依賴調用鏈示意圖如下:

二. 實現目標

SpringBoot項目在啓動時, 如果未加額外的日誌配置, 則默認日誌會輸出到控制檯(Console)中.

以下實驗希望實現如下目標:
①. 日誌不僅需要打印在控制檯, 還需要輸入到文件系統中;
②. 文件系統的輸出日誌, 需要區分 INFO 和 ERROR 級別, 並分別生產對應的日誌文件;
③. 制定文件日誌的滾動策略, 如按天滾動生成日誌;
④. 控制保留的歸檔文件的最大數量，超出數量就刪除舊文件，假設設置每日滾動，
且是10，則只保存最近10天的日誌文件，刪除10日之前的舊文件;

三. 整合的實現

3.1 logback的文件命名

方式	說明
官方推薦	默認讀取resources目錄下的 logback-spring.xml
自定義位置	application.yml中配置: ( logging.config: classpath:`log/logback-spring.xml`; logging.level.root: info )

3.2 logback-spring.xml配置文件詳解

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置爲WARN，則低於WARN的信息都不會輸出 -->
<!-- scan:當此屬性設置爲true時，配置文件如果發生改變，將會被重新加載，默認值爲true -->
<!-- scanPeriod:設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。 -->
<!-- debug:當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。 -->
<configuration  scan="true" scanPeriod="10 seconds" debug="true">

    <!--<include resource="org/springframework/boot/logging/logback/base.xml" />-->

    <contextName>springboot2_logback</contextName>
    <!-- name的值是變量的名稱，value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量後，可以使“${}”來使用變量。 -->
    <!-- 若value="logs" 這種形式則在項目根目錄下創建一個叫logs的文件夾 -->
    <!-- 若value="/logs" 這種形式則在系統根目錄下創建一個叫logs的文件夾 -->
    <property name="log.path" 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" />
    <!-- 彩色日誌格式 -->
    <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="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日誌appender是爲開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!--輸出到文件-->
    <!-- 時間滾動輸出 level爲 DEBUG 日誌 -->
    <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <file>${log.path}/log_debug.log</file>
        <!--日誌文件輸出格式-->
        <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}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文件只記錄debug級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 時間滾動輸出 level爲 INFO 日誌 -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <file>${log.path}/log_info.log</file>
        <!--日誌文件輸出格式-->
        <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/log-info-%d{yyyy-MM-dd-HH-mm}.%i.log</fileNamePattern> <!-- 這裏測試時,一分鐘生成一個日誌文件 -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文件只記錄info級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 時間滾動輸出 level爲 WARN 日誌 -->
    <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <file>${log.path}/log_warn.log</file>
        <!--日誌文件輸出格式-->
        <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}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日誌文件只記錄warn級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>


    <!-- 時間滾動輸出 level爲 ERROR 日誌 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌文件的路徑及文件名 -->
        <file>${log.path}/log_error.log</file>
        <!--日誌文件輸出格式-->
        <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}/error/log-error-%d{yyyy-MM-dd-HH-mm}.%i.log</fileNamePattern> <!-- 這裏測試時,一分鐘生成一個日誌文件 -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日誌文件保留天數-->
            <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>用來設置某一個包或者具體的某一個類的日誌打印級別、以及指定<appender>。
        <logger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。
        name:用來指定受此logger約束的某一個包或者具體的某一個類。
        level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特殊值INHERITED或者同義詞NULL，代表強制執行上級的級別。如果未設置此屬性，那麼當前logger將會繼承上級的級別。
        addtivity:是否向上級logger傳遞打印信息。默認是true。
    -->
    <!--<logger name="org.springframework.web" level="info"/>-->
    <!--<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->

    <!-- 關閉kafka日誌 -->
    <logger name="org.apache.kafka.clients.consumer.ConsumerConfig" level="off" />
    <logger name="org.apache.kafka" level="off" />



    <!-- 標籤作用: 獲取到項目所處的環境是線上還是線下，根據這個來指定部分日誌是否記錄 -->
    <!-- 開發環境:打印控制檯 -->
    <springProfile name="dev">
    <!--&lt;!&ndash;<logger name="com.nmys.view" level="debug"/>&ndash;&gt;-->
    <!--&lt;!&ndash;<logger name="com.rsi.rc" level="debug"/>&ndash;&gt;-->
        <!-- 這一行如果放開的話,則判斷如果是dev開發環境, 則console裏只打印error級別的日誌 -->
        <logger name="com.example.springboot2_logback.scheduler.MyTestScheduler" level="error"/>
    </springProfile>

    <!--
        root節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個level屬性
        level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設置爲INHERITED或者同義詞NULL。默認是DEBUG
        可以包含零個或多個元素，標識這個appender將會添加到這個logger。
    -->
    <!-- ref="CONSOLE" 引用的就是24行定義的,24行註釋然後這裏引用了的話就會報錯，上面和這裏都不寫的話控制檯就不輸出，只輸出到文件裏 -->
    <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>

    <!--生產環境:輸出到文件-->
    <!--<springProfile name="prod">-->
    <!--<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>

注意事項:

注意事項1. springProfile 配置爲dev時, 輸出端可以爲console, 但配成prod時, 切記關閉console輸出.
注意事項2. 上述配置完成後,啓動springboot項目, 發現log.debug()的日誌並未輸出, 如果想輸出debug日誌, 則需按如下方式配置:
①.要想輸出log.debug() 則首先要把下面的debug,意思是只要是大於等於debug的都輸出，但是發現光改一個這個地方還是不會輸出，看第二步.

<!--輸出到控制檯-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--此日誌appender是爲開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

②.然後最下面的因爲設置成了info，是給所有整體設置level，也就是說這裏設置成info後info以下的都不會輸出了，除非單獨給某些目錄設置成debug，設置成info是因爲要是改成debug的話會出來很多debug信息，框架內部的日誌，所以要在yml配置文件中指定哪些目錄輸出級別設爲debug，配置方式爲如下:

logging:
  level:
    example.springboot2_logback.scheduler: debug

注意事項3. SpringBoot默認讀取resources下的，若是放到了自定義的路徑下, 則需要在application.yml中配置其具體路徑（語法: classpath爲resources路徑）
樣例配置如下:

logging:
   config: classpath:log/logback-spring.xml

注意事項4. mybatis的sql日誌打印問題?
使用mybatis的時候，sql語句是debug下才會打印，而這裏我們只配置了info，即使我們不配置爲info，也不會打印，因爲系統默認也是info，所以想要查看sql語句的話，有以下兩種操作：
方式一: 把<root level=“info”>改成<root level=“DEBUG”>這樣就會打印sql，不過這樣日誌那邊會出現很多其他框架的輸出的信息.
方式二: 單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql語句會打印，其他還是正常info級別，如下

  level:
    example.springboot2_logback.module: debug

這樣單獨配置後控制檯還是以info輸出，但是在上面目錄我指定爲debug了上面目錄下的log.debug也會輸出

logging:
   config: classpath:log/logback-spring.xml

3.3 application.yml 樣例

spring:
  profiles:
    active: dev

3.4 application-dev.yml 樣例

server:
  address: 11.11.11.11
  port: 8080

spring:
  profiles:
    name: project001
  aop:
    proxy-target-class: true
    auto: true
  datasource:
    druid:
      moduleName:
        url: jdbc:mysql://localhost:3306/project001_db?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false
        username: root
        password: xxxx
        driver-class-name: com.mysql.cj.jdbc.Driver
        initialSize: 5
        minIdle: 5
        maxActive: 20

myemail:
  to-user: [email protected]
  to-name: BigDataMonitor
  host: smtp.provider.com
  port: 25
  from-user: [email protected]
  from-password: xxxxx
  from-name: This is from Test Program

#logging:
#  config: classpath:log/logback-spring.xml
#  level:
#    root: info

#mybatis:
#  configuration:
#    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3.5 application-prod.yml 樣例

server:
  address: 22.22.22.22
  port: 8080

spring:
  profiles:
    name: project001
  aop:
    proxy-target-class: true
    auto: true
  datasource:
    druid:
      moduleName:
        url: jdbc:mysql://{DBMS_IP}:{DBMS_PORT}/project001_db?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false
        username: root
        password: xxxx
        driver-class-name: com.mysql.cj.jdbc.Driver
        initialSize: 5
        minIdle: 5
        maxActive: 20

myemail:
  to-user: [email protected]
  to-name: BigDataMonitor
  host: smtp.provider.com
  port: 25
  from-user: [email protected]
  from-password: xxxxx
  from-name: This is from Test Program

#logging:
#  config: classpath:log/logback-spring.xml
#  level:
#    root: info

#mybatis:
#  configuration:
#    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3.6 測試程序清單

MyTestScheduler.java:

package com.example.springboot2_logback.scheduler;

import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@Component
@Slf4j
public class MyTestScheduler {

//    private static Logger log = LoggerFactory.getLogger(MyTestScheduler.class);

    @Scheduled(cron = "*/10 * * * * ?")
    public void test(){
        log.debug(">>>>>>>>>>>>>>>>>>>>>>>>>> debug");
        log.info(">>>>>>>>>>>>>>>>>>>>>>>>>> info");
        log.warn(">>>>>>>>>>>>>>>>>>>>>>>>>> warn");
        log.error(">>>>>>>>>>>>>>>>>>>>>>>>>> error");
    }

}

引用列表:

springboot2.x整合logback日誌系統

一. 整合背景

二. 實現目標

三. 整合的實現

3.1 logback的文件命名

3.2 logback-spring.xml配置文件詳解

3.3 application.yml 樣例

3.4 application-dev.yml 樣例

3.5 application-prod.yml 樣例

3.6 測試程序清單

一鍵自動化博客發佈工具,用過的人都說好(頭條篇)

Windows刪除EFI系統分區

springboot2集成mybatis-plus

【Web加密系列：二】shiro框架詳解

【Web加密系列：三】10分鐘瞭解JSON Web令牌（JWT）

Java codeCache

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結