既然使用Logback,应该对它多些了解(一)

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。


logger level 层级

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
  1. 在代码中设置
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>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,240评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,328评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,182评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,121评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,135评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,093评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,013评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,854评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,295评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,398评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,989评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容