Logback 实用手册：配置与使用详解

需积分: 10 6 浏览量更新于2024-07-19 收藏 3.69MB PDF 举报

“Logback文档，中文版文档版本0.1，发布于2010年4月23日，由Ceki Gülcü和Sébastien Pennec创作，陈华翻译，禁止用于商业用途。” **Logback** 是一个开源的日志框架，它在Java世界中作为Log4j的继任者出现，提供了更高效和灵活的日志记录解决方案。由Ceki Gülcü，也就是Log4j的创始人设计，Logback致力于提高日志处理的性能和提供强大的配置选项。 ### **1. 介绍** #### 1.1. 什么是logback Logback是一个全面的日志管理和分析工具，旨在提供高效、快速且可配置的日志记录功能。它包括三个主要组件：`logback-classic`（扩展了SLF4J接口，提供与Log4j相似的功能），`logback-core`（基础架构部分），以及`logback-access`（与Servlet容器集成，处理HTTP访问日志）。 #### 1.2. 第一步要开始使用logback，你需要确保你的项目中包含了logback的依赖，并配置相应的配置文件。通常，有两种配置文件：`logback-test.xml`（用于开发环境）和`logback.xml`（用于生产环境）。 #### 1.2.1. 必要条件要使用logback，你需要SLF4J的API，因为logback是作为SLF4J的实现来工作的。这意味着你的代码应使用SLF4J的接口，而具体的日志实现则通过logback提供。 ### **2. 体系结构** #### 2.2. Logger、Appender和Layout - **Logger上下文**：Logger上下文是管理所有Logger实例的容器。 - **有效级别（Level）及级别继承**：Logger具有级别，如DEBUG、INFO、WARN等，并遵循级别继承原则，子Logger可以覆盖父Logger的级别。 - **打印方法和基本选择规则**：Logger提供了如debug(), info(), warn()等方法，根据当前日志级别决定是否记录日志。 - **获取Logger**：通过SLF4J API的`LoggerFactory.getLogger()`获取Logger实例。 - **Appender和Layout**：Appender负责将日志事件输出到某个目的地，Layout则负责格式化日志信息。 - **参数化记录**：允许在日志消息中插入动态内容。 - **更好的替代方法**：相比直接使用`System.out.println()`或`System.err.println()`，使用logback更有效率，因为它避免了不必要的同步开销。 - **工作原理**：日志请求由Logger接收，然后传递给对应的Appender进行输出。 - **性能**：Logback设计时考虑了性能，它可以在不记录日志时避免不必要的计算。 ### **3. 配置** #### 3.1. Logback配置 Logback的配置文件使用XML格式，包含对Logger、Appender和Layout的定义。 #### 3.2. 自动配置 Logback会自动尝试加载`logback-test.xml`或`logback.xml`配置文件。 #### 3.3. 配置文件位置可以通过系统属性指定配置文件的位置。 #### 3.4. 自动打印警告和错误消息在配置过程中遇到的问题会被自动打印出来。 #### 3.5. 指定默认配置文件位置通过系统属性可以设定配置文件的默认路径。 #### 3.6. 配置文件重新加载当配置文件被修改时，logback可以自动重新加载新配置。 #### 3.7. 直接调用JoranConfigurator 可以使用JoranConfigurator类来手动加载配置。 #### 3.8-3.10. 查看状态消息、监听状态消息和配置文件语法提供了查看状态消息的机制，可以监听配置过程中的事件，并详细解释配置文件的语法和规则。 ### **4. Appender** #### 4.1. 什么是Appender Appender是日志事件的目标，如控制台、文件、数据库、网络等。 #### 4.2. AppenderBase AppenderBase是所有Appender的基类，提供了一些基本功能。 #### 4.3. Logback-core Logback-core是所有logback组件的基础，包括AppenderBase。 #### 4.3.1. OutputStreamAppender OutputStreamAppender是将日志输出到流的Appender示例。以上只是Logback文档的部分内容概述，完整的文档会详细介绍每个组件的使用、配置选项以及高级特性，如过滤器、自定义布局、异步日志记录等。Logback的灵活性和强大功能使其成为企业级应用的首选日志框架。

禁止用于商业用途 Logback 手册中文版

10 / 180

下面是基本选择规则的例子。

// 取得名为"com.foo"的 logger 实例

Logger logger = LoggerFactory.getLogger("com.foo");

// 设其级别为 INFO

logger.setLevel(Level.INFO);

Logger barlogger = LoggerFactory.getLogger("com.foo.Bar");

// 该请求有效，因为 WARN >= INFO

logger.warn("Low fuel level.");

// 该请求无效，因为 DEBUG < INFO.

logger.debug("Starting search for nearest gas station.");

// 名为"com.foo.Bar"的 logger 实例 barlogger, 从"com.foo"继承级别

// 因此下面的请求有效，因为 INFO >= INFO.

barlogger.info("Located nearest gas station.");

// 该请求无效，因为 DEBUG < INFO.

barlogger.debug("Exiting gas station search");

译者注：上例的 logger.setLevel(Level.INFO)无效。org.slf4j.Logger 没有 setLevel()方法，

ch.qos.logback.classic.Logger 有此方法。

2.2.4. 获取 Logger

用同一名字调用 LoggerFactory.getLogger 方法所得到的永远都是同一个 logger 对象的引

用。

例如，

Logger x = LoggerFactory.getLogger("wombat");

Logger y = LoggerFactory.getLogger("wombat");

x 和 y 指向同一个 logger 对象。

因此，可以配置一个 logger，然后从其他地方取得同一个实例，不需要到处传递引用。

生物学里的父母总是先于其孩子，而 logback 不同，它可以以任何顺序创建和配置 logger。

特别的是，即使“父”logger 是在其后代初始化之后才初始化的，它仍将查找并链接到其后

禁止用于商业用途 Logback 手册中文版

11 / 180

代们。

通常是在程序初始化时对 logback 环境进行配置。推荐用读配置文件类进行配置。稍后

会讲这种方法。

Logback 简化了 logger 命名，方法是在每个类里初始化 logger，以类的全限定名作为

logger 名。这种定义 logger 的方法即有用又直观。由于记录输出里包含 logger 名，这种命名

方法很容易确定记录消息来源。Logback 不限制 logger 名，你可以随意命名 logger。

然而，目前已知最好的策略是以 logger 所在类的名字作为 logger 名称。

2.2.5. Appender 和 Layout

有选择性地启用或禁用记录请求仅仅是 logback 功能的冰山一角。Logback 允许打印记

录请求到多个目的地。在 logback 里，一个输出目的地称为一个 appender。目前有控制台、

文件、远程套接字服务器、MySQL、PostreSQL、Oracle 和其他数据库、JMS 和远程 UNIX Syslog

守护进程等多种 appender。

一个 logger 可以被关联多个 appender。

方法 addAppender 为指定的 logger 添加一个 appender。对于 logger 的每个启用了的记录

请求，都将被发送到 logger 里的全部 appender 及更高等级的 appender。换句话说，appender

叠加性地继承了 logger 的层次等级。例如，如果根 logger 有一个控制台 appender，那么所有

启用了的请求都至少会被打印到控制台。如果 logger L 有额外的文件 appender，那么，L 和

L 后代的所有启用了的请求都将同时打印到控制台和文件。设置 logger 的 additivity 为 false，

则可以取消这种默认的 appender 累积行为。

控制 appender 叠加性的规则总结如下。

Appender 叠加性

Logger L 的记录语句的输出会发送给 L 及其祖先的全部 appender。这就是“appender

叠加性”的含义。

然而，如果 logger L 的某个祖先 P 设置叠加性标识为 false，那么，L 的输出会发送给

禁止用于商业用途 Logback 手册中文版

14 / 180

2.2.8. 工作原理

介绍过 logback 的核心组件后，下面描述 logback 框架在用户调用 logger 的打印方法时

所做的事情。在本例中，用户调用名为 com.wombat 的 logger 的 info()方法。

1. 取得过滤链（filter chain）的判定结果

如果 TurboFilter 链存在，它将被调用。Turbo filters 能够设置一个上下文范围内的

临界值，这个临界值或者表示过滤某些与信息有关（比如 Marker、级别、Logger、

消息）的特定事件，或者表示与每个记录请求相关联的 Throwable。如果过滤链的

结果是 FilterReply.DENY，则记录请求被抛弃。如果结果是 FilterReply.NEUTRAL，

则继续下一步，也就是第二步。如果结果是 FilterReply.ACCEPT，则忽略过第二步，

进入第三步。

2. 应用基本选择规则

Logback 对 logger 的有效级别与请求的级别进行比较。如果比较的结果是记录请求

被禁用，logback 会直接抛弃请求，不做任何进一步处理。否则，继续下一步。

3. 创建 LoggingEvent 对象

记录请求到了这一步后，logback 会创建一个 ch.qos.logback.classic.LoggingEvent 对

象，该对象包含所有与请求相关的参数，比如请求用的 logger、请求级别、消息、

请求携带的异常、当前时间、当前线程、执行记录请求的类的各种数据，还有 MDC。

注意有些成员是延迟初始化的，只有当它们真正被使用时才会被初始化。MDC 用

来为记录请求添加额外的上下文信息。之后的章节会讨论 MDC。

4. 调用 appender

创建了 LoggingEvent 对象后，logback 将调用所有可用 appender 的 doAppend()方法，

这就是说，appender 继承 logger 的上下文。

所有 appender 都继承 AppenderBase 抽象类，AppenderBase 在一个同步块里实现了

doAppend 方以确保线程安全。Appender Base 的 doAppender()方法也调用 appender

关联的自定义过滤器，如果它们存在的话。自定义过滤器能被动态地关联到任何

appender，另有章节专门讲述它。

5. 格式化输出

那些被调用了的 appender 负责对记录事件（LoggingEvent）进行格式化。然而，有

些但不是全部 appender 把格式化记录事件的工作委托给 layout 。Layout 对

LoggingEvent 实例进行格式化，然后把结果以字符串的形式返回。注意有些

appender，比如 SocketAppender，把记录事件进行序列化而不是转换成字符串，所

以它们不需要也没有 layout。

6. 发送记录事件（LoggingEvent）

剩余185页未读，继续阅读

u013554470

粉丝: 0
资源: 35

Logback 实用手册：配置与使用详解

logback开发文档

logback中文手册

Logback中文文档.pdf

Logback中文文档

logback中文文档pdf

Logback中文文档-实用

logback官方文档+jar包

logback日志文档-入门到SpringBoot中使用

logback-chinese-manual:logback 中文手册文档

logback官方中文版文档

最新资源