既然使用Logback，应该对它多些了解

Posted 2021-04-24 独立游戏开发者号

1. 打印logback的内部状态信息

import org.slf4j.Logger;import org.slf4j.LoggerFactory;import ch.qos.logback.classic.LoggerContext;import ch.qos.logback.core.util.StatusPrinter;
public class HelloWorld2 {
 public static void main(String[] args) { Logger logger = LoggerFactory.getLogger("chapters.introduction.HelloWorld2"); logger.debug("Hello world.");
 // print internal state LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); StatusPrinter.print(lc); }}

没有添加任何的配置文件下，将会 输出：

12:49:22.203 [main] DEBUG chapters.introduction.HelloWorld2 - Hello world.12:49:22,076 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback.groovy]12:49:22,078 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback-test.xml]12:49:22,093 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Could NOT find resource [logback.xml]12:49:22,093 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Setting up default configuration.

从这里可以看出，它没有找到logback的配置文件，就会使用一个默认的配置，其实默认的配置中只会给root添加一个ConsoleAppender 。

2. logger命名具有层级性

在logback中，logger的命名可以使用点(.)分开，表示层级性，比如“com”,“com.xinyues”，这表示com是com.xinyues的父层。每个logger都需要一个level的配置，如果某个logger没有配置level，就会使用父logger的level，在最顶层的logger名字是root，如果它没有配置level，就会给他一个默认的level，它的值是debug。

3. 相同名字的logger在系统中只有一个实例

比如：

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

这里面的x和y获得的是同一个Logger实例。

4. 日志输出的添加性(additivity)

默认情况下，一个日志logger的输出内容，会发送到这个日志logger和它上层日志logger的appender中，这个就是日志的appender additivity特性。

但是，比如，有一个logger的名字是com.xinyues，还有一个logger的名字是com，com是com.xinyues的上层logger，如果com的logger设置了additivity为false，那么com.xinyues的日志输入就不会发送到com的appender之中了。

5. 指定logback的配置文件位置

1. 在system property中指定

java -Dlogback.configurationFile=/path/to/config.xml chapters.configuration.MyApp1

2. 在代码中设置

System.setProperty(ContextInitializer.CONFIG_FILE_PROPERTY, "/path/to/config.xml");

上面代码必须放在打印第一条日志之前。

6. 当logback配置发生变化时，自动加载最新配置

默认是1分钟检测一次配置文件是否变化：

<configuration scan="true">  ... </configuration>

也可以指定时间,时间单位可以是：milliseconds, seconds, minutes or hours，如下所示：

<configuration scan="true" scanPeriod="30 seconds" >  ...</configuration>

注意，如果不指定时间单位，将会按毫秒处理。

7. 同一条日志，可以打印到多个Appender之中

<configuration>
 <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>myApp.log</file>
 <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>

在这个配置文件中，配置了两个Appender，它们配置了两个不同的encoder，通过logger的appender-ref关联到这两个Appender，注意，每一个Appender都有它自己的encoder，ecoder一般不会在多个Appender中共享使用，layout也是如此。

8. 日志重复打印的问题

默认情况下，Appender是累加的：一个logger默认会绑定它自己appender-ref的appender，同时，也会继承这个logger上级的所有的appender，并且相同名字的appender不会覆盖。这就会导致，一条日志被打印的时候，如果日志级别相同，就会在logger的自己的appender中打印一次，又会在它上级的logger绑定的appender中打印一次，如下所示：

<configuration>
 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender>
 <logger name="chapters.configuration"> <appender-ref ref="STDOUT" /> </logger>
 <root level="debug"> <appender-ref ref="STDOUT" /> </root></configuration>

如果在chapters.configuration包下面有类要打印日志，运行的时候，会输出：

14:25:36.343 [main] INFO chapters.configuration.MyApp3 - Entering application.14:25:36.343 [main] INFO chapters.configuration.MyApp3 - Entering application.14:25:36.359 [main] DEBUG chapters.configuration.Foo - Did it again!14:25:36.359 [main] DEBUG chapters.configuration.Foo - Did it again!14:25:36.359 [main] INFO chapters.configuration.MyApp3 - Exiting application.14:25:36.359 [main] INFO chapters.configuration.MyApp3 - Exiting application.

这是因为STDOUT被绑定到了两个logger上面，因为root logger是所有的logger的上级，而 chapters.configuration又是当前类的logger上级，所以会在 chapters.configuration的logger中打印一次，同时又在root的logger中打印一次。logback的这种特性并不是一个无用的设置，相反，它是非常有用的，比如，在开发中，不同的模块可能会将日志打印到不同的appender之中，但是在开发阶段，又希望所有的日志都在console中打印，可以这样配置：

<configuration>
 <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>myApp.log</file> <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>
 <logger name="chapters.configuration"> <appender-ref ref="FILE" /> </logger>
 <root level="debug"> <appender-ref ref="STDOUT" /> </root></configuration>

这样配置，chapters.configuration一的日志既会打印到FILE的appender之中，又会在console中打印一次，方便开发调试。

但是在有些开发环境中，你不需要这种特性，只想让日志打印到logger自己的appender之中，可以在logger中，将additivity属性设置为false即可。如下配置所示：

<configuration>
 <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>foo.log</file> <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>
 <logger name="chapters.configuration.Foo" additivity="false"> <appender-ref ref="FILE" /> </logger>
 <root level="debug"> <appender-ref ref="STDOUT" /> </root></configuration>

9. 公共变量定义

在logback的配置文件中，可以自定义一些公共变量，然后在使用的地方直接引用变量名即可。如下所示：

<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>

在配置文件开头定义了USER_HOME变量，就可以在其它地方以${USER_HOME}的方式引用。

logback的变量值也可以从Java的System Property中获取，而不需要在配置文件中写死。如果在配置文件中找不到定义的变量，它将自动从System properties中找查，System properties可以在进程运行时指定：

java -DUSER_HOME="/home/sebastien" MyApp2

另外，如果变量参数比较多，也可以把这些变量统一配置到一个指定的.properties文件中，然后在logback的配置文件中指定变量的配置文件即可。例如变量配置文件内容是(/src/main/resources/chapters/configuration/variables1.properties)：

USER_HOME=/home/sebastien

logback的配置则为：

<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>

如果配置文件在classpath下面，可以省略路径，直接使用：

<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>

公众号.png