logback 自定義Pattern模板教程

Posted on 2021-07-26 by WalkonNet

配色板

“%black”, “%red”, “%green”,”%yellow”,”%blue”, “%magenta”,”%cyan”, “%white”, “%gray”,”%boldRed”,”%boldGreen”, “%boldYellow”, “%boldBlue”, “%boldMagenta”,”%boldCyan”, “%boldWhite”,”%highlight”

例：%red(XX),則 XX 這兩個字為紅色

其它 %p 表示level,%t表示線程名

自定義Pattern模板

創建自定義格式轉換符有兩步：

1.寫一個轉換器類，繼承ClassicConvert

示例代碼：

public class IpConvert extends ClassicConverter {
    @Override
    public String convert(ILoggingEvent event) {
        String ip = "10.10.10.10";
        return ip;
    }
}

2.在logback.xml中註冊該轉換器，並自定義轉換符

註冊：

<conversionRule conversionWord="ip" converterClass="com.hjx.log4j.IpConvert" />

自定義ip轉換符：

<Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS}%ip [%thread] %-5level %logger{36} -% msg%n</Pattern>

經過這兩步驟後，即可將自定義的ip轉換符添加到輸出模板當中瞭。

測試結果：

2015-05-01 15:25:16.887 10.10.10.10 [main] INFO c.s.f.log.normal.TestAppender

這裡的10.10.10.10便是轉換後的值瞭。

上面的步驟隻是基本的自定義模板方法，不好的地方就是要在配置文件裡註冊，實際上隻要模仿logback原生創建的方法把這個轉換符加進去就可以瞭。可以看下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());  
     ...

現在隻需在這個static方法快裡加上一句：

defaultConverterMap.put("ip",IpConvert.class.getName());

即可。”ip”是轉換的字符，IpConvert是上面定義的轉換器類。但如何添加進去呢？下面便是一種實現方案：

首先，定義一個類，該類繼承PatternLayout.java：

import ch.qos.logback.classic.PatternLayout;  
public class MyPatternLayout extends PatternLayout {  
    static {  
        defaultConverterMap.put("ip",IpConvert.class.getName());  
    }  
}

直接調用父類的屬性，將自定義的轉換符添加進去。IpConvert便是上面已實現的轉換器。

之後，便是在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”，這裡換成我們自定義的即可。

通過上述兩種方案，便可實現自定義模板的功能。這種功能使用的一種場景便是在集群的環境下進行日志的分析，通常分析異常日志的時候，並不能準確定位到底是哪臺主機上的哪個server出瞭錯，如果添加瞭ip地址信息到日志中去，那麼日志分析工作講會變得更加準確高效。

如果有類似於監控平臺這樣的系統，那麼便可將所有的異常日志統一進行分析，隻需在輸出中定義一些類似於主機ip、系統應用id之類的區別的變量，這樣處理的好處自然不言而喻。

以下是我實際用到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 輸出設置 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>
                ${CONSOLE_LOG_PATTERN}
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--此日志appender是為開發使用，隻配置最底級別，控制臺輸出的日志級別是大於或等於此級別的日志信息-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>

    <!--
       說明：
       1、日志級別及文件
           日志記錄采用分級記錄，級別與日志文件名相對應，不同級別的日志信息記錄到不同的日志文件中
           例如：error級別記錄到log_error_xxx.log或log_error.log（該文件為當前記錄的日志文件），而log_error_xxx.log為歸檔日志，
           日志文件按日期記錄，同一天內，若日志文件大小等於或大於2M，則按0、1、2...順序分別命名
           例如log-level-2013-12-21.0.log
           其它級別的日志也是如此。
       2、文件路徑
           若開發、測試用，在Eclipse中運行項目，則到Eclipse的安裝路徑查找logs文件夾，以相對路徑../logs。
           若部署到Tomcat下，則在Tomcat下的logs文件中
       3、Appender
           FILEERROR對應error級別，文件名以log-error-xxx.log形式命名
           FILEWARN對應warn級別，文件名以log-warn-xxx.log形式命名
           FILEINFO對應info級別，文件名以log-info-xxx.log形式命名
           FILEDEBUG對應debug級別，文件名以log-debug-xxx.log形式命名
           stdout將日志信息輸出到控制上，為方便開發測試使用
    -->
    <contextName>SpringBootDemo</contextName>
    <property name="LOG_PATH" value="log/" />
    <!--設置系統日志目錄-->
    <property name="APPDIR" value="pay-server" />

    <!-- 日志記錄器，日期滾動記錄 -->
    <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${LOG_PATH}/${APPDIR}/log_error.log</file>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 歸檔的日志文件的路徑，例如今天是2013-12-21日志，當前寫的日志文件路徑為file節點指定，可以將此文件與file指定文件路徑設置為不同路徑，從而將當前日志文件或歸檔日志文件置不同的目錄。
            而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，日志文件會以索引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級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 日志記錄器，日期滾動記錄 -->
    <appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${LOG_PATH}/${APPDIR}/log_warn.log</file>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 歸檔的日志文件的路徑，例如今天是2013-12-21日志，當前寫的日志文件路徑為file節點指定，可以將此文件與file指定文件路徑設置為不同路徑，從而將當前日志文件或歸檔日志文件置不同的目錄。
            而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，日志文件會以索引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級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 日志記錄器，日期滾動記錄 -->
    <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日志文件的路徑及文件名 -->
        <file>${LOG_PATH}/${APPDIR}/log_info.log</file>
        <!-- 日志記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 歸檔的日志文件的路徑，例如今天是2013-12-21日志，當前寫的日志文件路徑為file節點指定，可以將此文件與file指定文件路徑設置為不同路徑，從而將當前日志文件或歸檔日志文件置不同的目錄。
            而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，日志文件會以索引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級別的 -->
        <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" />

    <!-- 生產環境下，將此級別配置為適合的級別，以免日志文件太多或影響程序性能 -->
    <!--這裡改level 生產環境改成ERROR 開發環境為INFO-->
    <root level="INFO">
        <appender-ref ref="FILEERROR" />
        <appender-ref ref="FILEWARN" />
        <appender-ref ref="FILEINFO" />

        <!-- 生產環境將請stdout,testfile去掉 -->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

輸出的日志為：

這裡寫圖片描述

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

logback 自定義Pattern模板教程

配色板

自定義Pattern模板

1.寫一個轉換器類，繼承ClassicConvert

2.在logback.xml中註冊該轉換器，並自定義轉換符

以下是我實際用到logback的配置

推薦閱讀：

發佈留言取消回覆

近期文章

配色板

自定義Pattern模板

1.寫一個轉換器類，繼承ClassicConvert

2.在logback.xml中註冊該轉換器，並自定義轉換符

以下是我實際用到logback的配置

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆