2. 程式人生 > >logback-Appender 自定義詳解

logback-Appender 自定義詳解

阿新 • • 發佈：2018-12-30
實際上Appender可能是logback框架中最重要的元件之一，雖然Logger是記錄日誌的介面，但是如果一個Logger沒有關聯到任何Appender的話，那麼這個Logger就無法記錄任何資訊。此外雖然logback提供了很多擴充套件點，但是在應用中，我們可能很少會擴充套件filter，很少擴充套件layout和encoder，但是我們擴充套件Appender的機會卻是很多的 

老規矩，首先上圖，看一下Appender的大圖景，這裡要說明的是，實現Appender介面有2個base類，一個是AppenderBase，另一個是UnsynchronizedAppenderBase，這2個類非常接近，80%以上的程式碼都是相同的。如果我們自己要自定義Appender的話，只要寫一個類繼承自這2個base類就好 




首先是有一個Appender介面，然後如上文所說，UnsynchronizedAppenderBase類實現了這個介面，但是它本身是一個抽象類，需要繼承它才能得到真正的實現類。Appender介面繼承了FilterAttachable介面，而UnsynchronizedAppenderBase類持有一個FilterAttachableImpl類，委託這個類來實現FilterAttachable接口裡定義的方法 

然後OutputStreamAppender是繼承自UnsynchronizedAppenderBase的Appender實現類，雖然它已經不是抽象類了，但是實際也是不能直接使用的，它的實現類就是最常見的ConsoleAppender和FileAppender 


只要自己使用過logback的朋友都知道，appender元素下面還需要配置encoder元素，這裡的Encoder介面就是對應這個encoder元素的，因為其實Appender元件還不是最終實際記錄日誌資訊的元件，它要委託encoder元件來完成LoggingEvent的格式化和記錄 

介紹完了大體的結構，我們接下來就看看，從Appender介面的doAppend()方法，是怎麼一步步地最終記錄日誌的

首先是UnsynchronizedAppenderBase裡面的doAppend()方法，它主要是記錄了Status狀態，然後檢查Appender上的Filter是否滿足過濾條件，最後再呼叫實現子類的appender()方法。很眼熟是嗎，這裡用到了一個設計模式——模板方法 

Java程式碼  收藏程式碼
  1. public void doAppend(E eventObject) {  
  2.     // WARNING: The guard check MUST be the first statement in the  
  3.     // doAppend() method.  
  4.     // prevent re-entry.  
  5.     if (Boolean.TRUE.equals(guard.get())) {  
  6.       return;  
  7.     }  
  8.     try {  
  9.       guard.set(Boolean.TRUE);  
  10.       if (!this.started) {  
  11.         if (statusRepeatCount++ < ALLOWED_REPEATS) {  
  12.           addStatus(new WarnStatus(  
  13.               "Attempted to append to non started appender [" + name + "].",  
  14.               this));  
  15.         }  
  16.         return;  
  17.       }  
  18.       if (getFilterChainDecision(eventObject) == FilterReply.DENY) {  
  19.         return;  
  20.       }  
  21.       // ok, we now invoke derived class' implementation of append  
  22.       this.append(eventObject);  
  23.     } catch (Exception e) {  
  24.       if (exceptionCount++ < ALLOWED_REPEATS) {  
  25.         addError("Appender [" + name + "] failed to append.", e);  
  26.       }  
  27.     } finally {  
  28.       guard.set(Boolean.FALSE);  
  29.     }  
  30.   }  
  31.   abstract protected void append(E eventObject);  

上面的程式碼非常簡單，就不用說了，我們就直接看看實現類的append()方法是怎麼實現的，這裡我們選擇OutputStreamAppender實現類 
Java程式碼  收藏程式碼
  1. @Override  
  2.   protected void append(E eventObject) {  
  3.     if (!isStarted()) {  
  4.       return;  
  5.     }  
  6.     subAppend(eventObject);  
  7.   }  

首先檢查一下這個Appender是否已經啟動，如果沒啟動就直接返回，如果已經啟動，則又進入一個subAppend()方法 
Java程式碼  收藏程式碼
  1. /** 
  2.    * Actual writing occurs here. 
  3.    * <p> 
  4.    * Most subclasses of <code>WriterAppender</code> will need to override this 
  5.    * method. 
  6.    *  
  7.    * @since 0.9.0 
  8.    */  
  9.   protected void subAppend(E event) {  
  10.     if (!isStarted()) {  
  11.       return;  
  12.     }  
  13.     try {  
  14.       // this step avoids LBCLASSIC-139  
  15.       if (event instanceof DeferredProcessingAware) {  
  16.         ((DeferredProcessingAware) event).prepareForDeferredProcessing();  
  17.       }  
  18.       // the synchronization prevents the OutputStream from being closed while we  
  19.       // are writing. It also prevents multiple thread from entering the same  
  20.       // converter. Converters assume that they are in a synchronized block.  
  21.       synchronized (lock) {  
  22.         writeOut(event);  
  23.       }  
  24.     } catch (IOException ioe) {  
  25.       // as soon as an exception occurs, move to non-started state  
  26.       // and add a single ErrorStatus to the SM.  
  27.       this.started = false;  
  28.       addStatus(new ErrorStatus("IO failure in appender", this, ioe));  
  29.     }  
  30.   }  

這個方法居然什麼事也不幹。。做了一些檢查以後，又進入writeOut()方法。。。 
Java程式碼  收藏程式碼
  1. protected void writeOut(E event) throws IOException {  
  2.     this.encoder.doEncode(event);  
  3.   }  

writeOut()方法委託配置給它的Encoder元件來記錄 
Java程式碼  收藏程式碼
  1. public void doEncode(E event) throws IOException {  
  2.     String txt = layout.doLayout(event);  
  3.     outputStream.write(convertToBytes(txt));  
  4.     outputStream.flush();  
  5.   }  

到這裡，終於完了。Encoder元件又委託其Layout元件來將LoggingEvent進行格式化，返回一個String，然後通過OutputStream.write()方法，把格式化之後的日誌資訊寫到目的地 

耐心看到這裡的朋友，可能已經有點被繞暈了，怎麼Appender需要這麼麻煩嗎？其實我們這裡說的只是ConsoleAppender的doAppend()全流程，並不是所有Appender都這麼複雜的，當然也有一些更復雜的。。 

下面看一個簡單的Appender，就是我自己寫的MyAppender 
Java程式碼  收藏程式碼
  1. public class MyAppender extends AppenderBase<LoggingEvent> {  
  2.     @Override  
  3.     protected void append(LoggingEvent eventObject) {  
  4.         System.out.println(eventObject.getMessage());  
  5.     }  
  6. }  

好吧，非常簡單是不是，如果把這個Appender配置到logback.xml中，那麼當Logger.info()呼叫的時候，就會先走進AppenderBase類的doAppend()方法裡，進行Filter校驗等等，然後進入MyAppender的append()方法，不做其他的操作，直接把message給列印到Console上。當然，由於這個類是極度簡化的，沒有Encoder和Layout，也就沒辦法控制輸出日誌的時間，也沒有辦法對%thread等標記進行解析處理了。但是這個類可能可以很清晰地表達出，Appender元件是怎麼工作的：由AppenderBase類來呼叫Filter鏈，然後由Appender實現類來委託Encoder解析LoggingEvent，再輸出到目的地 

相關推薦

logback-Appender 自定義詳解

實際上Appender可能是logback框架中最重要的元件之一，雖然Logger是記錄日誌的介面，但是如果一個Logger沒有關聯到任何Appender的話，那麼這個Logger就無法記錄任何資訊。此外雖然logback提供了很多擴充套件點，但是在應用中，我們可能很少會擴

C++宏定義詳解

windows 依據 include 所有 out 轉換成 數組 ons area 一、#define的基本用法 #define是C語言中提供的宏定義命令，其主要目的是為程序員在編程時提供一定的方便，並能在一定程度上提高程序的運行效率，但學生在學習時往往不能 理解該

c語言宏定義詳解

size_t類型 32bit 0地址 typedef pca 值類型 日期 tof 什麽 1,防止一個頭文件被重復包含 #ifndef COMDEF_H #define COMDEF_H //頭文件內容 #endif 2,重新定義一些類型,防止由於各種平臺和編譯器的不同

可變大小結構體如何定義詳解

pan 動態分配 很多 假設 spa 浪費 使用數組 緩沖 發送 一、背景 　　工作中，在通信協議中常常看到TLV格式數據，不同的type id對應的字符串長度大小不一樣。那麽該怎麽去定義一個結構體去管理這些數據呢？怎麽去定義一種可變大小的結構體？本文將講解如何定義可變大小

logback日誌模板與詳解

alua ogg back pad 修飾 可選 最小寬度 {0} method <pattern>的轉換符說明： （這部分引用自http://aub.iteye.com/blog/1103685）轉換符 作用 c {length } lo {len

logback logback.xml常用配置詳解（一）<configuration> and <logger>

配置文件 cti 原創文章 分類 lis ali 配置 默認值 原創 摘自：http://aub.iteye.com/blog/1101260logback logback.xml常用配置詳解（一）<configuration> and <logger&

Python 類的基本定義詳解

【摘要】Python是一種面向物件的語言，稍微複雜一點的程式，都應該採用類來進行設計，以使程式結構更加清晰，易於把控。本文將討論單類的基本內容定義，以後的博文再討論其它。   一. 成員的訪問範圍： Python中的類，其實就是執行程式碼塊，這一點很重要，所有位於 class

django--orm表自關聯詳解

什麼是表內自關聯 表內自關聯是指表內資料相關聯的物件和表是相同欄位，這樣我們就直接用表內關聯將外來鍵關聯設定成自身表的欄位。同樣表內關聯也分一對多欄位和多對多欄位 例如：對於微博評論，每條評論都可能有子評論，但每條評的欄位內容應該都是相同的，並且每條評論都只有一個父評論，這就滿足了，一對多的情形。父評論為關

解析度 PPI DPI概念定義詳解

        我們在開發中，涉及到UI顯示時，經常會遇到的一些概念，比如解析度，ppi，dpi等，這些概念，在百度百科中，發現都有對它們的定義，一些部落格中，也有對這幾個概念的對比，但是看了下，發現解釋的也不是很清楚，理解起來還是不太容易，下面講解下我自己的

logback logback.xml常用配置詳解（一） and

部落格分類：  Log 詳細整理了logback常用配置， 不是官網手冊的翻譯版，而是使用總結，旨在更快更透徹的理解其配置 logback 中文手冊 （官網手冊的翻譯版，在這裡向中文版譯者-陳華，說聲辛苦啦） logback 配置詳解（

logback logback.xml常用配置詳解（二）

logback 常用配置詳解（二） <appender> <appender>： <appender>是<configuration>的子節點，是負責寫日誌的元件。 <appender>有兩個必要屬

[C++] C++中的巨集定義詳解 C++巨集定義詳解

轉載自：C++中的巨集定義 和 C++巨集定義詳解 一、#define解析     #define是C語言中提供的巨集定義命令，其主要目的是為程式設計師在程式設計時提供一定的方便，並能在一定程度上提高程式的執行效率，但學生在學習時往往不能 理解該

[C++] C++中的宏定義詳解

兩個 分配 學習 處理 編程 工作 計算 ++i 應用 轉載自：C++中的宏定義 和 C++宏定義詳解 一、#define解析 #define是C語言中提供的宏定義命令，其主要目的是為程序員在編程時提供一定的方便，並能在一定程度上提高程序的運行效率，但學生在學習時往

C語言中宣告和定義詳解

變數宣告和變數定義 變數定義：用於為變數分配儲存空間，還可為變數指定初始值。程式中，變數有且僅有一個定義。 變數宣告：用於向程式表明變數的型別和名字。 定義也是宣告，extern宣告不是定義 定義也是宣告：當定義變數時我們聲明瞭它的型別和

LVDS介面定義詳解

LVDS介面 　　1．LVDS介面概述 　　液晶顯示器驅動板輸出的數字訊號中，除了包括RGB資料訊號外，還包括行同步、場同步、畫素時鐘等訊號，其中畫素時鐘訊號的最高頻率可超過28MHz。採用TTL介面，資料傳輸速率不高，傳輸距離較短，且抗電磁干擾（EMI）能力也比較差，會對

聚合和繼承的定義詳解

聚合： 為什麼要用聚合： 我們會想要一次構建兩個或兩個以上的專案，而不是到兩個模組或是多個模組的目錄下分別執行mvn命令。Maven聚合（或者稱為多模組）這一特性就是為該需求服務的。 繼承： 為什麼要使用繼承： pom.xml裡面的配置，如果是多個專案，勢必會出現依賴和外掛

（轉）解析度 PPI DPI概念定義詳解

們在開發中，涉及到UI顯示時，經常會遇到的一些概念，比如解析度，ppi，dpi等，這些概念，在百度百科中，發現都有對它們的定義，一些部落格中，也有對這幾個概念的對比，但是看了下，發現解釋的也不是很清楚，理解起來還是不太容易，下面講解下我自己的理解，用盡可能簡單通俗的方式，讓大

android自定義手勢解鎖View

   有時候為了程式的安全性,我們經常要採取一些安全措施,就像我們常用的支付寶那樣,隔一定的時間再回到應用程式時會讓使用者利用手勢去解鎖應用程式,最近由於專案需求,也要求做這樣一個功能,當用戶切出本應用程式15分鐘後回來,讓使用者手勢解鎖,整個需求的難點就在如何實現這個手勢

CA證書自籤詳解-比較清晰的講解

本文記錄linux環境和windows環境下CA證書的辦法過程 一：linux環境下頒發CA證書 首先需要安裝openssl。 首先需要利用openssl生成根證書，以後的伺服器端證書或者客戶端證書都用他來簽發，可以建立多個根證書。 在CentOS6.

Android 自定義滑動解鎖View

package com.inks.jisaimedicalforch8.view; import android.animation.Animator; import android.animation.ValueAnimator; import android.conten