java日志框架系列（5）：logback框架appender详解

1.appender

1.什么是appender

Appender 是负责写记录事件的组件。 Appender 必须实现接口“ch.qos.logback.core.Appender”。该接口的重要方法总结如下： 

 

 

 

 2.AppenderBase

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 derived class' implementation of append
this.append(eventObject);
} catch (Exception e) {
if (exceptionCount++ < ALLOWED_REPEATS) {
addError("Appender [" + name + "] failed to append.", e);
}
} finally {
guard = false; } }

通过代码可以知道AppenderBase类是的doAppender（）是同步线程安全的；并不是所有时候都需要同步，因此当不需要同步的时候可以使用UnsynchronizedAppenderBase类。

3. logback-core

logback-core模块是logback的基础。下面讲解一下可以直接使用的appender。

1.logback-core模块中的appender

logback-core模块中的appender种类：OutputStreamAppender、ConsoleAppender、FileAppender、RollingFileAppender。

你有没有发现：logback-core中的appender的目的地都是本地啊，那有没有可以发送到网络上的appender呀，当然有，在logback-classic模块中，下一节介绍。

这些appender之间的关系如下所示：

 

1.OutputStreamAppender讲解

OutputStreamAppender 把事件添加到 java.io.OutputStream。该类提供其他 appender 所需的基本服务。用户通常不直接实例化 OutputStreamAppender 对象。

由于 java.io.OutputStream一般无法被方便地映射到字符串，所以无法在配置文件里指定目标 OutputStream 对象。简而言之，你不能在配置文件里配置 OutputStreamAppender。但这不是说 OutputStreamAppender没有配置属性。它的属性如下：

 2.ConsoleAppender讲解

ConsoleAppender 把事件添加到控制台，更准确地说是 System.out 或 System.err，默认为前者。ConsoleAppender 按照用户指定的 encoder 对事件进行格式化。

 这些属性是需要配置的，因此我们可以通过在xml配置文件中的<appender>标签中创建以属性名为标签名的标签，并为这些标签进行配置。

注意：<appender>中不同的class属性值表明使用不同的目的地，因此会有不同的参数，从而表现出在配置文件中的标签有所差异。

 3.FileAppender讲解

FileAppender 是 OutputStreamAppender 的子类，把记录事件添加到文件。目标文件通过File 选项指定。如果文件已经存在，则根据 Append 属性追加或清空文件。

 

这些属性是需要配置的，因此我们可以通过在xml配置文件中的<appender>标签中创建以属性名为标签名的标签，并为这些标签进行配置。

注意：<appender>中不同的class属性值表明使用不同的目的地，因此会有不同的参数，从而表现出在配置文件中的标签有所差异。

 4.RollingFIleAppender讲解

RollingFileAppender 继承 FileAppender，能够滚动记录文件。

滚动记录文件：RollingFileAppender能先记录到文件“log.txt”，然后当符合某个条件时，变成记录到其他文件。

1.实现滚动记录原理

RollingFileAppender有两个重要组件，RollingPolicy、TriggerPolicy。

RollingPolicy：负责滚动

TriggerPolicy：决定是否以及何时滚动。

RollingFileAppender要想实现滚动功能，必须同时设置具体的RollingPolicy类与具体的TriggerPolicy类。如果某个类A实现了RollingPolicy与TriggerPolicy，那么只需要设置类A就可以了。

rollingPolicy属性值的类型有：FixedWindowRollingPolicy类、TimeBasedRollingPolicy类（常用）。FixedWindowRollingPolicy，TimeBasedRollingPolicy 支持自动压缩文件。

这些属性是需要配置的，因此我们可以通过在xml配置文件中的<appender>标签中创建以属性名为标签名的标签，并为这些标签进行配置。

注意：<appender>中不同的class属性值表明使用不同的目的地，因此会有不同的参数，从而表现出在配置文件中的标签有所差异。

1.最受欢迎的滚动策略TimeBaseRollingPolicy

TimeBaseRollingPolicy：最流行的滚动策略。根据时间来制定滚动策略。由于TimeBaseRollingPolicy实现了RollingPolicy接口和TriggeringPolicy接口，因此TimeBaseRollingPolicy即负责滚动也负责触发条件。

 属性：fileNamePattern（必须有）和maxHistory（可选的）。

 

 下面讲解一下fileNamePattern的部分值及作用：

注意：所有“\”和“/”都被解释为目录分隔符。任何需要的目录都会被创建。所以你可以轻松地把记录文件放到不同的目录。 

 

4.logback-classic

 

 

  在logback-classic模块中也存在一些appender，并且这些appender的目的地不是本地。下面详细了解一下这些appender。

logback-classic模块中的appender分类：SocketAppender、DBAppender、SMTPAppender、SyslogAppender、SiftingAppender以及基于JMS的两种Appender（JMSTopicAppender和JMSQueueAppender，他们继承自JMSAppenderBase类）；提供了总共7种appender；另外还可以自定义appender，需要通过继承AppenderBase来实现自定义的appender。