快捷導(dǎo)航

SpringBoot多環(huán)境日志配置方式

更新時(shí)間：2024年08月27日 08:50:18 作者：進(jìn)擊的烏拉

SpringBoot?默認(rèn)使用LogBack日志系統(tǒng),默認(rèn)情況下,SpringBoot項(xiàng)目的日志只會(huì)在控制臺(tái)輸入,本文給大家介紹SpringBoot多環(huán)境日志配置方式,需要的朋友可以參考下

SpringBoot多環(huán)境日志配置

SpringBoot 默認(rèn)使用 LogBack 日志系統(tǒng)

默認(rèn)情況下，SpringBoot項(xiàng)目的日志只會(huì)在控制臺(tái)輸入。

如果想查詢(xún)歷史日志則無(wú)法找到，我們需要一個(gè)日志系統(tǒng)來(lái)統(tǒng)一管理日志。

一般正式項(xiàng)目會(huì)有單獨(dú)日志系統(tǒng)，將日志操作存入數(shù)據(jù)庫(kù)。

第一種方式是

在 application.properties或application.yml文件中添加

同時(shí)設(shè)置logging.file.name和logging.file.path，則logging.file.name會(huì)被忽略。

# 設(shè)置日志文件的具體名稱(chēng)
logging.file.name=./logfile.log
# 或者設(shè)置日志文件的目錄
logging.file.path=/logfile/

更詳細(xì)的配置也可在這個(gè)配置文件中寫(xiě)

第二種方式使用配置文件

1、引入依賴(lài)

引入slf4j-api 是為了使用 @Slf4j 注解簡(jiǎn)化操作

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

2、多環(huán)境配置

3、創(chuàng)建 logback xml

在 resource 下創(chuàng)建 logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <springProperty scope="context" name="applicationName"
                    source="spring.application.name" defaultValue="spring-restful-api"/>
    <!-- 單個(gè)日志文件的最大，尺寸 -->
    <springProperty scope="context" name="maxFileSize"
                    source="logging.file.max-size" defaultValue="10MB"/>
    <!-- 日志保留時(shí)長(zhǎng) (天) -->
    <springProperty scope="context" name="maxHistory"
                    source="logging.file.max-history" defaultValue="180"/>
    <!-- 日志文件路徑 -->
    <springProperty scope="context" name="logDir"
                    source="logging.file.path" defaultValue="./logs"/>
    <contextName>${applicationName}</contextName>
    <!-- 彩色日志 -->
    <!-- 彩色日志依賴(lài)的渲染類(lèi) -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID:- }) %clr(---){faint} %clr([%10t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wex"/>
    <property name="FILE_LOG_PATTERN"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p ${PID:- } --- [%t] %-40.40logger{39} : %m%n%wex"/>
    <!-- 控制臺(tái)輸出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- info日志 appender  -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${logDir}/info.log</file>
        <!-- 追加方式記錄日志默認(rèn)是true 日志被追加到文件結(jié)尾 -->
        <append>true</append>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <!-- 歸檔的日志文件的路徑，%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${logDir}/info/info-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動(dòng)文件的大小，默認(rèn)值是10MB，這里設(shè)置為20MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印info日志 -->
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- DEBUG日志 appender  -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${logDir}/debug.log</file>
        <!-- 追加方式記錄日志默認(rèn)是true 日志被追加到文件結(jié)尾 -->
        <append>true</append>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <fileNamePattern>${logDir}/debug/debug-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動(dòng)文件的大小，默認(rèn)值是10MB，這里設(shè)置為20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印DEBUG日志 -->
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- WARN日志 appender  -->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${logDir}/warn.log</file>
        <!-- 追加方式記錄日志默認(rèn)是true 日志被追加到文件結(jié)尾 -->
        <append>true</append>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <fileNamePattern>${logDir}/warn/warn-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動(dòng)文件的大小，默認(rèn)值是10MB，這里設(shè)置為20MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印WARN日志 -->
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!-- error 日志 appender  -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${logDir}/error.log</file>
        <!-- 追加方式記錄日志默認(rèn)是true 日志被追加到文件結(jié)尾 -->
        <append>true</append>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滾 daily -->
            <fileNamePattern>${logDir}/error/error-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的歷史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:這是活動(dòng)文件的大小，默認(rèn)值是10MB，這里設(shè)置為20MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder" charset="UTF-8">
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印錯(cuò)誤日志 -->
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    <!--  開(kāi)發(fā)環(huán)境和測(cè)試環(huán)境，日志輸出到控制臺(tái)  -->
    <springProfile name="dev|test">
        <!--控制臺(tái)和日志文件輸出級(jí)別-->
        <root level="INFO">
            <appender-ref ref="STDOUT"/>
        </root>
         <logger name="com.pyb.demo" level="debug"/> <!-- 開(kāi)發(fā)和測(cè)試環(huán)境, 指定某包日志為debug級(jí) -->
    </springProfile>
    <!--  生產(chǎn)環(huán)境，日志輸出到文件 -->
    <springProfile name="prod">
        <root level="INFO">
            <appender-ref ref="INFO"/>
            <appender-ref ref="ERROR"/>
            <appender-ref ref="DEBUG"/>
            <appender-ref ref="WARN"/>
        </root>
        <logger name="com.pyb.demo" level="warn"/> <!-- 生產(chǎn)環(huán)境, 指定某包日志為warn級(jí) -->
        <logger name="com.pyb.demo.Application" level="info"/> <!-- 特定某個(gè)類(lèi)打印info日志, 比如application啟動(dòng)成功后的提示語(yǔ) -->
    </springProfile>
</configuration>

解釋

    <!--
        <logger>用來(lái)設(shè)置某一個(gè)包或者具體的某一個(gè)類(lèi)的日志打印級(jí)別、
        以及指定<appender>。<logger>僅有一個(gè)name屬性，
        一個(gè)可選的level和一個(gè)可選的addtivity屬性。
        name:用來(lái)指定受此logger約束的某一個(gè)包或者具體的某一個(gè)類(lèi)。
        level:用來(lái)設(shè)置打印級(jí)別，大小寫(xiě)無(wú)關(guān)：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
              還有一個(gè)特殊值INHERITED或者同義詞NULL，代表強(qiáng)制執(zhí)行上級(jí)的級(jí)別。
              如果未設(shè)置此屬性，那么當(dāng)前l(fā)ogger將會(huì)繼承上級(jí)的級(jí)別。
        addtivity:是否向上級(jí)logger傳遞打印信息。默認(rèn)是true。
        <logger name="org.springframework.web" level="info"/>
        <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
    -->
    <!--
        使用mybatis的時(shí)候，sql語(yǔ)句是debug下才會(huì)打印，而這里我們只配置了info，所以想要查看sql語(yǔ)句的話(huà)，有以下兩種操作：
        第一種把<root level="info">改成<root level="DEBUG">這樣就會(huì)打印sql，不過(guò)這樣日志那邊會(huì)出現(xiàn)很多其他消息
        第二種就是單獨(dú)給dao下目錄配置debug模式，代碼如下，這樣配置sql語(yǔ)句會(huì)打印，其他還是正常info級(jí)別：
        【logging.level.org.mybatis=debug logging.level.dao=debug】
     -->
    <!--
        root節(jié)點(diǎn)是必選節(jié)點(diǎn)，用來(lái)指定最基礎(chǔ)的日志輸出級(jí)別，只有一個(gè)level屬性
        level:用來(lái)設(shè)置打印級(jí)別，大小寫(xiě)無(wú)關(guān)：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
        不能設(shè)置為INHERITED或者同義詞NULL。默認(rèn)是DEBUG
        可以包含零個(gè)或多個(gè)元素，標(biāo)識(shí)這個(gè)appender將會(huì)添加到這個(gè)logger。
    -->

4.使用

完整策略

http://www.dbjr.com.cn/program/291607cfi.htm

缺點(diǎn)（啟動(dòng)項(xiàng)目可能會(huì)報(bào)錯(cuò)）

spring會(huì)優(yōu)先加載項(xiàng)目中或者jar包中的logback.xml并讀取里邊的路徑（/workspace/api-default.log），然后再加載application.yml之后再加載我們的日志文件logback-spring.xml，項(xiàng)目部署在服務(wù)器上運(yùn)行一般不會(huì)用root這種權(quán)限很大的用戶(hù)執(zhí)行，權(quán)限小的會(huì)對(duì)logback.xml里的路徑可能會(huì)沒(méi)有操作權(quán)限就會(huì)導(dǎo)致項(xiàng)目啟動(dòng)失敗。

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

您可能感興趣的文章: