logback 自定義Pattern模板教程
更新時(shí)間：2021年07月26日 12:00:30 作者：追風(fēng)少年z
這篇文章主要介紹了logback 自定義Pattern模板教程，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
配色板
"%black", "%red", "%green","%yellow","%blue", "%magenta","%cyan", "%white", "%gray","%boldRed","%boldGreen", "%boldYellow", "%boldBlue", "%boldMagenta","%boldCyan", "%boldWhite","%highlight"
例：%red(XX),則 XX 這兩個(gè)字為紅色
其它 %p 表示level,%t表示線程名
自定義Pattern模板
創(chuàng)建自定義格式轉(zhuǎn)換符有兩步：
1.寫一個(gè)轉(zhuǎn)換器類，繼承ClassicConvert
示例代碼：
public class IpConvert extends ClassicConverter {
@Override
public String convert(ILoggingEvent event) {
String ip = "10.10.10.10";
return ip;
}
}
2.在logback.xml中注冊(cè)該轉(zhuǎn)換器，并自定義轉(zhuǎn)換符
注冊(cè)：
<conversionRule conversionWord="ip" converterClass="com.hjx.log4j.IpConvert" />
自定義ip轉(zhuǎn)換符：
<Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%ip [%thread] %-5level %logger{36} -% msg%n</Pattern>
經(jīng)過這兩步驟后，即可將自定義的ip轉(zhuǎn)換符添加到輸出模板當(dāng)中了。
測(cè)試結(jié)果：
2015-05-01 15:25:16.887 10.10.10.10 [main] INFO c.s.f.log.normal.TestAppender
這里的10.10.10.10便是轉(zhuǎn)換后的值了。
上面的步驟只是基本的自定義模板方法，不好的地方就是要在配置文件里注冊(cè)，實(shí)際上只要模仿logback原生創(chuàng)建的方法把這個(gè)轉(zhuǎn)換符加進(jìn)去就可以了。可以看下PatternLayout.java源碼：
public class PatternLayout extends PatternLayoutBase<ILoggingEvent> {
public static final Map<String, String> defaultConverterMap = new HashMap<String, String>();
static {
defaultConverterMap.putAll(Parser.DEFAULT_COMPOSITE_CONVERTER_MAP);
defaultConverterMap.put("d",DateConverter.class.getName());
defaultConverterMap.put("date",DateConverter.class.getName());
defaultConverterMap.put("r",RelativeTimeConverter.class.getName());
defaultConverterMap.put("relative",RelativeTimeConverter.class.getName());
...
現(xiàn)在只需在這個(gè)static方法快里加上一句：
defaultConverterMap.put("ip",IpConvert.class.getName());
即可?！眎p”是轉(zhuǎn)換的字符，IpConvert是上面定義的轉(zhuǎn)換器類。但如何添加進(jìn)去呢？下面便是一種實(shí)現(xiàn)方案：
首先，定義一個(gè)類，該類繼承PatternLayout.java：
import ch.qos.logback.classic.PatternLayout;
public class MyPatternLayout extends PatternLayout {
static {
defaultConverterMap.put("ip",IpConvert.class.getName());
}
}
直接調(diào)用父類的屬性，將自定義的轉(zhuǎn)換符添加進(jìn)去。IpConvert便是上面已實(shí)現(xiàn)的轉(zhuǎn)換器。
之后，便是在logback.xml中配置我們自定義的PatternLayout：
<!-- 日志輸出格式 -->
<layout class="com.hjx.log4j.MyPatternLayout">
<Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %ip [%thread] %-5level %logger{36} -%msg%n</Pattern>
</layout>
原先的layout的class類為”ch.qos.logback.classic.PatternLayout”，這里換成我們自定義的即可。
通過上述兩種方案，便可實(shí)現(xiàn)自定義模板的功能。這種功能使用的一種場(chǎng)景便是在集群的環(huán)境下進(jìn)行日志的分析，通常分析異常日志的時(shí)候，并不能準(zhǔn)確定位到底是哪臺(tái)主機(jī)上的哪個(gè)server出了錯(cuò)，如果添加了ip地址信息到日志中去，那么日志分析工作講會(huì)變得更加準(zhǔn)確高效。
如果有類似于監(jiān)控平臺(tái)這樣的系統(tǒng)，那么便可將所有的異常日志統(tǒng)一進(jìn)行分析，只需在輸出中定義一些類似于主機(jī)ip、系統(tǒng)應(yīng)用id之類的區(qū)別的變量，這樣處理的好處自然不言而喻。
以下是我實(shí)際用到logback的配置
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- 配置IP地址 -->
<conversionRule conversionWord="ip" converterClass="com.xyk.util.log4j.IpConvert" />
<!-- Console 輸出格式 -->
<property name="CONSOLE_LOG_PATTERN"
value="%date{yyyy-MM-dd HH:mm:ss} %boldGreen(%ip) | %highlight(%-5level) | %boldYellow(%thread) | %boldGreen(%logger) | %msg%n"/>
<!-- 文件輸出格式 -->
<property name="FILE_LOG_PATTERN"
value="===%d{yyyy-MM-dd HH:mm:ss.SSS} %ip %-5level %logger Line:%-3L - %msg%n"/>
<!-- Console 輸出設(shè)置 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>
${CONSOLE_LOG_PATTERN}
</pattern>
<charset>UTF-8</charset>
</encoder>
<!--此日志appender是為開發(fā)使用，只配置最底級(jí)別，控制臺(tái)輸出的日志級(jí)別是大于或等于此級(jí)別的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
</appender>
<!--
說明：
1、日志級(jí)別及文件
日志記錄采用分級(jí)記錄，級(jí)別與日志文件名相對(duì)應(yīng)，不同級(jí)別的日志信息記錄到不同的日志文件中
例如：error級(jí)別記錄到log_error_xxx.log或log_error.log（該文件為當(dāng)前記錄的日志文件），而log_error_xxx.log為歸檔日志，
日志文件按日期記錄，同一天內(nèi)，若日志文件大小等于或大于2M，則按0、1、2...順序分別命名
例如log-level-2013-12-21.0.log
其它級(jí)別的日志也是如此。
2、文件路徑
若開發(fā)、測(cè)試用，在Eclipse中運(yùn)行項(xiàng)目，則到Eclipse的安裝路徑查找logs文件夾，以相對(duì)路徑../logs。
若部署到Tomcat下，則在Tomcat下的logs文件中
3、Appender
FILEERROR對(duì)應(yīng)error級(jí)別，文件名以log-error-xxx.log形式命名
FILEWARN對(duì)應(yīng)warn級(jí)別，文件名以log-warn-xxx.log形式命名
FILEINFO對(duì)應(yīng)info級(jí)別，文件名以log-info-xxx.log形式命名
FILEDEBUG對(duì)應(yīng)debug級(jí)別，文件名以log-debug-xxx.log形式命名
stdout將日志信息輸出到控制上，為方便開發(fā)測(cè)試使用
-->
<contextName>SpringBootDemo</contextName>
<property name="LOG_PATH" value="log/" />
<!--設(shè)置系統(tǒng)日志目錄-->
<property name="APPDIR" value="pay-server" />
<!-- 日志記錄器，日期滾動(dòng)記錄 -->
<appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文件的路徑及文件名 -->
<file>${LOG_PATH}/${APPDIR}/log_error.log</file>
<!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 歸檔的日志文件的路徑，例如今天是2013-12-21日志，當(dāng)前寫的日志文件路徑為file節(jié)點(diǎn)指定，可以將此文件與file指定文件路徑設(shè)置為不同路徑，從而將當(dāng)前日志文件或歸檔日志文件置不同的目錄。
而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
<fileNamePattern>${LOG_PATH}/${APPDIR}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 除按日志記錄之外，還配置了日志文件不能超過2M，若超過2M，日志文件會(huì)以索引0開始，
命名日志文件，例如log-error-2013-12-21.0.log -->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>2MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 追加方式記錄日志 -->
<append>true</append>
<!-- 日志文件的格式 -->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${FILE_LOG_PATTERN}</pattern>
<charset>utf-8</charset>
</encoder>
<!-- 此日志文件只記錄error級(jí)別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>error</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 日志記錄器，日期滾動(dòng)記錄 -->
<appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文件的路徑及文件名 -->
<file>${LOG_PATH}/${APPDIR}/log_warn.log</file>
<!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 歸檔的日志文件的路徑，例如今天是2013-12-21日志，當(dāng)前寫的日志文件路徑為file節(jié)點(diǎn)指定，可以將此文件與file指定文件路徑設(shè)置為不同路徑，從而將當(dāng)前日志文件或歸檔日志文件置不同的目錄。
而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
<fileNamePattern>${LOG_PATH}/${APPDIR}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 除按日志記錄之外，還配置了日志文件不能超過2M，若超過2M，日志文件會(huì)以索引0開始，
命名日志文件，例如log-error-2013-12-21.0.log -->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>2MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 追加方式記錄日志 -->
<append>true</append>
<!-- 日志文件的格式 -->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${FILE_LOG_PATTERN}</pattern>
<charset>utf-8</charset>
</encoder>
<!-- 此日志文件只記錄warn級(jí)別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!-- 日志記錄器，日期滾動(dòng)記錄 -->
<appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在記錄的日志文件的路徑及文件名 -->
<file>${LOG_PATH}/${APPDIR}/log_info.log</file>
<!-- 日志記錄器的滾動(dòng)策略，按日期，按大小記錄 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 歸檔的日志文件的路徑，例如今天是2013-12-21日志，當(dāng)前寫的日志文件路徑為file節(jié)點(diǎn)指定，可以將此文件與file指定文件路徑設(shè)置為不同路徑，從而將當(dāng)前日志文件或歸檔日志文件置不同的目錄。
而2013-12-21的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
<fileNamePattern>${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<!-- 除按日志記錄之外，還配置了日志文件不能超過2M，若超過2M，日志文件會(huì)以索引0開始，
命名日志文件，例如log-error-2013-12-21.0.log -->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>2MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!-- 追加方式記錄日志 -->
<append>true</append>
<!-- 日志文件的格式 -->
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${FILE_LOG_PATTERN}</pattern>
<charset>utf-8</charset>
</encoder>
<!-- 此日志文件只記錄info級(jí)別的 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>info</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<logger name="org.springframework" level="WARN" />
<logger name="org.hibernate" level="WARN" />
<!-- 生產(chǎn)環(huán)境下，將此級(jí)別配置為適合的級(jí)別，以免日志文件太多或影響程序性能 -->
<!--這里改level 生產(chǎn)環(huán)境改成ERROR 開發(fā)環(huán)境為INFO-->
<root level="INFO">
<appender-ref ref="FILEERROR" />
<appender-ref ref="FILEWARN" />
<appender-ref ref="FILEINFO" />
<!-- 生產(chǎn)環(huán)境將請(qǐng)stdout,testfile去掉 -->
<appender-ref ref="STDOUT" />
</root>
</configuration>
輸出的日志為：
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
您可能感興趣的文章:
- Java Pattern和Matcher字符匹配方式
- Java中Pattern.compile函數(shù)的使用詳解
- springboot Interceptor攔截器excludePathPatterns忽略失效
- redis通過lua腳本,獲取滿足key pattern的所有值方式
- Java如何利用狀態(tài)模式(state pattern)替代if else
- Swift 中如何使用 Option Pattern 改善可選項(xiàng)的 API 設(shè)計(jì)
- java正則表達(dá)式之Pattern與Matcher類詳解
- Java之Pattern.compile函數(shù)用法詳解
相關(guān)文章
idea安裝jerbel及文件上傳下載的實(shí)現(xiàn)示例
JRebel是一個(gè)Java開發(fā)工具,它是一款用于實(shí)時(shí)代碼重載的插件,本文主要介紹了idea安裝jerbel及文件上傳下載的實(shí)現(xiàn)示例,具有一定的參考價(jià)值,感興趣的可以了解下2023-09-09
Java遞歸實(shí)現(xiàn)斐波那契數(shù)列
這篇文章主要為大家詳細(xì)介紹了Java遞歸實(shí)現(xiàn)斐波那契數(shù)列，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-02-02
java基礎(chǔ)-給出一個(gè)隨機(jī)字符串，判斷有多少字母？多少數(shù)字？
這篇文章主要介紹了java基礎(chǔ)-給出一個(gè)隨機(jī)字符串，判斷有多少字母？多少數(shù)字？文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-04-04
這篇文章主要介紹了Netty中序列化的作用及自定義協(xié)議詳解,Netty自身就支持很多種協(xié)議比如Http、Websocket等等,但如果用來作為自己的RPC框架通常會(huì)自定義協(xié)議,所以這也是本文的重點(diǎn),需要的朋友可以參考下2023-12-12
java項(xiàng)目實(shí)現(xiàn)猜拳小游戲
這篇文章主要為大家詳細(xì)介紹了java項(xiàng)目實(shí)現(xiàn)猜拳小游戲，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2020-05-05
這篇文章主要介紹了Java LCN框架分布式事務(wù)，分布式事務(wù)是指事務(wù)的參與者、支持事務(wù)的服務(wù)器、資源服務(wù)器以及事務(wù)管理器分別位于不同的分布式系統(tǒng)的不同節(jié)點(diǎn)之上2022-07-07
Spring是于2003 年興起的一個(gè)輕量級(jí)的Java 開發(fā)框架，由Rod Johnson創(chuàng)建。簡(jiǎn)單來說，Spring是一個(gè)分層的JavaSE/EE full-stack(一站式) 輕量級(jí)開源框架2021-08-08
本文主要介紹了Java后端登錄實(shí)現(xiàn)返回token，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-07-07
這篇文章主要給大家介紹了關(guān)于Java元注解meta-annotation和依賴注入的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
Springboot項(xiàng)目中定時(shí)任務(wù)的四種實(shí)現(xiàn)方式詳解
Spring的@Scheduled注解是一種非常簡(jiǎn)單和便捷的實(shí)現(xiàn)定時(shí)任務(wù)的方式,通過在方法上添加@Scheduled注解,我們可以指定方法在特定的時(shí)間間隔或固定的時(shí)間點(diǎn)執(zhí)行,本文給大家介紹Springboot項(xiàng)目中定時(shí)任務(wù)的四種實(shí)現(xiàn)方式,感興趣的的朋友一起看看b2024-02-02