logback 配置

1. logback 配置

logback的配置方式包括：编程配置、XML文件配置、Groovy文件配置。对于使用log4j的用户，还可以通过logback提供的工具( http://logback.qos.ch/translator/ ) 将log4j.properties配置文件转换为logback.xml格式。

logback 初始化配置的步骤如下：

1. 在类路径下依次查找 logback.groovy, logback-test.xml, logback.xml文件；
2. 若找到配置文件，则读取文件，配置logback；
3. 如果没找到任何配置文件，且JVM包含ServiceLoader(JDK 6以上)，则由ServiceLoader解析com.qos.logback.classic.spi.Configurator的实现。
4. 如果以上均失败，则使用BasicConfigurator的默认配置，输出日志到控制台。

 

3、4两步用于在没找到配置文件时提供默认配置。

 

1.1 logback的默认配置

不提供配置文件，logback使用其默认配置。先给个示例代码：

package或多个<appender-ref>。

实例：假如不想看到"chapters.configuration"包中任何DEBUG信息，如下

<?xml version="1.0" encoding="UTF-8" ?>

<configuration>

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

<!-- encoders are assigned by default the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->

<encoder>

<pattern>

%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

</pattern>

</encoder>

</appender>

 

<logger name="chapters.configuration" level="INFO" />

 

<!-- 严格的说，下面的level属性是不需要的，因为root的默认值为DEBUG -->

<root level="DEBUG">

<appender-ref ref="STDOUT" />

</root>

 

</configuration>

包"chapters.configuration"的level属性设置为"INFO"，这样DEBUG信息均被过滤掉了。如果将该配置文件作为参数传递给MyApp3，其输出如下：

20:59:32.913 [main] INFO  chapters.configuration.MyApp3 - Entering application.

20:59:32.917 [main] INFO  chapters.configuration.MyApp3 - Exiting application.

此时由"chapters.configuration.Foo"生成的DEBUG信息被抑制。

 

可以按照自己的想法随意设置多个logger的level，比如，将chapters.configuration 包设置INFO，单独把Foo设置为DEBUG，如下所示：

<?xml version="1.0" encoding="UTF-8" ?>

<configuration>

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

<!-- encoders are assigned by default the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->

<encoder>

<pattern>

%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

</pattern>

</encoder>

</appender>

<logger name="chapters.configuration" level="INFO" />

<logger name="chapters.configuration.Foo" level="DEBUG" />

<root level="DEBUG">

<appender-ref ref="STDOUT" />

</root>

</configuration>

用该文件作为参数运行MyApp3，输出如下：

21:16:56.913 [main] INFO  chapters.configuration.MyApp3 - Entering application.

21:16:56.915 [main] DEBUG chapters.configuration.Foo - Did it again!

21:16:56.916 [main] INFO  chapters.configuration.MyApp3 - Exiting application.

下面列出上面各个logger对应的level:

Logger 名	指定的 Level	实际的 Level
root	DEBUG	DEBUG
chapters.configuration	INFO	INFO
chapters.configuration.MyApp3	null	INFO
chapters.configuration.Foo	DEBUG	DEBUG

由此可见，MyApp3的INFO和Foo.doIt()的DEBUG都启用了。而root logger总是为非NULL的，其默认值为DEBUG。

 

<appender>

<appender>用于配置日志输出位置。属性：

属性名	类型	Use	描述
name	string	required	appender名，可随意取
class	string	required	appender对应的类，需包含完整路径，如输出到console对应的：class="ch.qos.logback.core.ConsoleAppender"

子元素：

元素名	minOccurs	maxOccurs
layout	0	1
encoder	0	unbounded
filter	0	unbounded

 

layout

layout元素必须包含class元素，包含layout类的完全限定名。

 

<configuration>

<appender name="FILE" class="ch.qos.logback.core.FileAppender">

<file>myApp.log</file>

<!-- encoders are assigned by default the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->

<encoder>

<pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>

</encoder>

</appender>

 

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

<encoder>

<pattern>%msg%n</pattern>

</encoder>

</appender>

 

<root level="debug">

<appender-ref ref="FILE" />

<appender-ref ref="STDOUT" />

</root>

</configuration>

 

2.6 定义变量

可以在配置文件中定义变量，也可以从外部导入。在logback的XML配置文件中可以用<property>和<variable>(1.07之后)定义变量。下面定义一个变量，用于定义输出文件位置：

<configuration>

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

 

<appender name="FILE" class="ch.qos.logback.core.FileAppender">

<file>${USER_HOME}/myApp.log</file>

<encoder>

<pattern>%msg%n</pattern>

</encoder>

</appender>

 

<root level="debug">

<appender-ref ref="FILE" />

</root>

</configuration>

也可以用系统变量达到相同的目的：

java -DUSER_HOME="/home/sebastien" MyApp2

然后在配置文件中引用该变量：

<configuration>

<appender name="FILE" class="ch.qos.logback.core.FileAppender">

<file>${USER_HOME}/myApp.log</file>

<encoder>

<pattern>%msg%n</pattern>

</encoder>

</appender>

 

<root level="debug">

<appender-ref ref="FILE" />

</root>

</configuration>

如果需要很多变量，则以一个单独的文件存放所有变量比较合适：

下面的配置文件引用了一个变量：

<configuration>

<property 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>%msg%n</pattern>

</encoder>

</appender>

 

<root level="debug">

<appender-ref ref="FILE" />

</root>

</configuration>

该文件包含variables1.properties属性文件的引用。属性文件中定义的变量会被作为本地变量引入，variable.properties文件格式如下：

USER_HOME=/home/sebastien

也可以直接引用类路径下的文件：

<configuration>

<property resource="resource1.properties" />

 

<appender name="FILE" class="ch.qos.logback.core.FileAppender">

<file>${USER_HOME}/myApp.log</file>

<encoder>

<pattern>%msg%n</pattern>

</encoder>

</appender>

 

<root level="debug">

<appender-ref ref="FILE" />

</root>

</configuration>

 

作用域

还可以对上面定义的变量进行作用域限制，local, context或system，分别对应配置范围，logback程序范围及JVM范围，定义方式如下：

<configuration>

<property scope="context" name="nodeId" value="firstNode" />

 

<appender name="FILE" class="ch.qos.logback.core.FileAppender">

<file>/opt/${noteId}/myApp.log</file>

<encoder>

<pattern>%msg%n</pattern>

</encoder>

</appender>

 

<root level="debug">

<appender-ref ref="FILE" />

</root>

</configuration>

scope可用值有：local, context 和 system。

 

默认值

假设变量名为aName，指定其默认值为golder，指定语法为："${aName:-golden}"。

 

嵌套变量

嵌套指一个变量可以引用另一个变量。包括值嵌套、名嵌套以及默认值嵌套。

值嵌套

USER_HOME=/home/sebastien

fileName=myApp.log

destination=${USER_HOME}/${fileName}

destination变量值包含对USER_HOME变量值和fileName变量值的引用。

名嵌套

当引用一个变量时，变量名可能包含对其他变量的引用。例如，如果变量"userid"的值为"alice"，则"${${userid}.password}"表示名为"alice.password"的变量。

默认值嵌套

如变量"id"未分配值，变量"userid"值为"alice"，则"${id:-${userid}}"