springboot-logback 實戰(zhàn)(項目中極簡應(yīng)用)

之前整合過logback,但是看起來花里胡哨,中看不中用,也沒有詳細(xì)介紹,今天來理一下實際項目中快速應(yīng)用,根據(jù)實際場景解決問題。

第一步:創(chuàng)建一個極簡的springboot項目

yml只需把端口配置好能夠啟動就行

server:
  port: 8080

pom文件加入基本依賴

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

由于springboot的spring-boot-starter幫我們自動集成了spring-boot-starter-logging的依賴,再額外加上lombok依賴,我們就可以直接使用注解@Slf4j來打日志了

@Slf4j
@SpringBootApplication
public class Main {

    public static void main(String[] args) {
        SpringApplication.run(Main.class, args);
        log.info("我可以快樂的打日志了");
    }
}

當(dāng)然我們做api開發(fā)一般注解都加到controller類上面,到現(xiàn)在我們簡單的操作就把日志輸出到控制臺了,雖然沒有配置日志的格式控制臺也按照一定的格式輸出了,這是因為當(dāng)前啟用的是logback的默認(rèn)設(shè)置,那么默認(rèn)設(shè)置都有哪些?首先直接啟動項目后控制臺只輸出info級別的日志,默認(rèn)設(shè)置不會把日志輸出到日志文件等等,如果我們想要自定義那么先從簡單的配置開始。

第二步:yml極簡配置日志屬性
logging:
  level:
    root: info
    com:
      baidu:
        test:
          mapper: debug
  file:
    name: ./log/business_Log/bsiness.log
    max-history: 1
    max-size: 10MB
    clean-history-on-start: true
    total-size-cap: 10240
    path:
  pattern:
    rolling-file-name:
    dateformat:
    level:
    file:
    console:

我們看到logging節(jié)點下的幾個常用屬性,level、file、pattern,還有其他屬性有時間可以繼續(xù)深入研究,可以在yml里借助IDE來查看具體屬性。


image.png
這里從level開始。
image.png

1.root 可以設(shè)置日志的幾個打印級別,如果設(shè)置為info那就打印info級別以上的,像debug就不打印了,日志打印優(yōu)先級可以自行百度。root可以全局控制輸出,包括控制臺輸出和文件輸出,當(dāng)前設(shè)置為info那么就打印info級別以上的。

2.包名com.baidu.test.mapper 可以指定某個包的日志級別,當(dāng)前為debug,那么會將該包下的日志都已debug級別以上的全部輸出。

接著file 我們可以看到對應(yīng)屬性的默認(rèn)值
image.png

1.path 可以填寫日志輸出文件路徑./log/business_Log,表示當(dāng)前項目根路徑下business_Log文件夾,也可以不用配置,直接配置指定路徑的name屬性。
2.name 可以直接配置路徑加文件名./log/business_Log/bsiness.log,一步到位不用配置path,當(dāng)該路徑不存在時,系統(tǒng)會默認(rèn)創(chuàng)建。
3.max-history 默認(rèn)設(shè)置的是7,也就是只保存最近7天的日志文件,那么超出7天是否清除掉日志文件,取決于clean-history-on-start: true這個屬性(因為時間原因我沒有驗證),默認(rèn)設(shè)置是false,設(shè)置為true時超過7天自動清除才會自動清除(可以自己試驗一下,設(shè)置為1天,然后把項目啟動起來,隔天看看是否只保留一天的日志)
4.max-size 系統(tǒng)默認(rèn)是按照日期切割日志的,也就是每天會切割一個日志文件然后打包備份到指定路徑的文件夾,那么此處max-size是按照文件大小10M來切割的,超過10m就會將文件打包重新生成一個日志文件繼續(xù)寫入。
5.total-size-cap 這個屬性可以計算統(tǒng)計輸出文件的總大小,可以約束文件占用磁盤到一定容量,比如15M,超過限定的容量15M,會自動清除較早的日志文件,讓日志時鐘占用15M左右的空間。默認(rèn)值是0B。主要用來避免大量日志文件把服務(wù)器磁盤資源撐爆。

接著pattern
image.png

1.level 可以配置打印日志顯示的level 的樣式
2.file 輸出到日志文件的日志樣式
3.dateformat 日期格式
4.rolling-file-name 可以設(shè)置日志文件切割后備份的文件名格式,但是這個屬性必須把file.path的路徑./log/business_Log配置好,這樣切割后的文件后放到該路徑下,否則就放到項目根路徑下了。
5.console 可以設(shè)置控制臺輸出的日志樣式

以上通過配置yml可以實現(xiàn)簡單自定義配置,更多的個性化配置貌似支持不夠,比如控制臺打印彩色日志,配置多個appender,官方文檔中給出的屬性也比較有限(以下圖片不清楚能否通過配置簡單配置yml就能實現(xiàn)),所以需要通過配置文件來解決。
image.png
第三步:自定義配置logback-spring.xml

上一篇整合logback比較復(fù)雜,這次只需簡單配置

<?xml version="1.0" encoding="UTF-8"?>

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logback</contextName>
    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="log.path" value="./log/business_Log" />



    <!--輸出到控制臺-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <withJansi>true</withJansi>
        <encoder>
            <!--<pattern>%d %p (%file:%line\)- %m%n</pattern>-->
            <!--格式化輸出:%d:表示日期    %thread:表示線程名     %-5level:級別從左顯示5個字符寬度  %msg:日志消息    %n:是換行符-->
            <pattern>%red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger) - %cyan(%msg%n)</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--輸出到文件-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <file>${log.path}/logback.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/logback-%d{yyyy-MM-dd-HH-mm}.log</fileNamePattern>
            <maxHistory>365</maxHistory>
<!--            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">-->
<!--                <maxFileSize>100kB</maxFileSize>-->
<!--            </timeBasedFileNamingAndTriggeringPolicy>-->
        </rollingPolicy>
        <encoder>
            <!--格式化輸出:%d:表示日期    %thread:表示線程名     %-5level:級別從左顯示5個字符寬度  %msg:日志消息    %n:是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--    如果appender里沒有限定日志級別,那么root可以統(tǒng)一設(shè)置,如果沒有配置那么控制臺和文件不會輸出任何日志,這里root的levvel不做限制-->
    <root >
        <!--        允許控制臺輸出-->
        <appender-ref ref="console" />
        <!--        允許文件輸出-->
        <appender-ref ref="file" />
    </root>

</configuration>

執(zhí)行的效果是,每分鐘切割一下日志


image.png

控制臺輸出彩色日志


image.png

更多配置可以參考上一篇,當(dāng)前項目這樣配置已經(jīng)能滿足需求了,我不需要把日志按級別分類,日志量比較大的時候可以一個小時切割一次,小的話一天切割一次,之前項目按照100M來切割,當(dāng)從服務(wù)器下載日志時100M還是很耗時的,所以用時間來切割比較符合我當(dāng)前場景,這樣每個文件20M左右。

如果還是覺得有點大那么可以壓縮,修改以下配置

       <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/logback-%d{yyyy-MM-dd-HH-mm}.%i.log.zip</fileNamePattern>
            <maxHistory>365</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!--文件達(dá)到 最大128MB時會被壓縮和切割 -->
                <maxFileSize>10kB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

當(dāng)前設(shè)置為每分鐘切割日志文件,如果當(dāng)前文件超過10kB那么就切割成壓縮包用序號編號,到下一分鐘又從0開始編號,以下是壓縮效果


image.png
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容