spring-logback引用外部文件實(shí)現(xiàn)方式

更新時(shí)間：2025年11月19日 09:18:43 作者：碼上走人

本文介紹了如何在Spring微服務(wù)開發(fā)中實(shí)現(xiàn)統(tǒng)一的日志配置,包括使用logback的繼承方式和spring-logback.xml配置,以及如何解決logback-include.xml文件在jar包中的位置問題,通過這種方式,可以在統(tǒng)一的日志格式和存儲(chǔ)方式下,給予服務(wù)一定程度的自主控制

背景

在spring微服務(wù)開發(fā)和云部署中，都涉及到日志的收集，很多時(shí)候?yàn)槔奖愎芾砗烷_發(fā)，很多公司都會(huì)開發(fā)一些基礎(chǔ)配置代碼。其中日志就是很重要的部分，

為了方便部署、收集、查看，所以日志文件需要存儲(chǔ)在同一個(gè)目錄下，且日志格式必須是相同的。

但是在微服務(wù)開發(fā)中，如果每個(gè)服務(wù)都自己創(chuàng)建的logback-spring.xml文件并配置信息，難免會(huì)出現(xiàn)錯(cuò)誤或者遺漏的地方。所以需要統(tǒng)一的logback-spring.xml配置，但是因?yàn)槟承┬枰?，可能服?wù)又會(huì)有自己獨(dú)特的日志文件記錄。所以需要日志打印不能請(qǐng)控制，必須未服務(wù)留有一定的自主控制。

原理

基于以上的要求，使用logback配置文件的繼承方式，既可以統(tǒng)一需要的日志的打印存儲(chǔ)方式，又可以在一定程度上給與服務(wù)自主開發(fā)的空間。

由于需要引入springboot的一些配置項(xiàng)，所以我們使用spring-logback.xml配置。

因?yàn)榧虞d順序：

logback.xml > application.properties/application.yaml > logback-spring.xml

logback的引用實(shí)現(xiàn)

logback引入其他的配置項(xiàng)使用<included></included> 和<include></include> 來(lái)實(shí)現(xiàn)。

從文件中包含

<include file="src/main/java/com/xxxx/configuration/includedConfig.xml"/>

特別注意一點(diǎn) ：logback-include.xml在 maven 中 , 不能直接放在src/resouces路徑下。

這樣的情況就是 ,logback-include.xml在 jar 的根路徑中 , 但不是跟logback.xml同一目錄 . 在沒有路徑的情況下 , 默認(rèn)只會(huì)去找同目錄下的文件 . 就找不到j(luò)ar包里的了。

<!-- logback.xml -->

<configuration>

<!-- 這么配置 , 只會(huì)找同目錄下的文件 -->

<include resource="logback-include.xml" />

</configuration>

從 classpath 中包含

<include resource="includedConfig.xml"/>

從 URL 中包含

<include url="http://some.host.com/includedConfig.xml"/>

如果包含不成功，那么 logback 會(huì)打印出一條警告信息，如果不希望 logback 抱怨，只需這樣做：

<include optional="true" ..../>

實(shí)現(xiàn)方式

公共基礎(chǔ)配置

先新建一個(gè)基礎(chǔ)配置模塊，這個(gè)模塊將被打成jar包，并在其他項(xiàng)目中被引用，這個(gè)項(xiàng)目中包括了基礎(chǔ)的日志配置，配置信息如下：

logback-base.xml

<included>

<contextName>${APPLICATION_NAME}</contextName>
<springProperty name="APPLICATION_NAME" scope="context" source="spring.application.name" defaultValue="core-logback-base"/>
<springProperty name="LOG_PATH" scope="context" source="logging.file" defaultValue="./log/application/${SERVICE_NAME}"/>
<springProperty name="LOG_MAX_FILE_SIZE" scope="context" source="logback.file.size" defaultValue="50MB"/>
<springProperty name="LOG_FILE_MAX_TIME" scope="context" source="logback.file.maxTime" defaultValue="24"/>
<springProperty name="LOG_FILE_TIME_FORMAT" scope="context" source="logback.file.timeFormat" defaultValue="yyyy-MM-dd'T'HH"/>
<springProperty name="ServerIP" scope="context" source="spring.cloud.client.ip-address" defaultValue="0.0.0.0"/>
<springProperty name="ServerPort" scope="context" source="server.port" defaultValue="0000"/>

<property name="SERVICE_NAME" value="${APPLICATION_NAME}"/>
<property name="LOG_PATTERN" value="[${SERVICE_NAME}] [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{30}: %line - %msg %n"/>

<appender name ="InfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--指定日志路徑和名稱-->
<file>${LOG_PATH}/${SERVICE_NAME}-info.log</file>
<!--是否使用追加日志的方式-->
<append>true</append>
<!--級(jí)別過濾器，只打印指定級(jí)別的日志-->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<!-- 當(dāng)發(fā)生滾動(dòng)時(shí)，決定RollingFileAppender的行為，涉及文件移動(dòng)和重命名 -->
<!--SizeAndTimeBasedRollingPolicy 它根據(jù)時(shí)間來(lái)制定滾動(dòng)策略，也限制每個(gè)文件的大小，既負(fù)責(zé)滾動(dòng)也負(fù)責(zé)出發(fā)滾動(dòng)-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--每天生成一個(gè)日志文件，保存maxHistory天的日志文件-->
<!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd}.log</fileNamePattern>-->
<!--每個(gè)分鐘生成一個(gè)日志文件，保存maxHistory小時(shí)的日志文件-->
<!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd'T'HH}.-%i.log</fileNamePattern>-->
<!--每個(gè)小時(shí)生成一個(gè)日志文件，保存maxHistory分鐘的日志文件,并且將及時(shí)日志文件進(jìn)行壓縮zip-->
<fileNamePattern>${LOG_PATH}/${SERVICE_NAME}.info.%d{${LOG_FILE_TIME_FORMAT}}.log%i.zip</fileNamePattern>
<!--限制每一個(gè)log文件的大小-->
<maxFileSize>100MB</maxFileSize>
<maxHistory>${LOG_FILE_MAX_TIME}</maxHistory>
</rollingPolicy>
<encoder>
<!--日志格式-->
　　　　　　<pattern>${LOG_PATTERN}</pattern>
　　　　</encoder>
</appender>

<appender name ="ErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--指定日志路徑和名稱-->
<file>${LOG_PATH}/${SERVICE_NAME}-error.log</file>
<!--是否使用追加日志的方式-->
<append>true</append>
<!--級(jí)別過濾器，只打印指定級(jí)別的日志-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<!-- 當(dāng)發(fā)生滾動(dòng)時(shí)，決定RollingFileAppender的行為，涉及文件移動(dòng)和重命名 -->
<!--SizeAndTimeBasedRollingPolicy 它根據(jù)時(shí)間來(lái)制定滾動(dòng)策略，也限制每個(gè)文件的大小，既負(fù)責(zé)滾動(dòng)也負(fù)責(zé)出發(fā)滾動(dòng)-->
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--每天生成一個(gè)日志文件，保存maxHistory天的日志文件-->
<!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd}.log</fileNamePattern>-->
<!--每個(gè)分鐘生成一個(gè)日志文件，保存maxHistory小時(shí)的日志文件-->
<!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd'T'HH}.-%i.log</fileNamePattern>-->
<!--每個(gè)小時(shí)生成一個(gè)日志文件，保存maxHistory分鐘的日志文件,并且將及時(shí)日志文件進(jìn)行壓縮zip-->
<fileNamePattern>${LOG_PATH}/${SERVICE_NAME}.error.%d{${LOG_FILE_TIME_FORMAT}}.log%i.zip</fileNamePattern>
<!--限制每一個(gè)log文件的大小-->
<maxFileSize>100MB</maxFileSize>
<maxHistory>24</maxHistory>
</rollingPolicy>
<encoder>
<!--日志格式-->
　　　　　　<pattern>${LOG_PATTERN}</pattern>
　　　　 </encoder>
</appender>

<root level ="INFO">
<appender-ref ref="InfoLog" level ="INFO"/>
<appender-ref ref="ErrorLog" level ="ERROR"/>
</root>
</included>

位置不要放在resources下，需要放在java目錄或其子目錄下，假設(shè)起路徑是：

com/test/core/log/xml/logback-base.xml

引用基礎(chǔ)配置

在其他的項(xiàng)目中，我們可以通過maven方式引入公共基礎(chǔ)配置的jar包。然后在項(xiàng)目的resources新建logback-spring.xm引入基礎(chǔ)配置，并加入自己的配置項(xiàng)。

<configuration scan="true" scanPeriod="60 seconds" debug="false">
<include resource="com/test/core/log/xml/logback-base.xml"/>

<!--輸出到控制臺(tái)-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>

<root level ="INFO">
<!-- 控制臺(tái)打印方式 -->
<appender-ref ref="CONSOLE" level="INFO"/>
</root>
</configuration>

同時(shí)在application.properties或application.yaml中配置日志文件方式：