以下內(nèi)容翻譯整理自logback官方手冊，地址：logback官方手冊

Appender 是什么承绸？

Logback將編寫日志事件的任務委托給稱為appenders的組件。Appenders必須實現(xiàn)ch.qos.logback.core.Appender接口。該接口的主要方法總結如下：

package ch.qos.logback.core;
  
import ch.qos.logback.core.spi.ContextAware;
import ch.qos.logback.core.spi.FilterAttachable;
import ch.qos.logback.core.spi.LifeCycle;

public interface Appender<E> extends LifeCycle, ContextAware, FilterAttachable {

  public String getName();
  public void setName(String name);
  void doAppend(E event);
  
}

Appender接口中的大多數(shù)方法都是setter和getter绞绒。只有doAppend()方法是例外的拦耐，它將一個類型為E的對象作為參數(shù)耕腾。E的實際類型將根據(jù)logback模塊的不同而有所不同。在logback-classic模塊中杀糯，E的類型是ILoggingEvent扫俺，在logback-access模塊中，E的類型是AccessEvent固翰。doAppend()方法是logback框架中最重要的方法狼纬。它負責將日志事件以適當?shù)母袷捷敵龅竭m當?shù)妮敵鲈O備。

Appenders是可以被命名的骂际。這確保了可以通過名稱引用它們疗琉，這是腳本配置中很重要的一個特性。Appender接口擴展了FilterAttachable接口歉铝，可以將一個或多個過濾器附加到一個appender實例盈简。過濾器將在下一章詳細討論。

Appenders負責最終輸出日志事件犯戏。但是送火，它們可以將日志事件的格式化委托給一個Layout或一個Encoder對象拳话。每個Layout/Encoder都與一個且僅與一個appender關聯(lián)先匪。有些appenders具有內(nèi)置或固定的事件格式，因此弃衍，它們既不需要也沒有Layout/Encoder呀非。例如，SocketAppender只會在通過網(wǎng)絡傳輸日志事件之前對它們進行序列化镜盯。

AppenderBase

ch.qos.logback.core.AppenderBase類是實現(xiàn)了Appender接口的一個抽象類岸裙。它提供了所有appenders共享的基礎功能，例如獲取或設置它們的名稱速缆、激活狀態(tài)降允、布局和過濾器的方法。它是logback自帶的所有appenders的超類艺糜。雖然是一個抽象類剧董，AppenderBase實際上實現(xiàn)了Appender接口中的doAppend()方法。下面是實現(xiàn)代碼：

public synchronized void doAppend(E eventObject) {

  // prevent re-entry.
  if (guard) {
    return;
  }

  try {
    guard = true;

    if (!this.started) {
      if (statusRepeatCount++ < ALLOWED_REPEATS) {
        addStatus(new WarnStatus(
            "Attempted to append to non started appender [" + name + "].",this));
      }
      return;
    }

    if (getFilterChainDecision(eventObject) == FilterReply.DENY) {
      return;
    }
    
    // ok, we now invoke the derived class's implementation of append
    this.append(eventObject);

  } finally {
    guard = false;
  }
}

這里實現(xiàn)的doAppend()是一個同步方法破停。因此翅楼，從不同的線程記錄到相同的appender是線程安全的。當線程(例如T)執(zhí)行doAppend()方法時真慢，其他線程隨后的調(diào)用將排隊毅臊，直到T離開doAppend()方法，從而確保T對appender的獨占訪問黑界。

由于這種同步并不總是合適的管嬉，所以logback又提供了一個ch.qos.logback.core.UnsynchronizedAppenderBase皂林，和AppenderBase類非常類似。為了簡潔起見宠蚂，我們在本文檔的其余部分只討論UnsynchronizedAppenderBase式撼。

doAppend()方法做的第一件事是檢查守衛(wèi)是否被設置為true。如果是求厕，則立即退出著隆。如果不是，則在下一個語句中將其設置為true呀癣。該保護確保doAppend()方法不會遞歸地調(diào)用自己美浦。假設一個在append()方法之外調(diào)用的組件想要記錄一些東西。它的調(diào)用可以直接指向剛才調(diào)用它的相同的追加器项栏，從而導致無限循環(huán)和堆棧溢出浦辨。

在接下來的語句中，我們檢查started字段是否為true沼沈。如果不是流酬，doAppend()將發(fā)送一個警告消息并返回。換句話說列另，一旦一個appender被關閉了芽腾，就不可能再對它進行寫入。Appender接口繼承了LifeCycle接口页衙，這意味著它的實現(xiàn)類也實現(xiàn)了start()摊滔、stop()和isStarted()方法。設置完appender的所有屬性后店乐，Joran是logback的配置框架艰躺，它會調(diào)用start()方法來通知appender激活其屬性。根據(jù)其類型的不同眨八，如果某些屬性丟失或由于各種屬性之間的干擾腺兴，appender可能啟動失敗。例如廉侧，考慮到文件創(chuàng)建依賴于截斷模式页响，在Append選項的值被確定之前，FileAppender不能對它的File選項的值執(zhí)行操作伏穆。顯式激活步驟確保appender在其屬性的值被知道后對其進行操作拘泞。

如果appender無法啟動或已經(jīng)停止，將通過logback的內(nèi)部狀態(tài)管理系統(tǒng)發(fā)出警告消息枕扫。經(jīng)過多次嘗試陪腌，為了避免同一警告消息的副本充斥內(nèi)部狀態(tài)系統(tǒng)，doAppend()方法將停止發(fā)出這些警告。

下一個if語句檢查附加過濾器的結果诗鸭。根據(jù)過濾器鏈產(chǎn)生的決策染簇，可以拒絕或顯式接受事件。在過濾器鏈沒有做出決定的情況下强岸，默認情況下接受事件锻弓。

然后doAppend()方法調(diào)用派生類的append()方法實現(xiàn)。此方法的實際工作是將執(zhí)行將事件附加到適當設備蝌箍。

最后青灼，釋放保護，以便允許隨后的請求調(diào)用doAppend()方法妓盲。

Logback-core

logback -core是構建其他logback模塊的基礎杂拨。提供了幾個定制的的appender。在接下來的幾節(jié)中悯衬，我們將介紹這幾個的appenders弹沽。

OutputStreamAppender

OutputStreamAppender追加事件到一個java.io.OutputStream。該類提供了其他appender構建的基礎筋粗。用戶通常不會直接實例化OutputStreamAppender對象策橘，因為一般來說java.io.OutputStream類型不能方便地映射到字符串属划，因為無法在配置腳本中指定目標OutputStream對象轧叽。簡單地說距帅，您不能從配置文件配置OutputStreamAppender萌腿。然而，這并不意味著OutputStreamAppender缺乏可配置屬性进统，下面將描述這些屬性。

OutputStreamAppender是其他三個追加器的超類办悟，也就是ConsoleAppender、FileAppender滩褥、RollingFileAppender的超類病蛉。下圖展示了OutputStreamAppender及其子類的類圖。

ConsoleAppender

ConsoleAppender，顧名思義铺然，附加在控制臺俗孝，或者更準確地說是System.out或者System.err。前者是默認目標魄健。ConsoleAppender在用戶指定的編碼器的幫助下格式化事件赋铝。編碼器將在下一章中討論。這兩個System.out和System.err的類型是java.io.PrintStream沽瘦，因此革骨，它們是被封裝在OutputStreamWriter中的緩沖 I/O 操作。

下面是一個使用ConsoleAppender的示例配置姐叁。

<configuration>

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <!-- encoders are assigned the type
         ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>
    </encoder>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

FileAppender

FileAppender是OutputStreamAppender的一個子類瓦盛，追加日志事件到一個文件中，目標文件由File選項指定外潜。如果文件已經(jīng)存在原环，根據(jù)append屬性的值，要么被追加处窥，要么被截斷嘱吗。

默認情況下，每個日志事件都會立即刷新到底層輸出流。從某種意義上說菌羽，如果應用程序在沒有正確關閉appenders的情況下退出灶泵，日志事件不會丟失觅彰，這種默認方法更安全。但是卒蘸，為了顯著提高日志吞吐量，您可能需要將immediateFlush屬性設置為false翻默。下面是FileAppender配置文件的一個例子：

<configuration>

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>testFile.log</file>
    <append>true</append>
    <!-- 將immediateFlush設置為false缸沃，以獲得更高的日志吞吐量 -->
    <immediateFlush>true</immediateFlush>
    <!-- encoders are assigned the type
         ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>
        
  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

唯一命名的文件(按時間戳)

在應用程序開發(fā)階段或短期應用程序的情況下，例如修械，批量應用程序趾牧，最好在每次啟動新的應用程序時創(chuàng)建一個新的日志文件。在<timestamp>元素的幫助下肯污，這非常容易做到翘单。下面是一個例子：

<configuration>

  <!-- 插入一個格式為"yyyyMMdd'T'HHmmss"的時間戳"bySecond"到日志記錄器上下文。這個值將是可用于所有后續(xù)配置元素 -->
  <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <!-- use the previously created timestamp to create a uniquely
         named log file -->
    <file>log-${bySecond}.txt</file>
    <encoder>
      <pattern>%logger{35} - %msg%n</pattern>
    </encoder>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

timestamp元素接受兩個強制屬性key和datePattern蹦渣，以及一個可選的timeReference屬性县恕。key屬性的值是時間戳名稱，后續(xù)配置元素可以通過引用該名稱將時間戳作為變量剂桥。datePattern屬性表示用于將當前時間轉換為字符串的日期格式忠烛。日期模式應該遵循SimpleDateFormat中定義的約定。timeReference屬性表示時間戳的時間引用权逗。默認值是當前時間美尸。然而，在某些情況下斟薇，可能需要使用上下文出生時間作為時間引用师坎。這可以通過將timeReference屬性設置為“contextBirth”來實現(xiàn)。如下所示：

<configuration>
  <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss" 
             timeReference="contextBirth"/>
  ...
</configuration>

RollingFileAppender

RollingFileAppender擴展了FileAppender堪滨，使其能夠滾動日志文件胯陋。例如，RollingFileAppender可以將日志記錄到一個名為log.txt的文件中袱箱，一旦滿足某個條件遏乔，就將其日志記錄目標更改為另一個文件。

RollingFileAppender有兩個重要的子組件发笔。第一個是RollingPolicy盟萨，負責滾動所需的操作。第二個子是TriggeringPolicy了讨，負責什么時候進行觸發(fā)滾動捻激。

要想發(fā)揮任何作用制轰，RollingFileAppender必須同時設置RollingPolicy和TriggeringPolicy。但是胞谭，如果它的RollingPolicy也實現(xiàn)TriggeringPolicy接口垃杖，那么只需要顯式地指定前者。下面是RollingFileAppender的可用屬性：

滾動策略概述

RollingPolicy負責包含文件移動和重命名的翻轉過程叨襟。RollingPolicy接口如下所示：

package ch.qos.logback.core.rolling;  

import ch.qos.logback.core.FileAppender;
import ch.qos.logback.core.spi.LifeCycle;

public interface RollingPolicy extends LifeCycle {

  public void rollover() throws RolloverFailure;
  public String getActiveFileName();
  public CompressionMode getCompressionMode();
  public void setParent(FileAppender appender);
}

rollover方法完成了歸檔當前日志文件所涉及的工作繁扎。調(diào)用getActiveFileName()方法來計算當前日志文件的文件名(寫入活動日志的地方)。如getCompressionMode方法所示糊闽，滾動策略還負責確定壓縮模式梳玫。最后，通過setParent方法向滾動策略提供對其父策略的引用右犹。

TimeBasedRollingPolicy

TimeBasedRollingPolicy可能是最流行的滾動策略提澎。它定義了一個基于時間的滾動策略，例如按天或按月念链∨渭桑基于時間的滾轉策略同時承擔滾轉和觸發(fā)滾轉的責任。實際上掂墓，TimeBasedTriggeringPolicy同時實現(xiàn)了RollingPolicy和TriggeringPolicy接口谦纱。TimeBasedRollingPolicy的配置采用一個強制性的fileNamePattern屬性和幾個可選屬性。

下面是一些fileNamePattern值，并解釋了它們的效果吹截。

任何向前或向后斜杠字符都被解釋為文件夾(目錄)分隔符。任何需要的文件夾都將根據(jù)需要創(chuàng)建摆碉。因此塘匣，您可以輕松地將日志文件放在單獨的文件夾中。

TimeBasedRollingPolicy支持自動文件壓縮巷帝。如果fileNamePattern選項的值以.gz或.zip結尾忌卤，則啟用此功能。

fileNamePattern有雙重用途。首先憔狞，通過研究模式蝴悉，logback計算請求的翻轉周期。其次躯喇，它計算每個存檔文件的名稱辫封。注意，兩種不同的模式可以指定相同的周期性。模式yyyy-MM和yyyy@MM都指定了每月的滾動，盡管生成的歸檔文件將使用不同的名稱少欺。

通過設置file屬性，您可以解耦活動日志文件的位置和存檔日志文件的位置欣福。日志輸出將定向到file屬性指定的文件中。因此焦履，活動日志文件的名稱不會隨時間而更改拓劝。但是，如果您選擇忽略file屬性嘉裤，然后根據(jù)fileNamePattern的值為每個周期重新計算活動文件郑临。通過不設置file選項，您可以避免文件重命名錯誤屑宠，這些錯誤發(fā)生在存在外部文件句柄在滾轉期間引用日志文件時厢洞。

由于各種技術原因，滾動不是時鐘驅動的，而是取決于日志事件的到來躺翻。例如丧叽，在2002年3月8日，假設fileNamePattern設置為yyyy-MM-dd(每日翻轉)公你，午夜后第一個事件的到來將觸發(fā)翻轉踊淳。如果在午夜之后的23分47秒內(nèi)沒有日志記錄事件，那么翻轉實際上將發(fā)生在3月9日凌晨00:23'47陕靠，而不是凌晨0:00迂尝。因此，根據(jù)事件的到達率懦傍，可能會觸發(fā)一些延遲的滾動雹舀。但是芦劣，不管延遲如何粗俱，翻轉算法是正確的，因為在某個時間段內(nèi)生成的所有日志事件都將輸出到分隔該時間段的正確文件中虚吟。

下面是RollingFileAppender與TimeBasedRollingPolicy的示例配置寸认。

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logFile.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <!-- 每日翻轉 -->
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>

      <!-- 將30天的歷史記錄限制在3GB的總大小 -->
      <maxHistory>30</maxHistory>
      <totalSizeCap>3GB</totalSizeCap>

    </rollingPolicy>

    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender> 

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

下一個配置示例演示了在謹慎模式下使用與TimeBasedRollingPolicy關聯(lián)的RollingFileAppender。

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 支持多個JVM寫入同一個日志文件 -->
    <prudent>true</prudent>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
      <maxHistory>30</maxHistory> 
      <totalSizeCap>3GB</totalSizeCap>
    </rollingPolicy>

    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender> 

  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

SizeAndTimeBasedRollingPolicy

有時串慰，您可能希望按日期歸檔文件偏塞，但同時限制每個日志文件的大小，特別是如果之后使用的處理工具對日志文件有大小限制時邦鲫。為了滿足這一需求灸叼，logback提供了SizeAndTimeBasedRollingPolicy。

注意庆捺，TimeBasedRollingPolicy已經(jīng)允許限制歸檔日志文件的總體大小古今。如果只希望限制日志歸檔文件的總體大小，那么上面描述的TimeBasedRollingPolicy設置totalSizeCap屬性應該就夠用了滔以。

下面是一個示例配置文件捉腥，演示了基于時間和單個文件大小的日志文件歸檔。

<configuration>
  <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>mylog.txt</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <!-- 每日翻轉 -->
      <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
       <!-- 每個文件最多100MB你画，保存60天的歷史記錄抵碟，但總大小最多20GB -->
       <maxFileSize>100MB</maxFileSize>    
       <maxHistory>60</maxHistory>
       <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
      <pattern>%msg%n</pattern>
    </encoder>
  </appender>


  <root level="DEBUG">
    <appender-ref ref="ROLLING" />
  </root>

</configuration>

注意%d之外的%i轉換符號。%i和%d轉換符都是必需的坏匪，每次當前日志文件在當前時間段結束之前達到maxFileSize時拟逮，將使用一個遞增索引(從0開始)對其進行歸檔。

基于大小和時間的存檔支持刪除舊的存檔文件适滓。您需要使用maxHistory屬性指定要保存的周期數(shù)敦迄。當應用程序停止并重新啟動時，日志將繼續(xù)記錄在正確的位置，即當前期間的最大索引號颅崩。

在1.1.7之前的版本中几于，這個文檔提到了一個名為SizeAndTimeBasedFNATP的組件。但是沿后，考慮到SizeAndTimeBasedFNATP配置結構比較簡單沿彭，我們不再記錄SizeAndTimeBasedFNATP。不過尖滚，使用SizeAndTimeBasedFNATP的早期配置文件將繼續(xù)正常工作喉刘。實際上，SizeAndTimeBasedRollingPolicy是用SizeAndTimeBasedFNATP子組件實現(xiàn)的漆弄。

FixedWindowRollingPolicy

當滾動時睦裳，FixedWindowRollingPolicy根據(jù)下面描述的固定窗口算法重命名文件。fileNamePattern選項表示歸檔(滾動)日志文件的文件名模式撼唾。此選項是必需的廉邑，并且必須在模式中包含整數(shù)令牌%i。下面是FixedWindowRollingPolicy的可用屬性倒谷。

由于固定窗口滾動策略需要的文件重命名操作與窗口大小一樣多呢撞，因此強烈建議不要使用較大的窗口大小损姜。當用戶指定較大的值時，當前實現(xiàn)將自動將窗口大小減小到20殊霞。

讓我們來看一個關于固定窗口翻轉策略的更具體的例子摧阅。假設minIndex設置為1，maxIndex設置為3绷蹲，fileNamePattern屬性設置為foo%i.log棒卷。file屬性被設置為foo.log顾孽。

下面的配置文件給出了一個配置RollingFileAppender和FixedWindowRollingPolicy的示例。注意倦春，File選項是強制性的户敬，即使它包含與fileNamePattern選項所傳遞的一些相同的信息。

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>test.log</file>

    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
      <fileNamePattern>tests.%i.log.zip</fileNamePattern>
      <minIndex>1</minIndex>
      <maxIndex>3</maxIndex>
    </rollingPolicy>

    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>5MB</maxFileSize>
    </triggeringPolicy>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>
        
  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

觸發(fā)策略概述

TriggeringPolicy實現(xiàn)負責指示RollingFileAppender何時進行翻轉睁本。TriggeringPolicy接口只包含一個方法尿庐。

package ch.qos.logback.core.rolling;

import java.io.File;
import ch.qos.logback.core.spi.LifeCycle;

public interface TriggeringPolicy<E> extends LifeCycle {

  public boolean isTriggeringEvent(final File activeFile, final <E> event);
}

方法isTriggeringEvent()將活動文件和當前正在處理的日志事件作為參數(shù)。具體實現(xiàn)根據(jù)這些參數(shù)確定是否應該發(fā)生翻轉呢堰。

最廣泛使用的觸發(fā)策略是TimeBasedRollingPolicy抄瑟，它也是滾動策略的兩倍，前面已經(jīng)與其他滾動策略一起討論過枉疼。

SizeBasedTriggeringPolicy

SizeBasedTriggeringPolicy查看當前活動文件的大小皮假。如果它的大小超過指定的大小，它將向擁有的RollingFileAppender發(fā)出信號骂维，觸發(fā)現(xiàn)有活動文件的翻轉惹资。

SizeBasedTriggeringPolicy只接受一個參數(shù)maxFileSize，默認值為10MB航闺。

maxFileSize選項可以用字節(jié)褪测、千字節(jié)猴誊、兆字節(jié)或千兆字節(jié)來指定，方法是分別用KB侮措、MB和GB作為數(shù)字值的后綴懈叹。例如，5000000分扎、5000KB项阴、5MB和2GB都是有效值，前三個值是等價的笆包。

下面是一個帶有RollingFileAppender的示例配置环揽，它與SizeBasedTriggeringPolicy一起在日志文件達到5MB時觸發(fā)翻轉。

<configuration>
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>test.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
      <fileNamePattern>test.%i.log.zip</fileNamePattern>
      <minIndex>1</minIndex>
      <maxIndex>3</maxIndex>
    </rollingPolicy>

    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>5MB</maxFileSize>
    </triggeringPolicy>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
    </encoder>
  </appender>
        
  <root level="DEBUG">
    <appender-ref ref="FILE" />
  </root>
</configuration>

Logback Classic

雖然日志事件在logback-core中是通用的庵佣，但在logback-classic中歉胶，它們始終是ILoggingEvent的實例。Logback-classic不過是一個專門處理ILoggingEvent實例的管道巴粪。

SocketAppender 和 SSLSocketAppender

到目前為止通今，所涉及的appenders只能記錄日志到本地資源。相反肛根，SocketAppender的設計目的是通過網(wǎng)絡傳輸序列化的ILoggingEvent實例來記錄日志到遠程實體辫塌。當使用SocketAppender時，線路上的日志事件將以明文形式發(fā)送派哲。然而臼氨，當使用SSLSocketAppender時，日志事件是通過安全通道傳遞的芭届。

序列化事件的實際類型是LoggingEventVO储矩，它實現(xiàn)了ILoggingEvent接口。然而褂乍，就日志事件而言持隧，遠程日志記錄是非侵入性的。在反序列化后的接收端逃片，可以像在本地生成一樣記錄事件屡拨。運行在不同機器上的多個SocketAppender實例可以將它們的日志輸出定向到格式固定的中央日志服務器。SocketAppender不接受關聯(lián)的layout褥实，因為它將序列化的事件發(fā)送到遠程服務器呀狼。SocketAppender運行在傳輸控制協(xié)議(TCP)層之上，TCP層提供了一個可靠的性锭、有序的赠潦、流控制的端到端八位字節(jié)流。因此草冈，如果遠程服務器是可訪問的她奥，那么日志事件最終將到達那里瓮增。如果遠程服務器關閉或無法訪問，日志事件將被刪除哩俭。當服務器恢復時绷跑，事件傳輸將透明地恢復。這種透明的重連接由一個連接器線程執(zhí)行凡资，該線程定期嘗試連接到服務器砸捏。

日志事件由本機TCP實現(xiàn)自動緩沖。這意味著隙赁，如果到服務器的鏈接很慢垦藏，但是仍然比客戶機生成事件的速度快，客戶機將不會受到慢速網(wǎng)絡連接的影響伞访。但是掂骏，如果網(wǎng)絡連接比事件生成的速度慢，那么客戶機只能以網(wǎng)絡速度前進厚掷。特別是在連接到服務器的網(wǎng)絡連接關閉的極端情況下弟灼，客戶機最終將被阻塞∶昂冢或者田绑，如果網(wǎng)絡鏈接已打開，但服務器已關閉抡爹，則不會阻塞客戶機掩驱，盡管日志事件將由于服務器不可用而丟失。

即使SocketAppender不再附加到任何日志程序豁延，它也不會在連接器線程存在時被垃圾回收昙篙。連接器線程僅在與服務器的連接關閉時才存在。為了避免這種垃圾收集問題诱咏，您應該顯式地關閉SocketAppender。長生命周期應用程序會創(chuàng)建/銷毀許多SocketAppender實例缴挖，應該注意這個垃圾收集問題袋狞。大多數(shù)其他應用程序可以安全地忽略它。如果托管SocketAppender的JVM在SocketAppender關閉之前（顯式關閉或垃圾收集之后關閉）退出映屋，那么管道中可能會丟失未傳輸?shù)臄?shù)據(jù)链蕊。這是基于Windows系統(tǒng)的常見問題放典。為了避免丟失數(shù)據(jù)，通常可以顯式地關閉SocketAppender()沪饺，或者在退出應用程序之前調(diào)用LoggerContext的stop()方法。

遠程服務器由remoteHost和port屬性標識江醇。下表列出了SocketAppender屬性。SSLSocketAppender支持許多額外的配置屬性默责，這些屬性將在“使用SSL”一節(jié)中詳細介紹。

日志服務器選項

標準的Logback-Classic為服務器提供了兩個選項，用于接收來自SocketAppender或SSLSocketAppender的日志事件琼牧。

• ServerSocketReceiver及其支持SSL-enabled程序的SSLServerSocketReceiver是接收器組件恢筝，可以在應用程序的logback.xml配置文件中配置這些組件哀卫，以便從遠程套接字追加器接收事件。有關配置細節(jié)和使用示例滋恬，請參見接收器Receivers的介紹聊训。
• SimpleSocketServer及其支持SSL-enabled程序的SimpleSSLSocketServer都提供了易于使用的獨立Java應用程序，該應用程序的設計目的是配置并從shell的命令行接口運行恢氯。這些應用程序只是等待來自SocketAppender或SSLSocketAppender客戶機的日志事件带斑。每個接收到的事件都根據(jù)本地服務器策略進行日志記錄。下面給出了使用示例勋拟。

使用 SimpleSocketServer

SimpleSocketServer應用程序接受兩個命令行參數(shù)：port和configFile勋磕；其中port是要監(jiān)聽的端口，configFile是XML格式的配置腳本敢靡。

假設您在logback-examples/目錄中挂滓，使用以下命令啟動SimpleSocketServer：

java ch.qos.logback.classic.net.SimpleSocketServer 6000 \
  src/main/java/chapters/appenders/socket/server1.xml

這里6000是要監(jiān)聽的端口號，server1.xml是一個配置腳本啸胧，它向根日志記錄器添加了一個ConsoleAppender和一個RollingFileAppender赶站。啟動SimpleSocketServer之后，您可以使用SocketAppender從多個客戶機向它發(fā)送日志事件纺念。與本手冊相關的例子包括兩個這樣的客戶端：chapters.appenders.SocketClient1和chapters.appenders.SocketClient2兩個客戶機都在等待用戶在控制臺上輸入一行文本贝椿。文本被封裝在一個debug級別的日志事件中，然后發(fā)送到遠程服務器陷谱。這兩個客戶機在SocketAppender的配置上有所不同烙博。SocketClient1以編程方式配置追加器，而SocketClient2需要配置文件烟逊。

假設SimpleSocketServer在本地主機上運行渣窜，您可以使用以下命令連接到它：

java chapters.appenders.socket.SocketClient1 localhost 6000

您鍵入的每一行都應該出現(xiàn)在上一步中啟動的SimpleSocketServer的控制臺。如果停止并重啟SimpleSocketServer宪躯，客戶機將透明地重新連接到新服務器實例乔宿，盡管斷開連接時生成的事件將簡單地(并且不可挽回地)丟失。

與SocketClient1不同访雪，示例應用程序SocketClient2本身并不配置logback予颤。它需要XML格式的配置文件。如下所示的配置文件client1.xml創(chuàng)建了一個SocketAppender并將其附加到根日志記錄器冬阳。

<configuration>
          
  <appender name="SOCKET" class="ch.qos.logback.classic.net.SocketAppender">
    <remoteHost>${host}</remoteHost>
    <port>${port}</port>
    <reconnectionDelay>10000</reconnectionDelay>
    <includeCallerData>${includeCallerData}</includeCallerData>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="SOCKET" />
  </root>  

</configuration>

注意，在上面的配置腳本中党饮，remoteHost肝陪、port和includeCallerData 屬性的值不是直接給出的，而是作為替代變量鍵給出的刑顺。變量的值可以指定為系統(tǒng)屬性：

java -Dhost=localhost -Dport=6000 -DincludeCallerData=false \
  chapters.appenders.socket.SocketClient2 src/main/java/chapters/appenders/socket/client1.xml

該命令的結果應該與前面的SocketClient1示例類似氯窍。

請允許我們重復一遍饲常，以強調(diào)日志事件的序列化不具有侵入性。反序列化事件與任何其他日志事件攜帶相同的信息狼讨。它可以像在本地生成一樣進行操作贝淤；除了默認情況下序列化日志事件不包含調(diào)用方數(shù)據(jù)之外。這里有一個例子來說明這一點政供。首先播聪，使用以下命令啟動SimpleSocketServer：

 java ch.qos.logback.classic.net.SimpleSocketServer 6000 \
  src/main/java/chapters/appenders/socket/server2.xml

配置文件server2.xml創(chuàng)建一個ConsoleAppender，其布局輸出調(diào)用者的文件名和行號以及其他信息布隔。如果像以前一樣使用配置文件client1.xml運行SocketClient2离陶，你會注意到服務器端的輸出將包含兩個問號之間的括號，而不是文件名和行號的調(diào)用者：

2006-11-06 17:37:30,968 DEBUG [Thread-0] [?:?] chapters.appenders.socket.SocketClient2 - Hi

通過將includeCallerData選項設置為true衅檀，指示SocketAppender包含調(diào)用方數(shù)據(jù)招刨，可以很容易地更改結果。使用下面的命令就可以了：

java -Dhost=localhost -Dport=6000 -DincludeCallerData=true \
  chapters.appenders.socket.SocketClient2 src/main/java/chapters/appenders/socket/client1.xml

由于反序列化事件可以與本地生成的事件以相同的方式處理哀军，甚至可以將它們發(fā)送到另一臺服務器進行進一步處理沉眶。作為練習，您可能希望設置兩個服務器杉适，其中第一個服務器將其接收到的事件從客戶機傳輸?shù)降诙€服務器谎倔。

使用 SimpleSSLSocketServer

SimpleSSLSocketServer和SimpleSocketServer一樣，也需要port和configFile命令行參數(shù)淘衙。此外传藏，必須使用命令行中指定的系統(tǒng)屬性為日志服務器的X.509憑證提供位置和密碼。

假設您在logback-examples/目錄中彤守，使用以下命令啟動SimpleSSLSocketServer：

java -Djavax.net.ssl.keyStore=src/main/java/chapters/appenders/socket/ssl/keystore.jks \
    -Djavax.net.ssl.keyStorePassword=changeit \
    ch.qos.logback.classic.net.SimpleSSLSocketServer 6000 \
    src/main/java/chapters/appenders/socket/ssl/server.xml

本例使用只適合于測試和實驗的X.509憑據(jù)運行SimpleSSLSocketServer毯侦。在生產(chǎn)設置中使用SimpleSSLSocketServer之前，您應該獲得一個適當?shù)?code>X.509憑據(jù)來標識您的日志服務器具垫。有關詳細信息侈离，請參見"使用SSL"。

因為服務器配置在根元素上指定debug="true"筝蚕，您將在服務器的啟動日志中看到將要使用的SSL配置卦碾。這對于驗證本地安全策略實現(xiàn)是否正確非常有用。

運行SimpleSSLSocketServer后起宽，可以使用SSLSocketAppender連接到服務器洲胖。下面的示例顯示了所需的appender配置：

<configuration debug="true">
          
  <appender name="SOCKET" class="ch.qos.logback.classic.net.SSLSocketAppender">
    <remoteHost>${host}</remoteHost>
    <port>${port}</port>
    <reconnectionDelay>10000</reconnectionDelay>
    <ssl>
      <trustStore>
        <location>${truststore}</location>
        <password>${password}</password>
      </trustStore>
    </ssl>
  </appender>

  <root level="DEBUG">
    <appender-ref ref="SOCKET" />
  </root>  

</configuration>

注意，與前面的示例一樣坯沪，remoteHost绿映、port的值是使用替換的變量鍵指定的。此外，請注意ssl屬性及其嵌套的trustStore屬性的存在叉弦，該屬性指定存儲的位置和密碼丐一。這個配置是必要的，因為我們的示例服務器使用的是自簽名證書淹冰。有關SSLSocketAppender的SSL配置屬性的更多信息库车，請參見“使用SSL”。

通過在命令行上指定替換變量值作為系統(tǒng)屬性樱拴，我們可以使用這種配置運行客戶機應用程序：

java -Dhost=localhost -Dport=6000 \
    -Dtruststore=file:src/main/java/chapters/appenders/socket/ssl/truststore.jks \
    -Dpassword=changeit \
    chapters.appenders.socket.SocketClient2 src/main/java/chapters/appenders/socket/ssl/client.xml

與前面的示例一樣柠衍，您可以在客戶機應用程序提示時輸入一條消息，消息將被發(fā)送到日志服務器(現(xiàn)在通過一個安全通道)疹鳄，并顯示在控制臺拧略。

注意，命令行上給出的truststore屬性指定一個文件URL瘪弓，該URL標識可信任的存儲位置垫蛆。您還可以使用類路徑URL，如“使用SSL”中所述腺怯。

正如我們前面在服務器啟動時看到的袱饭，由于客戶機配置在根元素上指定了debug="true"，客戶機的啟動日志記錄包括SSL配置的詳細信息呛占，以幫助審查本地策略的一致性虑乖。

ServerSocketAppender 和 SSLServerSocketAppender

前面討論的SocketAppender組件(及其支持ssl的對應組件)旨在允許應用程序通過網(wǎng)絡連接到遠程日志服務器，以便向服務器交付日志事件晾虑。

在某些情況下疹味，讓應用程序啟動到遠程日志服務器的連接可能不方便或不可行。對于這些情況帜篇，Logback提供ServerSocketAppender糙捺。

不啟動到遠程日志服務器的連接，ServerSocketAppender被動地監(jiān)聽TCP套接字笙隙，等待來自遠程客戶機的傳入連接洪灯。提交到附加器的日志事件分布到每個連接的客戶機。當沒有客戶機連接時發(fā)生的日志事件將被立即丟棄竟痰。

除了基本的ServerSocketAppender之外签钩，Logback還提供了SSLServerSocketAppender，它使用一個安全加密的通道將日志事件分發(fā)給每個連接的客戶機坏快。此外铅檩，啟用ssl的appender完全支持基于證書的相互認證，可以使用這種認證確保只有經(jīng)過授權的客戶端才能連接到appender來接收日志事件莽鸿。

為在線路上傳輸而編碼日志事件的方法與SocketAppender使用的方法相同柠并；每個事件都是ILoggingEvent的序列化實例。只有連接啟動的方向是相反的。SocketAppender在建立到日志服務器的連接時充當主動對等點臼予，而ServerSocketAppender是被動的；它偵聽來自客戶機的傳入連接啃沪。

ServerSocketAppender子類型僅用于Logback接收器組件粘拾。有關此組件類型的附加信息，請參見接收器创千。ServerSocketAppender支持以下配置屬性：

下面的示例演示了一個使用ServerSocketAppender的配置：

<configuration debug="true">
  <appender name="SERVER" 
    class="ch.qos.logback.classic.net.server.ServerSocketAppender">
    <port>${port}</port>
    <includeCallerData>${includeCallerData}</includeCallerData>
  </appender>

  <root level="debug">
    <appender-ref ref="SERVER" />
  </root>  

</configuration>

注意亏镰，此配置與前面的示例不同扯旷，僅在為appender指定的類中使用ServerSocketAppender，并且在沒有remoteHost屬性的情況下——此appender被動地等待來自遠程主機的入站連接索抓，而不是打開到遠程日志服務器的連接钧忽。

下面的示例演示了使用SSLServerSocketAppender的配置。

<configuration debug="true">
  <appender name="SERVER" 
    class="ch.qos.logback.classic.net.server.SSLServerSocketAppender">
    <port>${port}</port>
    <includeCallerData>${includeCallerData}</includeCallerData>
    <ssl>
      <keyStore>
        <location>${keystore}</location>
        <password>${password}</password>
      </keyStore>
    </ssl>
  </appender>

  <root level="debug">
    <appender-ref ref="SERVER" />
  </root>  

</configuration>

此配置與前一個配置之間的主要區(qū)別在于逼肯，appender的class屬性標識了SSLServerSocketAppender類型耸黑，以及嵌套ssl元素的存在，在本例中汉矿，嵌套ssl元素指定了包含附加器X.509憑據(jù)的密鑰存儲庫的配置崎坊。有關SSL配置屬性的信息，請參閱“使用SSL”洲拇。

因為ServerSocketAppender子類型被設計用于與接收器組件一起使用奈揍，所以我們將接收器的章節(jié)提供使用示例。

SMTPAppender

SMTPAppender將日志事件累積到一個或多個固定大小的緩沖區(qū)中赋续，并在發(fā)生用戶指定的事件后通過電子郵件發(fā)送適當緩沖區(qū)的內(nèi)容男翰。SMTP電子郵件傳輸(發(fā)送)是異步執(zhí)行的。默認情況下纽乱，電子郵件傳輸由級別錯誤的日志事件觸發(fā)蛾绎。此外，默認情況下，所有事件都使用一個緩沖區(qū)租冠。

下表總結了SMTPAppender的各種性能鹏倘。

未完待續(xù)蜂奸。。硬萍。