SpringBoot日誌框架使用指南

市面上常見的日誌框架有很多,比如:JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等
通常情況下,日誌是由一個抽象層+實現層組合使用的

抽象層 實現層
JCL、SLF4J、jboss-logging jul、log4j、log4j2、logback

Spring默認使用 JCL,所以以前的項目大多要依賴 commons-logging.jar
有一位牛人定義了日誌抽象層 SLF4J,也對抽象進行了實現,它就是 log4j,後面再次改進了實現層,命名爲logback

SpringBoot默認使用 slf4j + logback的方式記錄日誌,slf4j的官網地址:http://www.slf4j.org/ ,裏面有文檔,以及和其他日誌框架統一整合的使用方法

1.創建SpringBoot項目,引入web和logging依賴
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

通過idea右側maven展開,spring-boot-starter-logging可以看到裏面依賴了 slf4j + logback
在這裏插入圖片描述
此時啓動項目就能看到控制檯打印的日誌,可以在 application.properties 中配置日誌等級參數來控制輸出的日誌信息,如: logging.level=info,那麼只有info 、warn、error這3種等級的日誌纔會輸出

2.把日誌寫到本地目錄

在項目 resources 目錄下添加 logback.xml 或 logback-spring.xml ,推薦使用 logback-spring.xml,內容如下,異步輸出日誌,批量打包壓縮都是提高日誌記錄性能的關鍵:

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="false">
    <springProperty scop="context" name="spring.application.name" source="spring.application.name" defaultValue=""/>
    <!-- 日誌路徑,當前項目 logs/ 下-->
    <property name="log.path" value="logs/${spring.application.name}" />
    <!-- 日誌等級 -->
    <property name="log.level" value="INFO"/>

    <!-- 控制檯日誌輸出 -->
    <!-- 彩色日誌格式 -->
    <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}}" />
    <!-- 彩色日誌依賴的渲染類 -->
    <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" />
    <!-- 控制檯日誌輸出 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>

    <!-- Log file info output -->
    <appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/%d{yyyy-MM-dd}/info/info-%d{yyyy-MM-dd}-%i.log.gz</fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%date [%thread] %-5level [%logger{50}] %file:%line - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- Log file error output -->
    <appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/%d{yyyy-MM-dd}/error/error-%d{yyyy-MM-dd}-%i.log.gz</fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%date [%thread] %-5level [%logger{50}] %file:%line - %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>


    <!-- 異步輸出,異步的log片段必須在同步段後面,否則不起作用 -->
    <appender name="FILE-INFO-ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>10000</queueSize>
        <appender-ref ref="info"/>
    </appender>
    <appender name="FILE-ERROR-ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>512</queueSize>
        <appender-ref ref="error"/>
    </appender>


    <!-- Level: FATAL 0  ERROR 3  WARN 4  INFO 6  DEBUG 7 -->
    <root level="${log.level}">
        <appender-ref ref="console"/>
        <appender-ref ref="FILE-INFO-ASYNC"/>
        <appender-ref ref="FILE-ERROR-ASYNC"/>
    </root>
</configuration>

再次運行項目後,可以在項目下看到 logs 文件夾和其中的日誌文件
在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章