1.Encoder

1.encoder功能

Encoder 负责两件事，一是把事件转换为字节数组，二是把字节数组写入输出流。

注意：在logback 0.9.19 版之前没有 encoder。

在之前的版本里，多数 appender 依靠 layout 来把事件转换成字符串并用 java.io.Writer 把字符串输出。在之前的版本里，用户需要在 FileAppender里嵌入一个 PatternLayout。 而从 0.9.19 版开始，FileAppender 和其子类使用 encoder，不接受 layout。

encoder相比layout的优点：

2.Encoder接口详解

Encoder负责把事件转换为字节数组，并把字节数组写到合适的输出流。因此，encoder可以控制在什么时候、把什么样的字节数组写入到其拥有者维护的输出流中。Encoder接口有两个实现类，LayoutWrappingEncoder与PatternLayoutEncoder。

Encoder接口代码如下：

1package ch.qos.logback.core.encoder;
2import java.io.IOException;
3import java.io.OutputStream;
4import ch.qos.logback.core.spi.ContextAware;
5import ch.qos.logback.core.spi.LifeCycle;
6public interface Encoder<E> extends ContextAware, LifeCycle {
7/**
8* This method is called when the owning appender starts or 
9* whenever output needs to be directed to a new OutputStream, 
10* for instance as a result of a rollover.
11*/
12void init(OutputStream os) throws IOException;
13/**
14* Encode and write an event to the appropriate {@link OutputStream}.
15* Implementations are free to differ writing out of the encoded
16* event andinstead write in batches.
17*/
18void doEncode(E event) throws IOException;
19/**
20* This method is called prior to the closing of the underling
21* {@link OutputStream}. Implementations MUST not close the underlying
22* {@link OutputStream} which is the responsibility of the
23* owning appender.
24*/
25void close() throws IOException;
26}

1.LayoutWrappingEncoder类详解

下面通过LayoutWrappingEncoder类的部分源码，阐述如何把工作委托给Layout：

1package ch.qos.logback.core.encoder;import java.io.IOException;
2import java.nio.charset.Charset;
3import ch.qos.logback.core.Layout;
4public class LayoutWrappingEncoder<E> extends EncoderBase<E> {
5　　protected Layout<E> layout;
6　　private Charset charset;
7　　public void doEncode(E event) throws IOException {
8　　　　String txt = layout.doLayout(event);
9　　　　outputStream.write(convertToBytes(txt));
10　　　　outputStream.flush();
11　　}
12　　private byte[] convertToBytes(String s) {
13　　　　if (charset == null) {
14　　　　　　return s.getBytes();
15　　　　} else {
16　　　　　　return s.getBytes(charset);
17　　　　} 　　}}

doEncode()方法首先让被包裹的 layout 把传入的事件转换成字符串，再根据用户选择的字符集编码把字符串转换成字节，然后把自己写入其拥有者 appender 指定的输出流，输出 流被立即冲出（flush）。

2.PatternLayoutEncoder类详解

由于PatternLayout是最常用的Layout，因此logback提供了PatternLayoutEncoder，它扩展了LayoutWrappingEncoder，且仅使用PatternLayout。

注意：从logback0.9.19版起，FileAppender或其子类（比如，RollingFileAppender）在只要用到PatternLayout时，都必须换成PatternLayoutEncoder。

java日志框架系列（6）：logback框架encoder详解