快捷導(dǎo)航

springboot]logback日志框架配置教程

更新時間：2022年04月29日 09:12:06 作者：字母哥哥

這篇文章主要介紹了springboot]logback日志框架配置,logback既可以通過application配置文件進(jìn)行日志的配置，又可以通過logback-spring.xml進(jìn)行日志的配置，本文給大家介紹的非常詳細(xì)，需要的朋友參考下吧

logback既可以通過application配置文件進(jìn)行日志的配置，又可以通過logback-spring.xml進(jìn)行日志的配置。通常情況下，使用全局配置文件application.yml或properties進(jìn)行配置就足夠了，如果您的日志輸出需求特別復(fù)雜而且需求比較個性化，可以考慮使用logback-spring.xml的配置方式。

一、application配置文件實(shí)現(xiàn)日志配置

我們可以在applicaition.properties(yml) 文件中進(jìn)行日志的配置

logging:
  level:
    root: info
    com.zimug.boot.launch.controller: debug
  file:
    path: D:\logs
    name: D:\logs\boot-launch.log
    max-size: 10MB
    max-history: 10
  pattern:
    console: '%red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger{10}) - %cyan(%msg%n)'
    file: '%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger : %msg%n'

logging.level.root=info指定整個系統(tǒng)的默認(rèn)日志級別是info，日志級別統(tǒng)一化
logging.level.com.zimug.boot.launch.controller=debug,指定某個特定的package的日志級別是debug，日志級別個性化。優(yōu)先級角度，個性配置大于統(tǒng)一配置。
logging.file.path將日志輸出到指定目錄，如果不指定
logging.file.name，日志文件的默認(rèn)名稱是spring.log。配置了logging.file.name之后，logging.file.path配置失效。
無論何種設(shè)置，Spring Boot都會自動按天分割日志文件，也就是說每天都會自動生成一個新的log文件，而之前的會自動打成GZ壓縮包。# 日志文件大小
可以設(shè)置logging.file.max-size=10MB分割的每個日志的文件最大容量，超過這個size之后日志繼續(xù)分隔。
可以設(shè)置保留的日志時間logging.file.max-history=10，以天為單位
logging.pattern.file輸出到文件中的日志的格式
logging.pattern.console控制臺輸出日志的格式，為了在控制臺調(diào)試時候顯示效果更清晰，為日志增加了顏色。red、green等等

日志格式占位符

配合這張圖，看一下占位符和logging.pattern.console格式配置之間的關(guān)系

%d{HH:mm:ss.SSS}：日志輸出時間（red）
%thread：輸出日志的進(jìn)程名字，這在Web應(yīng)用以及異步任務(wù)處理中很有用（green）
%-5level：日志級別，并且使用5個字符靠左對齊（highlight高亮藍(lán)色）
%logger：日志輸出類的名字（boldMagenta粗體洋紅色）
%msg：日志消息（cyan藍(lán)綠色）
%n：平臺的換行符

二、使用logback-spring.xml實(shí)現(xiàn)日志配置

2.1.需求

一般情況下，使用全局配置文件application.yml或properties進(jìn)行配置就足夠了，如果您的日志輸出需求特別復(fù)雜，可以考慮使用logback-spring.xml的配置方式。

spring boot 用自帶的logback打印日志，多環(huán)境打印：

生產(chǎn)環(huán)境輸出到控制臺和文件,一天一個文件,保留30天.
開發(fā)環(huán)境輸出到控制臺和打印sql(mybatis)輸出，生產(chǎn)環(huán)境不打印這個信息
測試環(huán)境只輸出到控制臺。不輸出到文件

打印Mybatis SQL，只需要把使用到Mybatis的package的日志級別調(diào)整為DEBUG，就可以將SQL打印出來。

2.2.需求實(shí)現(xiàn)

因?yàn)閘ogback是spring boot的默認(rèn)日志框架，所以不需要引入maven依賴，直接上logback-spring.xml放在resources下面

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--引入默認(rèn)的一些設(shè)置-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <!--web信息-->
    <logger name="org.springframework.web" level="info"/>
    <!--寫入日志到控制臺的appender,用默認(rèn)的,但是要去掉charset,否則windows下tomcat下亂碼-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!--定義日志文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_PATH" value="D:/logs/boot-launch"/>
    <!--寫入日志到文件的appender-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件輸出的文件名,每天一個文件-->
            <FileNamePattern>${LOG_PATH}.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天數(shù)-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    <!--異步寫日志到文件-->
    <appender name="asyncFileAppender" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>500</queueSize>
        <appender-ref ref="FILE"/>
    </appender>
    <!--生產(chǎn)環(huán)境:打印控制臺和輸出到文件-->
    <springProfile name="prod">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="asyncFileAppender"/>
        </root>
    </springProfile>
    <!--開發(fā)環(huán)境:打印控制臺-->
    <springProfile name="dev">
        <!-- 打印sql -->
        <logger name="com.zimug.boot.launch" level="DEBUG"/>
        <root level="DEBUG">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
    <!--測試環(huán)境:打印控制臺-->
    <springProfile name="test">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
        </root>
    </springProfile>
</configuration>

異步日志配置：

異步日志queueSize 默認(rèn)值256，異步日志隊(duì)列的容量。
discardingThreshold：當(dāng)異步日志隊(duì)列的剩余容量小于這個閾值，會丟棄TRACE, DEBUG or INFO級別的日志。如果不希望丟棄日志（即全量保存），那可以設(shè)置為0。但是當(dāng)隊(duì)列占滿后，非阻塞的異步日志會變成阻塞的同步日志。所以在高并發(fā)低延遲要求的系統(tǒng)里面針對不重要的日志可以設(shè)置discardingThreshold丟棄策略，值大于0。

2.3.測試一下

上面配置完成之后，可以使用如下代碼測試一下，是否滿足了2.1節(jié)中提出的需求。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@RestController
public class LogTestController {
    private static final Logger logger = LoggerFactory.getLogger(LogTestController.class);
    @GetMapping("/testlog")
    public void test(){
        logger.trace("Trace 日志...");
        logger.debug("Debug 日志...");
        logger.info("Info 日志...");
        logger.warn("Warn 日志...");
        logger.error("Error 日志...");
    }
}

到此這篇關(guān)于springboot]logback日志框架配置的文章就介紹到這了,更多相關(guān)springboot logback日志框架內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: