Logback

官方文档： http://logback.qos.ch/manual/index.html updated 22/1/13：加入用例，更了下文章 符合标题”快速入门”

一、简介

Java 开源日志框架，以继承改善 log4j 为目的而生，是 log4j 创始人 Ceki Gülcü 的开源产品。 它声称有极佳的性能，占用空间更小，且提供其他日志系统缺失但很有用的特性。 其一大特色是，在 logback-classic 中本地(native)实现了 SLF4J API（也表示依赖 slf4j-api）

二、架构 / Logback知识

1. 项目分为三个模块：

• logback-core：其他俩模块基础模块，作为通用模块 其中没有 logger 的概念
• logback-classic：日志模块，完整实现了 SLF4J API
• logback-access：配合Servlet容器，提供 http 访问日志功能

2. 在 logback 中主要概念（Logger、Appender、Layout、Encoder）

· Logger

日志记录器，logback-classic 的部分 每个 Logger 都附加到一个 LoggerContext 上，该 Context 负责构造 Logger 以及将其安排在层级结构中。

1. 命名及层级关系 Logger 名称区分大小写，并遵循层级命名规则。 层级关系用 ”.” 表示，如：“com.foo” 是 “com.foo.Bar” 的父Logger

   且所有 Logger 都可通过LoggerFactory#getlogger(String name)来获取，且相同名称返回的实例相同

2. 根 Logger 是所有层级结构的顶部Logger，可通过名称检索获取 Logger rootLogger = LoggerFactory.getLogger(org.slf4j.Logger.ROOT_LOGGER_NAME);

3. Level 与 继承关系 Logger 可以被分配级别（TRACE、DEBUG、INFO、WARN、ERROR），可在 ch.qos.logback.classic 中查看 若没有给 Logger 分配级别，则它将从最近的分配了等级的祖先处继承等级 例：

   Logger name	Assigned level	Effective level
   root	DEBUG	DEBUG
   X	INFO	INFO
   X.Y	none	INFO
   X.Y.Z	ERROR	ERROR

4. Level 与 log 规则（basic selection rule） Logger 只会启用等级 ≥ Logger等级的日志请求 等级排序（严重程度，而非优先级）：TRACE < DEBUG < INFO < WARN < ERROR 如：

   java复制

   Logger logger = LoggerFactory.getLogger("com.foo");
   logger.setLevel(Level. INFO);
   
   // 启用，因为 WARN >= INFO
   logger.warn("Low fuel level.");
   // 禁用, 因为 DEBUG < INFO. 
   logger.debug("Starting search for nearest gas station.");

· Appender

Logback 通过Appender#doAppend(E event)将日志事件打印到目的地（允许附加多个Appender即即多个目的地 目前官方已提供 console、文件、远程socket服务、JMS、远程UNIX Syslog进程、MySQL/PostgreSQL/Orcale等数据库的 appender 支持. 注意：

• 一个 Logger 可以通过Logger#addAppender方法可被附加多个 appender
• appender 同样适用于继承结构，且是以追加的方式而非覆盖； 但继承行为可被 Logger 的 additivity 标志影响是否继承（通过Logger#setAdditive设置)
• additivity 标志本身也是可继承的

继承示例如下：

· Layout

表示日志输出格式，其通过接口ch.qos.logback.core#doLayout(E event): String将日志事件格式化为String 返回。 Logback 官方提供 PatternLayout，允许以类似c语言printf来指定输出格式。 可通过将 layout 与 appender 关联，来实现自定义输出格式和目的地；但并不是每个 appender 都需要 layout，比如负责序列化的 SocketAppender 自然不需要 doLayout 转字符串

· Encoder

Encoder的概念在 Logback 0.9.19 中被引入，通过Encoder#encode可将 LoggingEvent 转为 byte[] 目前 Logback 仅提供了 PatternLayoutEncoder 这一个可用的实现，其逻辑很简单：内部构造/包装了 PatternLayout 实例，调用PatternLayout#doLayout得到格式化字串后，再调用String#getBytes返回 byte[]

引入原因：因为Layout#doLayout接口只能将 LoggingEvent 转为 String，这在某些情况下不太灵活，而现在 Encoder 能完全控制字节格式。 比如，在以前的版本中常在FileAppender中嵌套PatternLayout来使用，但现在仅需依赖Encoder

三、使用

1) 使用示例

1. 引入依赖（ logback-classic 背后会自动引入 logback-core、slf4j 等依赖包

<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.2.10</version>
</dependency>

1. 基于slf4j用法，获取并使用Logger

public class Sample {
    private static final Logger LOGGER = LoggerFactory.getLogger(Sample.class);
    public static void main(String[] args){
        LOGGER.info("A Message From LOGGER：{}", "Hello World");
    }
}

输出：

16:55:54.091 [main] INFO logbacktest.Sample - A Message From LOGBACK：Hello World

2) logback 配置

Logback 初始化时，根据以下顺序尝试配置：

1. 类路径下尝试寻找 logback-test.xml

2. 若没有，类路径下尝试寻找 logback.groovy

3. 若没有，类路径下尝试寻找 logback.xml

4. 若没有，尝试基于 Java SPI 机制寻找 com.qos.logback.classic.spi.Configurator 接口的实现

5. 若以上都没有，Logback 会使用最基本的 BasicConfigurator 配置自己。

   这将使用 TTLLLayout（类似 PatternLayout） 以”%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n”模式格式化日志，并将 ConsoleAppender 附加到 root Logger，这会输出到控制台，且 root 被指定为 DEBUG 等级。

   默认配置等效为以下xml配置：

   xml复制

   <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>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
   </encoder>
   </appender>
   
   <root level="debug">
   <appender-ref ref="STDOUT" />
   </root>
   </configuration>

可通过以下代码打印当前配置：StatusPrinter.print((LoggerContext) LoggerFactory.getILoggerFactory()) 输出：

15:25:46,635 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback-test.xml]
15:25:46,635 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback.groovy]
15:25:46,636 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback.xml]
15:25:46,647 |-INFO in ch.qos.logback.classic.BasicConfigurator@5f16132a - Setting up default configuration.

四、log 整体流程

1. 获取 filter 链决策
2. 应用 basic selection rule
3. 创建 LoggingEvent 对象
4. 调用 appenders
5. 调 Layout 格式化
6. 输出到目的地

五、配置详解

1.配置文件

一些写法/背景知识：

1. 可在值中以 ${KEY:-defaultValue} 的形式引入属性，查找顺序如下：

   • 首先在本地作用域查找（详见<property>）
   • 若没有，在上下文作用域查找
   • 若没有，在JVM系统属性查找
   • 最后，在系统环境变量中查找

   既支持名称(KEY)中的嵌套，也支持值/默认值的嵌套引用

2. 预定义属性：

   • HOSTNAME：系统hostname，是配置时在 context 域中被定义被定义
   • CONTEXT_NAME：上下文名

3. 一些标签涉及到类的标签（如<definer>、<appender>、<encoder>），其子标签除了规定之外，还可定义与 JavaBean 属性同名，这将调用相应setter注入。

顶级标签

<configuration> 属性：

• debug：获知 Logback 内部状态，官方推荐在<configuration>上设置

  复制

  debug

  属性，而非在代码中调用 StatusPrinter。例：

  复制

  <configuration debug="true">

  这也等同于设置状态监听器 OnConsoleStatusListener

  例：

  xml复制

  <configuration>
  	<statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener" />  
  	<!-- … -->
  </configuration>

• scan / scanPeriod：可定期扫描配置文件的更改，并在更改时自动应用。默认每分钟一次 例：<configuration scan="true" scanPeriod="30 seconds" >

• packagingData：可令每一行StackTrace输出其对应jar包。需注意，其计算成本高昂

  例：

  复制

  <configuration packagingData="true">

  输出示例：

  复制

  14:28:48.835 [btpool0-7] INFO  c.q.l.demo.prime.PrimeAction - 99 is not a valid value
  java.lang.Exception: 99 is invalid
  at ch.qos.logback.demo.prime.PrimeAction.execute(PrimeAction.java:28) [classes/:na]
  at org.apache.struts.action.RequestProcessor.processActionPerform(RequestProcessor.java:431) [struts-1.2.9.jar:1.2.9]
  at org.apache.struts.action.RequestProcessor.process(RequestProcessor.java:236) [struts-1.2.9.jar:1.2.9]
  at org.apache.struts.action.ActionServlet.doPost(ActionServlet.java:432) [struts-1.2.9.jar:1.2.9]

<configuration>子标签

• <include>：从另外的文件引入配置，目标文件必须将其标签放入<included>下。（SpringBoot基础配置便是如此，可参考spring-boot:2.4.0包中base.xml）
  • file
  • resource
  • url
  • optional：[true | false]，默认若找不到目标文件，将输出警告；可设置为可选避免该行为
• <contextName>：设置上下文名称，可作为区分不同多个应用程序到同一target的区分，默认为”default” 示例：

<contextName>myAppName</contextName>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
	<encoder>
	<pattern>%d %contextName [%t] %level %logger{36} - %msg%n</pattern>
</encoder>
</appender>

• <property>：配置或引入外部属性，别名
  • name
  • value
  • file：引用文件系统的 .properties 文件
  • resource：引用类路径上的 variables.properties 文件
  • scope：
    • local：默认，会在配置解释时定义，并在结束后清除。
    • context：上下文作用域，属性将插入到LoggerContext中直到LoggerContext被清除，因此在所有日志事件中都可用。
    • system：系统作用域，属性将插入到JVM系统属性中
• <define>：代码动态定义属性，以 PropertyDefiner#getPropertyValue 方法返回其值
  • name
  • class：PropertyDefiner实现全类名
• <conversionRule>：自定义转换词
  • conversionWord：转换词
  • converterClass：ClassicConverter 实现类全类名
• <appender>
  • *name：声明Appender名称
  • *class：要使用的Appender的完全限定名
  • <appender>、<layout>子标签：
    • <layout>：0或1个
      • class：若未声明，表示 PatternLayout
    • <encoder>：0或多个
      • class：若未声明，表示 PatternLayoutEncoder
    • <filter>：0或多个
• <logger>：0或多个，配置 Logger
  • name（必须）
  • level：[TRACE | DEBUG | INFO | WARN | ERROR | ALL | OFF]，或者 INHERITED / NULL 表示从上级继承。
  • additivity：[true | false]
  • 子标签：
    • <appender-ref> ：0或多个，表附加appender
      • ref：指定先前的名称
• <root>：配置根Logger
  • level：根Logger级别不能设置为 INHERITED / NULL
  • 子标签：
    • <appender-ref>

2.JVM系统属性

• logback.configurationFile：指定配置文件位置，可以是 URL、类路径资源或外部文件系统。也可以在代码中设置（System#setProperty），但必须在创建任意Logger实例之前。 文件扩展名必须是 .xml 或 .groovy
• logback.statusListenerClass：可设置为希望注册的 StatusListener 名称

3. PatternLayout 的格式化消息编写规则

基础规则

• 转换符 ’%’ 可后跟规定的word，来获取数据字段，如 logger名称，日期，线程名等

• 转换符可后接格式修饰符(Format modifiers)来指定每个字段最小、最大宽度 以及 是否左对齐 示例：

  写法	左对齐	最小宽度	最大宽度
  %20logger	false	20	none
  %.30logger	NA	none	30
  %-20.30logger	true	20	30

• 括号”()” 可将部分内容分组，常配合格式修饰符使用 如: %d{HH:mm:ss.SSS} [%thread]

  复制

  输出：
  13:09:30 [main] DEBUG c.q.logback.demo.ContextListener - Trying platform Mbean server
  13:09:30 [pool-1-thread-1] INFO  ch.qos.logback.demo.LoggingTask - Howdydy-diddly-ho - 0

  %-30(%d{HH:mm:ss.SSS} [%thread])

• 一些关键词可使用转义符\来输出

常用转换词

• 日志事件的消息：m / msg / messages

• 日志级别：p / le / level

• Logger 名 语法：

  复制

  c{length}
  lo{length}
  logger{length}

  含义/示例： length表示推荐最大长度，logback会根据该长度适当缩写Logger名，但始终会保证最右段不会缩写

  示例	Logger原名称	打印结果
  %logger	mainPackage.sub.sample.Bar	mainPackage.sub.sample.Bar
  %logger	mainPackage.sub.sample.Bar	Bar
  %logger	mainPackage.sub.sample.Bar	m.s.s.Bar
  %logger	mainPackage.sub.sample.Bar	m.sub.sample.Bar

• 上下文名：contextName

• 日志事件的线程名： t / thread

• 从”应用启动”到”产生该日志事件”经过的毫秒数：r / relative

• 日期 语法：

  复制

  d{pattern}
  date{pattern}
  d{pattern, timezone}
  date{pattern, timezone}

  含义/示例：输出日志事件的日期，其 pattern 语法与 java.text.SimpleDateFormat 格式兼容 在没有 timezone 的情况下，使用 Java 平台默认时区

  示例	结果
  %d	2006-10-20 14:06:49,812
  %date	14:06:49.812
  %date	20 oct. 2006;14:06:49.812
  %date

• 换行符：n

• 异常： 语法：

  复制

  ex{depth}
  exception{depth}
  throwable{depth}
  
  ex{depth, evaluator-1, ..., evaluator-n}
  exception{depth, evaluator-1, ..., evaluator-n}
  throwable{depth, evaluator-1, ..., evaluator-n}

  含义/示例：输出与日志事件关联的异常的stacktrace信息，默认输出完整的stacktrace

• 属性：property

• 正则替换：replace(p){r,t} 将消息模式p中的r替换为t 如：%replace(%logger %msg){'\.', '/'}将所有”.”替换为”/”

• MDC（Mapped Diagnostic Contex）字段：%X{filedName}

• 自定义转换词：

  1. 自定义实现 ClassicConverter，重写 convert(ILoggingEvent) 方法

     java复制

     public class MySampleConverter extends ClassicConverter {
     	long start = System.nanoTime();
     
     	@Override
     	public String convert(ILoggingEvent event) {
     		long nowInNanos = System.nanoTime();
     		return Long.toString(nowInNanos-start);
     	}
     }

  2. 声明转换词

     xml复制

     <configuration>
     	<conversionRule conversionWord="nanos" converterClass="chapters.layouts.MySampleConverter" />
     	<!-- … -->
     </configuration>

性能考虑，应避免使用的转换词

• 类名：C{length} / class
• 文件名：F / file
• 行号：L / line
• 方法名：M / method
• 包含jar包信息的异常stacktrace：xEx{depth} / xException{depth}… 及root异常顺序反转的 rEx{depth} / rootException{depth}…

4. 着色（Coloring）

基于ANSI颜色代码，Logback可使用颜色关键词来为分组设置颜色。内置了：“%highlight”,“%black”, “%red”, “%green”,“%yellow”,“%blue”, “%magenta”,“%cyan”, “%white”, “%gray”, “%boldRed”,“%boldGreen”, “%boldYellow”, “%boldBlue”, “%boldMagenta""%boldCyan”, “%boldWhite” 例： <pattern>%d ${HOSTNAME} [%t] %highlight(%level) %logger{36} - %msg%n %ex{full}</pattern>

踩坑：官方说明使用 jansi 可以做到兼容不兼容ANSI的终端，但 Windows 下始终报错，即便引入了推荐版本 仍然报错

<dependency>
	<groupId>org.fusesource.jansi</groupId>
	<artifactId>jansi</artifactId>
	<version>1.17</version>
</dependency>

5.异步Appender

可通过声明AsyncAppender来执行异步日志打印，它只进行日志事件分发，因此必须引用另一个实际Appender才有意义

六、常见需求

1. 根据环境变量动态附加Appender

   参考：

   How to select Logback appender based on property file or environment variable

   1. 使用 logback 官方支持的 语法，但同样需要引入 Janino library。参考：configuration

   2. 为 Appender 设置 ，并使用环境变量语法动态配置Filter的Level【有些曲线救国，应该仍有性能损耗

   3. 使用 SpringProfile

      例：

      yaml复制

      application.yaml
      spring:
        profiles:
      	active:
      	  - ${ENV:classiclogs}

      xml复制

      logback.xml
      <configuration>
      	<!-- appender conf…-->
      	<springProfile name="jsonlogs">
      		<root level="info">
      			<appender-ref ref="stdout-json" />
      		</root>
      	</springProfile>
      	<springProfile name="classiclogs">
      		<root level="info">
      			<appender-ref ref="stdout-classic" />
      		</root>
      	</springProfile>
      </configuration>

七、踩坑

1. 对于嵌套 .xml 配置文件，默认域”local”重复声明的话是无效的，不会覆盖。 比如在我的logback.xml中声明，无法覆盖Spring自带的配置。

撰文参考： http://logback.qos.ch/manual/index.html

控制附加器可加性的规则总结如下。

Appender Additivity 可加性

The output of a log statement of logger L will go to all the appenders in L and its ancestors. This is the meaning of the term “appender additivity”. loggerL的log语句的输出将转到L中的所有appender及其祖先。这就是术语“附加器可加性”的含义。

However, if an ancestor of logger L, say P, has the additivity flag set to false, then L’s output will be directed to all the appenders in L and its ancestors up to and including P but not the appenders in any of the ancestors of P. 然而，如果记录器L的祖先，比如P，具有设置为假的可加性标志，则L的输出将被定向到L中的所有附加器及其直到并包括P的祖先，但不定向到P的任何祖先中的附加器。

Loggers have their additivity flag set to true by default. 默认情况下，记录器的可加性标志设置为true。

然而，任何方法调用都涉及参数构造的“隐藏”成本。例如，对于某些记录器x写入，

x.debug("Entry number: " + i + "is " + entry[i]);

参数构造的成本可能相当高，并且取决于所涉及的参数的大小。为了避免参数构造的成本，您可以利用SLF4J的参数化日志记录：

x.debug("Entry number: {} is {}", i, entry[i]);

下面两行将产生完全相同的输出。然而，在禁用日志记录语句的情况下，第二个变体将比第一个变体的性能好至少30倍。

logger.debug("The new entry is "+entry+".");
logger.debug("The new entry is {}.", entry);

A two argument variant is also available. For example, you can write: 也可以使用两个参数的变体。例如，你可以这样写：

logger.debug("The new entry is {}. It replaces {}.", entry, oldEntry);

If three or more arguments need to be passed, a varargs (Object…) variant is also available. For example, you can write: 如果需要传递三个或更多参数，则可以使用varargs（Object.）变体也可用。例如，你可以这样写：

logger.debug("Value {} was inserted between {} and {}.", newVal, below, above);

Note that the varags variant incurs the cost of the creation of an Object[] instance. 注意，varags变量会导致创建Object[]实例的开销。

Assuming the configuration files logback-test.xml or logback.xml are not present, logback will default to invoking BasicConfigurator which will set up a minimal configuration. This minimal configuration consists of a ConsoleAppender attached to the root logger. The output is formatted using a PatternLayoutEncoder set to the pattern %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%kvp- %msg%n. Moreover, by default the root logger is assigned the DEBUG level. 假设配置文件logback-test.xml或logback.xml不存在，logback将默认调用Basicallator，这将设置最小配置。这个最小配置包括一个连接到根日志记录器的控制台日志记录器。使用模式%d{HH：mm：ss.SSS} [%thread] %-5level %logger{36} -%kvp- %msg%n设置的PatternLayoutEncoder格式化输出。此外，默认情况下，根日志记录器被分配了DEBUG级别。

在没有警告或错误的情况下，如果您仍然希望检查logback的内部状态，那么您可以通过调用StatusPrinter类的print（）来指示logback打印状态数据。下面显示的MyApp2应用程序与MyApp1相同，只是增加了两行用于打印内部状态数据的代码。

// assume SLF4J is bound to logback in the current environment
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
// print logback's internal status
StatusPrinter.print(lc);

Status data 状态数据 Enabling output of status data usually goes a long way in the diagnosis of issues with logback. 启用状态数据的输出通常在诊断logback问题方面有很大的帮助。 Enabling output of status data usually goes a long way in the diagnosis of issues with logback. Note that errors can also occur post-configuration, e.g. when a disk a full or log files cannot be archived due to permission errors. As such, it is highly recommended that you register a StatusListener as discussed below. 启用状态数据的输出通常在诊断logback问题方面有很大的帮助。请注意，错误也可能发生在配置后，例如，当磁盘已满或日志文件由于权限错误而无法存档时。因此，强烈建议您按照下面的讨论注册状态表。

The next example illustrates the installation of OnConsoleStatusListener. 下一个示例说明了OnConsoleStatusServer的安装。

<configuration>
   <!-- Recommendation: place status listeners towards the the top of the configuration file -->
   <statusListener class="ch.qos.logback.core.status.OnConsoleStatusListener" />

   <!-- ... the rest of the configuration file -->

</configuration>

顺便说一下，设置debug=“true”与安装OnConsoleStatusController是完全等效的，如前所示。

Automatically reloading configuration file upon modification 修改后自动重新加载配置文件 Logback-classic can scan for changes in its configuration file and automatically reconfigure itself when the configuration file changes. Logback-classic可以扫描其配置文件中的更改，并在配置文件更改时自动重新配置自己。 If instructed to do so, logback-classic will scan for changes in its configuration file and automatically reconfigure itself when the configuration file changes. In order to instruct logback-classic to scan for changes in its configuration file and to automatically re-configure itself set the scan attribute of the element to true, as shown next. 如果收到指示，logback-classic将扫描其配置文件中的更改，并在配置文件更改时自动重新配置自己。为了指示logback-classic扫描其配置文件中的更改并自动重新配置自身，请将元素的scan属性设置为true，如下所示。

Example: Scanning for changes in configuration file and automatic re-configuration (logback-examples/src/main/resources/chapters/configuration/scan1.xml) 示例：扫描配置更改 文件和自动重新配置 （logback-examples/src/main/resources/chapters/configuration/scan1.xml）

<configuration>

  <variable name="USER_HOME" value="/home/sebastien" />

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>${USER_HOME}/myApp.log</file>
    <encoder>
      <pattern>%kvp %msg%n</pattern>
    </encoder>
  </appender>

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

<configuration>

  <variable file="src/main/java/chapters/configuration/variables1.properties" />

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
     <file>${USER_HOME}/myApp.log</file>
     <encoder>
       <pattern>%kvp %msg%n</pattern>
     </encoder>
   </appender>

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

USER_HOME=/home/sebastien

<configuration>

  <variable resource="resource1.properties" />

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
     <file>${USER_HOME}/myApp.log</file>
     <encoder>
       <pattern>%kvp %msg%n</pattern>
     </encoder>
   </appender>

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

Under certain circumstances, it may be desirable for a variable to have a default value if it is not declared or its value is null. As in the Bash shell, default values can be specified using the ":-" operator. For example, assuming the variable named aName is not defined, "${aName:-golden}" will be interpreted as "golden".
在某些情况下，如果变量未声明或其值为null，则可能需要变量具有默认值。与在Bash shell中一样，可以使用“：-”操作符指定默认值。例如，假设未定义名为aName的变量，则“${aName：-golden}”将被解释为“golden”。

Example: Nested variable references
   (logback-examples/src/main/resources/chapters/configuration/variables2.properties)
示例：嵌套变量引用
   （logback-examples/ src/main/resources/ chapters/configuration/variables2.properties）

USER_HOME=/home/sebastien
fileName=myApp.log
destination=${USER_HOME}/${fileName}

name nesting 名字嵌套
When referencing a variable, the variable name may contain a reference to another variable. For example, if the variable named "userid" is assigned the value "alice", then "${${userid}.password}" references the variable with the name "alice.password".
当引用一个变量时，变量名可能包含对另一个变量的引用。例如，如果名为“userid”的变量被赋以值“alice”，则“${${userid}.password}”引用名为“alice.password”的变量。

default value nesting 缺省值嵌套
The default value of a variable can reference another variable. For example, assuming the variable 'id' is unassigned and the variable 'userid' is assigned the value "alice", then the expression "${id:-${userid}}" will return "alice".
一个变量的默认值可以引用另一个变量。例如，假设变量“id”未赋值，变量“userid”赋值为“alice”，则表达式“${id：- ${userid}}”将返回“alice”。

At the present time, logback ships with some fairly simple implementations of PropertyDefiner. 目前，logback附带了一些相当简单的PropertyDefiner实现。

​

​

File inclusion 文件包含 Joran supports including parts of a configuration file from another file. This is done by declaring a element, as shown below: Joran支持包含来自另一个文件的配置文件的部分。这是通过声明元素来完成的，如下所示：

Example: File include (logback-examples/src/main/resources/chapters/configuration/containingConfig.xml) 示例：文件包含 （logback-examples/ src/main/resources/ chapters/configuration/ containingConfig. xml）

Legacy 遗产Canonical (1.3) Canonical（1.3）Tyler 泰勒

<configuration>
  <include file="src/main/java/chapters/configuration/includedConfig.xml"/>

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

</configuration>

The target file MUST have its elements nested inside an element. For example, a ConsoleAppender could be declared as: 目标文件必须将其元素嵌套在元素中。例如，ConsoleReader可以声明为：

Example: File include (logback-examples/src/main/resources/chapters/configuration/includedConfig.xml) 示例：文件包含 （logback-examples/ src/main/resources/ chapters/configuration/ includedConfig. xml）

<included>
  <appender name="includedConsole" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>"%d -%kvp- %m%n"</pattern>
    </encoder>
  </appender>
</included>

The contents to include can be referenced as a file, as a resource, or as a URL. 要包含的内容可以作为文件、资源或URL引用。

As a file: 作为一个文件： To include a file use the file attribute. You can use relative paths but note that the current directory is defined by the application and is not necessarily related to the path of the configuration file. 要包含文件，请使用file属性。可以使用相对路径， 注意，当前目录由应用程序定义， 不一定与配置的路径相关 文件. As a resource: 作为资源： To include a resource, i.e a file found on the class path, use the resource attribute. 要包含一个资源，即 文件，使用resource属性。

# defines aKey set to aValue
aKey=aValue
# sets the level of the root logger to 'LEVEL'
logback.root=LEVEL
# sets the logger named 'LOGGER_NAME' to 'LEVEL'
logback.logger.LOGGER_NAME=LEVEL

logback.root = INFO

com_foo_level = DEBUG    

logback.logger.org.xyz.http = TRACE
logback.logger.org.xyz.database = ERROR
logback.com.foo = ${com_foo_level}

 <!-- rest of the configuration file .... -->

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

<layout class="ch.qos.logback.classic.html.HTMLLayout">
  <pattern>%relative...%msg</;pattern>
  <cssBuilder class="ch.qos.logback.classic.html.UrlCssBuilder">
    <!-- url where the css file is located -->
    <url>http://...</url>
  </cssBuilder>
</layout>