logback配置中變量和include的應(yīng)用方式
更新時(shí)間：2021年08月30日 11:29:05 作者：SonOfWind0311
這篇文章主要介紹了logback配置中變量和include的應(yīng)用方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
logback配置中變量和include的應(yīng)用
logback配置在實(shí)際應(yīng)用中往往會(huì)遇到appender的配置中存在大量的重復(fù)內(nèi)容，但是logback又不像編程語(yǔ)言一樣支持繼承，采用include和變量結(jié)合可以一定程度上解決這個(gè)問(wèn)題。
Example：
<appender class="ch.qos.logback.core.rolling.RollingFileAppender" name=WarnLogFile">
<encoder>
<charset>UTF-8</charset>
<pattern>%d{dd.MMM.yyyy HH:mm:ss.SSS z}, [%6t], %6p, %C:%M %m%n</pattern>
</encoder>
<file>${LOGS_DIR}/warn.log</file>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>40MB</maxFileSize>
</triggeringPolicy>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>${LOGS_DIR}/warn%i.log.gz</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>21</maxIndex>
</rollingPolicy>
</appender>
<appender class="ch.qos.logback.classic.AsyncAppender" name="Warn">
<queueSize>2048</queueSize>
<includeCallerData>true</includeCallerData>
<discardingThreshold>0</discardingThreshold>
<appender-ref ref="WarnLogFile" />
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>WARN</level>
</filter>
</appender>
<appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="InfoLogFile">
<encoder>
<charset>UTF-8</charset>
<pattern>%d{dd.MMM.yyyy HH:mm:ss.SSS z}, [%6t], %6p, %C:%M %m%n</pattern>
</encoder>
<file>${LOGS_DIR}/info.log</file>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>10MB</maxFileSize>
</triggeringPolicy>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>${LOGS_DIR}/info%i.log.gz</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>21</maxIndex>
</rollingPolicy>
</appender>
<appender class="ch.qos.logback.classic.AsyncAppender" name="info">
<queueSize>2048</queueSize>
<includeCallerData>true</includeCallerData>
<discardingThreshold>0</discardingThreshold>
<appender-ref ref="infoLogFile" />
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
</appender>
<appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="DebugLogFile">
<encoder>
<charset>UTF-8</charset>
<pattern>%d{dd.MMM.yyyy HH:mm:ss.SSS z}, [%6t], %6p, %C:%M %m%n</pattern>
</encoder>
<file>${LOGS_DIR}/debug.log</file>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>5MB</maxFileSize>
</triggeringPolicy>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>${LOGS_DIR}/debug%i.log.gz</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>21</maxIndex>
</rollingPolicy>
</appender>
<appender class="ch.qos.logback.classic.AsyncAppender" name="Debug">
<queueSize>2048</queueSize>
<includeCallerData>true</includeCallerData>
<discardingThreshold>0</discardingThreshold>
<appender-ref ref="DebugLogFile" />
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>DEBUG</level>
</filter>
</appender>
可以看到以上的三個(gè)定義存在大量的重復(fù)內(nèi)容會(huì)導(dǎo)致logback文件很大，不容易維護(hù)，結(jié)合變量和include則可以一定程度上解決這個(gè)問(wèn)題。
首先把配置內(nèi)容抽取一個(gè)公共文件default.xml
把不同的內(nèi)容用變量定義：
<included>
<appender class="ch.qos.logback.core.rolling.RollingFileAppender" name="${FILE_APPENDER}">
<encoder>
<charset>UTF-8</charset>
<pattern>%d{dd.MMM.yyyy HH:mm:ss.SSS z}, [%6t], %6p, %C:%M %m%n</pattern>
</encoder>
<file>${LOGS_DIR}/${LOGFILE}.log</file>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<maxFileSize>5MB</maxFileSize>
</triggeringPolicy>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>${LOGS_DIR}/${LOGFILE}%i.log.gz</fileNamePattern>
<minIndex>1</minIndex>
<maxIndex>21</maxIndex>
</rollingPolicy>
</appender>
<appender class="ch.qos.logback.classic.AsyncAppender" name="${ASYNC_APPENDER}">
<queueSize>2048</queueSize>
<includeCallerData>true</includeCallerData>
<discardingThreshold>0</discardingThreshold>
<appender-ref ref="${FILE_APPENDER}" />
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>${LOG_LEVEL}</level>
</filter>
</appender>
</included>
然后基于公共文件定義各自的配置
warn.xml：
<included>
<property scope="local" name="LOGFILE" value="warn" />
<property scope="local" name="FILE_APPENDER" value="WarnLogFile" />
<property scope="local" name="ASYNC_APPENDER" value="warn" />
<property scope="local" name="LOG_LEVEL" value="WARN" />
<include file="${LOGS_CUSTOM_DIR}/default.xml"/>
</included>
info.xml：
<included>
<property scope="local" name="LOGFILE" value="info" />
<property scope="local" name="FILE_APPENDER" value="InfoLogFile" />
<property scope="local" name="ASYNC_APPENDER" value="info" />
<property scope="local" name="LOG_LEVEL" value="INFO" />
<include file="${LOGS_CUSTOM_DIR}/default.xml"/>
</included>
debug.xml：
<included>
<property scope="local" name="LOGFILE" value="debug" />
<property scope="local" name="FILE_APPENDER" value="DebugLogFile" />
<property scope="local" name="ASYNC_APPENDER" value="debug" />
<property scope="local" name="LOG_LEVEL" value="DEBUG" />
<include file="${LOGS_CUSTOM_DIR}/default.xml"/>
</included>
最后在logback.xml中就可以include上面定義的文件
<include file="${LOGS_CUSTOM_DIR}/warn.xml"/>
<include file="${LOGS_CUSTOM_DIR}/info.xml"/>
<include file="${LOGS_CUSTOM_DIR}/debug.xml"/>
<root level="DEBUG">
...
<appender-ref ref="warn"/>
<appender-ref ref="info"/>
<appender-ref ref="debug"/>
</root>
logback.xml導(dǎo)入(include)其他項(xiàng)目配置的logback.xml文件
1、其他項(xiàng)目存在的logback.xml文件需要下面這種形式的配置
下面的這個(gè)配置文件的意思是定義了兩個(gè)appender,這兩個(gè)appender中名為ASYNC-LOG的appender是將com.xx.cloud.trail.client.async路徑下面產(chǎn)生的級(jí)別為error的日志進(jìn)行收集，保存在定義的文件夾下面,另一個(gè)appender同理,如果這個(gè)logback.xml文件想在其他的項(xiàng)目中被引用那么就需要用在iucluded標(biāo)簽將定義的appender跟logger包圍起來(lái),表示這個(gè)是可以被導(dǎo)入其他項(xiàng)目的
<?xml version="1.0" encoding="UTF-8"?>
<included>
<appender name="ASYNC_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件輸出的文件名-->
<FileNamePattern>/var/log/xx/cloud/trail/async/error.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder
class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<!-- 日志輸出編碼 -->
<layout class="ch.qos.logback.classic.PatternLayout">
<!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級(jí)別從左顯示5個(gè)字符寬度%msg：日志消息，%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
</pattern>
</layout>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<appender name="AOP_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件輸出的文件名-->
<FileNamePattern>/var/log/xx/cloud/trail/aop/error.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder
class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<!-- 日志輸出編碼 -->
<layout class="ch.qos.logback.classic.PatternLayout">
<!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級(jí)別從左顯示5個(gè)字符寬度%msg：日志消息，%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
</pattern>
</layout>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!--需要將日志單獨(dú)輸出的包路徑-->
<logger name="com.xx.cloud.trail.client.async" level="ERROR" additivity="false">
<appender-ref ref="ASYNC_LOG"/>
</logger>
<!--需要將日志單獨(dú)輸出的包路徑-->
<logger name="com.xx.cloud.trail.client.aop" level="ERROR" additivity="false">
<appender-ref ref="AOP_LOG"/>
</logger>
</included>
2、其他項(xiàng)目的配置
假如1中的配置logback.xml文件的名稱為logback-trail.xml,那么需要在其他的項(xiàng)目的logback.xml文件中加入一句
表示導(dǎo)入其他項(xiàng)目的logback文件,這樣就能將其他項(xiàng)目中的配置文件進(jìn)行導(dǎo)入
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan: 當(dāng)此屬性設(shè)置為true時(shí)，配置文件如果發(fā)生改變，將會(huì)被重新加載，默認(rèn)值為true。
scanPeriod: 設(shè)置監(jiān)測(cè)配置文件是否有修改的時(shí)間間隔，如果沒(méi)有給出時(shí)間單位，默認(rèn)單位是毫秒。當(dāng)scan為true時(shí)，此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。
debug: 當(dāng)此屬性設(shè)置為true時(shí)，將打印出logback內(nèi)部日志信息，實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<include resource="logback-trail.xml"/>
<!--配置日志輸出到的路徑-->
<springProperty scop="context" name="logging.path" source="logging.path"
defaultValue="logging-path-not-find"/>
<property name="log.path" value="${logging.path}"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
</encoder>
</appender>
<appender name="TRAIL_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件輸出的文件名-->
<FileNamePattern>${logging.path}/trail/trail.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder
class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
<!-- 日志輸出編碼 -->
<layout class="ch.qos.logback.classic.PatternLayout">
<!--格式化輸出：%d表示日期，%thread表示線程名，%-5level：級(jí)別從左顯示5個(gè)字符寬度%msg：日志消息，%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
</pattern>
</layout>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 日志輸出級(jí)別 -->
<root level="DEBUG">
<appender-ref ref="STDOUT"/>
<appender-ref ref="TRAIL_LOG"/>
</root>
</configuration>
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要給大家介紹了關(guān)于java中類和對(duì)象的相關(guān)資料，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-08-08
解決@JsonInclude(JsonInclude.Include.NON_NULL)不起作用問(wèn)題
這篇文章主要介紹了解決@JsonInclude(JsonInclude.Include.NON_NULL)不起作用問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-06-06
深入理解SpringMVC的參數(shù)綁定與數(shù)據(jù)響應(yīng)機(jī)制
本文將深入探討SpringMVC的參數(shù)綁定方式，包括基本類型、對(duì)象、集合等類型的綁定方式，以及如何處理參數(shù)校驗(yàn)和異常。同時(shí)，本文還將介紹SpringMVC的數(shù)據(jù)響應(yīng)機(jī)制，包括如何返回JSON、XML等格式的數(shù)據(jù)，以及如何處理文件上傳和下載。2023-06-06
這篇文章主要介紹了Java設(shè)計(jì)模式之備忘錄模式的使用,備忘錄模式中的發(fā)起者和管需要的朋友可以參考下2016-02-02
springcloud如何用Redlock實(shí)現(xiàn)分布式鎖
本文主要介紹了springcloud如何用Redlock實(shí)現(xiàn)分布式鎖，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-11-11
classloader類加載器_基于java類的加載方式詳解
下面小編就為大家?guī)?lái)一篇classloader類加載器_基于java類的加載方式詳解。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-10-10
Java線程安全的常用類_動(dòng)力節(jié)點(diǎn)Java學(xué)院整理
在集合框架中，有些類是線程安全的，這些都是jdk1.1中的出現(xiàn)的。在jdk1.2之后，就出現(xiàn)許許多多非線程安全的類。 下面是這些線程安全的同步的類2017-06-06
解決get請(qǐng)求入?yún)NotNull驗(yàn)證不生效問(wèn)題
這篇文章主要介紹了解決get請(qǐng)求入?yún)NotNull驗(yàn)證不生效問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-09-09
springboot整合rocketmq實(shí)現(xiàn)分布式事務(wù)
大多數(shù)情況下很多公司是使用消息隊(duì)列的方式實(shí)現(xiàn)分布式事務(wù)。 本篇文章重點(diǎn)講解springboot環(huán)境下整合rocketmq實(shí)現(xiàn)分布式事務(wù)，感興趣的可以了解一下2021-05-05
springboot如何實(shí)現(xiàn)導(dǎo)入其他配置類
這篇文章主要介紹了springboot如何實(shí)現(xiàn)導(dǎo)入其他配置類問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-11-11