最近要重构之前的API自动化测试框架，其中需要添加一项回归结果入库的功能，经过梳理发现为了顺利完成这个功能的开发，第一步需要学会使用log日志工具，调研后发现logback是目前Java中使用广泛、功能完善并且处于主流地位的日志工具。好记性不如烂笔头，特此记录一下学习过程。

如何快速学习开始使用一个新的工具？

• 在github中搜索你需要的工具，例如logback
• 认真阅读README.md文档，不出意外在该文件中就能看到官方的Manual文档地址，戳链接可直接跳转
• 认真阅读Manual中给出的example，一定要跟着example实操，一定要跟着example实操，一定要跟着example实操，重要事情说三遍。

logback github repo 地址请戳
logback 官方文档地址请戳

关于logback的配置

此章节对应官方文档chapter3 Configuration的内容。

logback支持使用xml或groovy文件进行配置，按照本人习惯这里使用xml文件进行说明。
logback的检索流程如下：

1. logback会在当前project目录下查找logbcak-test.xml配置文件；
2. 如果1中的文件没有被找到，则自动查找logback.groovy配置文件；
3. 如果2中的文件没有被找到，则自动查找logback.xml配置文件；
4. 如果以上文件都没有被找到，则自动在project目录下生成配置文件；
5. 如果以上配置都没有成功，那么logback将自动按照默认配置输出日志等级为最小配置的日志信息。

在Maven工程中，通常会把logback.xml配置文件放在src/test/resource文件夹下。

自动配置logback

自动配置的logback只输出[main]线程的信息。

对应的log信息输出如下，只包含[main]线程：

16:06:09.031 [main] INFO  chapters.configuration.MyApp1 - Entering application.
16:06:09.046 [main] DEBUG chapters.configuration.Foo - Did it again!
16:06:09.046 [main] INFO  chapters.configuration.MyApp1 - Exiting application.

修改logback.xml配置如下，对应的log信息会先输出内部的INFO信息，再输出[main]线程的信息。

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

对应的log信息如下：

17:44:58,578 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Found resource [logback-test.xml]
17:44:58,671 |-INFO in ch.qos.logback.classic.joran.action.ConfigurationAction - debug attribute not set
17:44:58,671 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - About to instantiate appender of type [ch.qos.logback.core.ConsoleAppender]
17:44:58,687 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - Naming appender as [STDOUT]
17:44:58,812 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - Popping appender named [STDOUT] from the object stack
17:44:58,812 |-INFO in ch.qos.logback.classic.joran.action.LevelAction - root level set to DEBUG
17:44:58,812 |-INFO in ch.qos.logback.core.joran.action.AppenderRefAction - Attaching appender named [STDOUT] to Logger[root]

17:44:58.828 [main] INFO  chapters.configuration.MyApp2 - Entering application.
17:44:58.828 [main] DEBUG chapters.configuration.Foo - Did it again!
17:44:58.828 [main] INFO  chapters.configuration.MyApp2 - Exiting application.

自动扫描

在logback.xml文件中添加scan="true"的属性，logback-classic会自动扫描文件中的变化并且自动重新配置，同时可以搭配scanPeriod="time"标签设置自动扫描的周期。

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

scanPeriod的默认时间单位是毫秒，示例中指定了单位是seconds。

packaging data in stack traces

1.1.4以上的版本默认不显示packaging data in stack traces，如果要输出这些信息，可使用packagingData="true"标签进行设置。

重写logbak

logback的核心依赖是名字为Joran的Library，如果要重写logback需invoking JoranConfigurator，详细信息请参考官网~