走进Java接口测试之日志框架Logback

Posted 2021-09-29 高楼（Zee）

引言

对于一个成熟的接口测试框架，日志管理这个是必不可少的。在开发和调试阶段，日志可以帮助我们更快的定位问题；而在测试的运维过程中，日志系统又可以帮助我们记录大部分的异常信息，通常很多测试框架会通过收集日志信息来对接口测试状态进行实时监控预警。

前言

Spring Boot 在所有内部日志中使用 ​​CommonsLogging​​，但是默认配置也提供了对常用日志的支持，如： ​​Java.Util.Logging​​， ​​Log4J​​, ​​Log4J2​​和 ​​Logback​​。每种 Logger 都可以通过配置使用控制台或者文件输出日志内容。

LogBack、Slf4j和Log4j之间的关系

Slf4j 是 ​​The Simple Logging Facade for Java​​的简称，是一个简单日志门面抽象框架，它本身只提供了日志 ​​Facade API​​和一个简单的日志类实现，一般常配合Log4j，LogBack，java.util.logging使用。Slf4j作为应用层的Log接入时，程序可以根据实际应用场景动态调整底层的日志实现框架(Log4j/LogBack/JdkLog等)。

LogBack和Log4j都是开源日记工具库，LogBack 是 Log4j 的改良版本，比 Log4j 拥有更多的特性，同时也带来很大性能提升，同时天然支持SLF4J。

LogBack 官方建议配合 Slf4j 使用，这样可以灵活地替换底层日志框架。

TIPS：为了优化log4j，以及更大性能的提升，Apache基金会已经着手开发了log4j 2.0, 其中也借鉴和吸收了logback的一些先进特性。

默认日志Logback

默认情况下，Spring Boot 会用 Logback 来记录日志，并用 INFO 级别输出到控制台。在运行应用程序和其他例子时，你应该已经看到很多INFO级别的日志了。 从上图可以看到，日志输出内容元素具体如下：

• 时间日期：精确到毫秒
• 日志级别：ERROR, WARN, INFO, DEBUG or TRACE
• 进程 ID
• 分隔符：--- 标识实际日志的开始
• 线程名：方括号括起来（可能会截断控制台输出）
• Logger名：通常使用源代码的类名
• 日志内容

配置详解

添加日志依赖

假如maven依赖中添加了 ​​spring-boot-starter-logging​​：

1. <dependency>

2.     <groupId>org.springframework.boot</groupId>

3.     <artifactId>spring-boot-starter-logging</artifactId>

4. </dependency>

那么，我们的Spring Boot应用将自动使用 logback 作为应用日志框架，Spring Boot 启动的时候，由 ​​org.springframework.boot.logging.Logging-Application-Listener​​根据情况初始化并使用。

但是呢，实际开发中我们不需要直接添加该依赖，你会发现 ​​spring-boot-starter​​其中包含了 ​​spring-boot-starter-logging​​，该依赖内容就是 Spring Boot 默认的日志框架 logback 

配置文件

Spring Boot 官方推荐优先使用带有 ​​-spring​​的文件名作为你的日志配置（如使用 ​​logback-spring.xml​​，而不是 ​​logback.xml​​），命名为 ​​logback-spring.xml​​的日志配置文件，spring boot 可以为它添加一些 spring boot 特有的配置项（下面会提到）。并且放在 src/main/resources 下面即可。

配置文件 ​​logback-spring.xml​​

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

2. <configuration>

3. 

4.     <!-- 日志根目录-->

5.     <springProperty scope="context" name="LOG_HOME" source="logging.path" defaultValue="./logs/spring-boot-logback"/>

6. 

7.     <!-- 日志级别 -->

8.     <springProperty scope="context" name="LOG_ROOT_LEVEL" source="logging.level.root" defaultValue="DEBUG"/>

9. 

10.     <!--  标识这个"STDOUT" 将会添加到这个logger -->

11.     <springProperty scope="context" name="STDOUT" source="log.stdout" defaultValue="STDOUT"/>

12. 

13.     <!-- 日志文件名称-->

14.     <property name="LOG_PREFIX" value="spring-boot-logback" />

15. 

16.     <!-- 日志文件编码-->

17.     <property name="LOG_CHARSET" value="UTF-8" />

18. 

19.     <!-- 日志文件路径+日期-->

20.     <property name="LOG_DIR" value="${LOG_HOME}/%d{yyyyMMdd}" />

21. 

22.     <!--对日志进行格式化-->

23.     <property name="LOG_MSG" value="- | [%X{requestUUID}] | [%d{yyyyMMdd HH:mm:ss.SSS}] | [%level] | [${HOSTNAME}] | [%thread] | [%logger{36}] | --> %msg|%n "/>

24. 

25.     <!--文件大小，默认10MB-->

26.     <property name="MAX_FILE_SIZE" value="50MB" />

27. 

28.     <!-- 配置日志的滚动时间 ，表示只保留最近 10 天的日志-->

29.     <property name="MAX_HISTORY" value="10"/>

30. 

31.     <!--输出到控制台-->

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

33.         <!-- 输出的日志内容格式化-->

34.         <layout class="ch.qos.logback.classic.PatternLayout">

35.             <pattern>${LOG_MSG}</pattern>

36.         </layout>

37.     </appender>

38. 

39.     <!--输出到文件-->

40.     <appender name="0" class="ch.qos.logback.core.rolling.RollingFileAppender">

41.     </appender>

42. 

43.     <!-- 定义 ALL 日志的输出方式:-->

44.     <appender name="FILE_ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">

45.         <!--日志文件路径，日志文件名称-->

46.         <File>${LOG_HOME}/all_${LOG_PREFIX}.log</File>

47. 

48.         <!-- 设置滚动策略，当天的日志大小超过 ${MAX_FILE_SIZE} 文件大小时候，新的内容写入新的文件， 默认10MB -->

49.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

50. 

51.             <!--日志文件路径，新的 ALL 日志文件名称，“ i ” 是个变量 -->

52.             <FileNamePattern>${LOG_DIR}/all_${LOG_PREFIX}%i.log</FileNamePattern>

53. 

54.             <!-- 配置日志的滚动时间 ，表示只保留最近 10 天的日志-->

55.             <MaxHistory>${MAX_HISTORY}</MaxHistory>

56. 

57.             <!--当天的日志大小超过 ${MAX_FILE_SIZE} 文件大小时候，新的内容写入新的文件， 默认10MB-->

58.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

59.                 <maxFileSize>${MAX_FILE_SIZE}</maxFileSize>

60.             </timeBasedFileNamingAndTriggeringPolicy>

61. 

62.         </rollingPolicy>

63. 

64.         <!-- 输出的日志内容格式化-->

65.         <layout class="ch.qos.logback.classic.PatternLayout">

66.             <pattern>${LOG_MSG}</pattern>

67.         </layout>

68.     </appender>

69. 

70.     <!-- 定义 ERROR 日志的输出方式:-->

71.     <appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">

72.         <!-- 下面为配置只输出error级别的日志 -->

73.         <filter class="ch.qos.logback.classic.filter.LevelFilter">

74.             <level>ERROR</level>

75.             <OnMismatch>DENY</OnMismatch>

76.             <OnMatch>ACCEPT</OnMatch>

77.         </filter>

78.         <!--日志文件路径，日志文件名称-->

79.         <File>${LOG_HOME}/err_${LOG_PREFIX}.log</File>

80. 

81.         <!-- 设置滚动策略，当天的日志大小超过 ${MAX_FILE_SIZE} 文件大小时候，新的内容写入新的文件， 默认10MB -->

82.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

83. 

84.             <!--日志文件路径，新的 ERR 日志文件名称，“ i ” 是个变量 -->

85.             <FileNamePattern>${LOG_DIR}/err_${LOG_PREFIX}%i.log</FileNamePattern>

86. 

87.             <!-- 配置日志的滚动时间 ，表示只保留最近 10 天的日志-->

88.             <MaxHistory>${MAX_HISTORY}</MaxHistory>

89. 

90.             <!--当天的日志大小超过 ${MAX_FILE_SIZE} 文件大小时候，新的内容写入新的文件， 默认10MB-->

91.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

92.                 <maxFileSize>${MAX_FILE_SIZE}</maxFileSize>

93.             </timeBasedFileNamingAndTriggeringPolicy>

94.         </rollingPolicy>

95. 

96.         <!-- 输出的日志内容格式化-->

97.         <layout class="ch.qos.logback.classic.PatternLayout">

98.             <Pattern>${LOG_MSG}</Pattern>

99.         </layout>

100.     </appender>

101. 

102.     <!-- additivity 设为false,则logger内容不附加至root ，配置以配置包下的所有类的日志的打印，级别是 ERROR-->

103. 

104.     <logger name="org.springframework"     level="ERROR" />

105.     <logger name="org.apache.commons"      level="ERROR" />

106.     <logger name="org.apache.zookeeper"    level="ERROR"  />

107.     <logger name="com.alibaba.dubbo.monitor" level="ERROR"/>

108.     <logger name="com.alibaba.dubbo.remoting" level="ERROR" />

109. 

110.     <!-- ${LOG_ROOT_LEVEL} 日志级别 -->

111.     <root level="${LOG_ROOT_LEVEL}">

112. 

113.         <!-- 标识这个"${STDOUT}"将会添加到这个logger -->

114.         <appender-ref ref="${STDOUT}"/>

115. 

116.         <!-- FILE_ALL 日志输出添加到 logger -->

117.         <appender-ref ref="FILE_ALL"/>

118. 

119.         <!-- FILE_ERROR 日志输出添加到 logger -->

120.         <appender-ref ref="FILE_ERROR"/>

121.     </root>

122. 

123. </configuration>

配置文件 ​​application.yml​​

1. server:

2.   port: 8888  # 端口号

3. 

4. logging:

5.   path: ./logs/zuozewei

6.   level:

7.     root: info #日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出

日志会每天新建一个文件夹，日文文件配置的每 50MB，一个文本文件，超过新写入一个

1. 文件夹：20181228

2. 文件夹内容：all_spring-boot-logback0.log 

3. 文件夹内容：all_spring-boot-logback1.log

4. 文件夹内容：all_spring-boot-logback2.log

5. 

6. 文件夹内容：err_spring-boot-logback0.log

多环境日志输出

根据不同环境（prod:生产环境，test:测试环境，dev:开发环境）来定义不同的日志输出，在 logback-spring.xml 中使用 springProfile 节点来定义，方法如下：

文件名称不是 logback.xml，想使用 spring 扩展 profile 支持，要以 logback-spring.xml 命名

1. <!-- 生产环境生效 -->

2.     <springProfile name="prod">

3.         <root level="error">

4.             <appender-ref ref="STDOUT" />

5.             <appender-ref ref="FILE" />

6.         </root>

7.     </springProfile>

8. 

9. 

10.     <!-- 测试和开发环境日志级别为INFO/并且记录日志文件 -->

11.     <springProfile name="dev,test">

12.         <!-- 日志输出级别 -->

13.         <root level="INFO">

14.             <appender-ref ref="STDOUT" />

15.             <appender-ref ref="FILE" />

16.         </root>

17.     </springProfile>

可以启动服务的时候指定 profile （如不指定使用默认），如指定 prod 的方式为：

1. java -jar xxx.jar –spring.profiles.active=prod

单元测试

此处我选择使用 ​​lombok​​效率插件，所以只需要 ​​@Slf4j​​注解即可简化 ​​privateLoggerlogger=LoggerFactory.getLogger(this.getClass())​​的写法

1. RunWith(SpringRunner.class)

2. @SpringBootTest

3. @Slf4j

4. public class LogbackdemoApplicationTests {

5. 

6.     @Test

7.     public void contextLoads() {

8.         log.info("输出info");

9.         log.debug("输出debug");

10.         log.error("输出error");

11.     }

12. 

13. }

生成的日志：

1. - | [] | [20181228 22:53:20.756] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> Starting LogbackdemoApplicationTests on 192.168.1.18 with PID 82507 (started by apple in /Users/apple/Downloads/Springboot-logback-demo)|

2. - | [] | [20181228 22:53:20.762] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> No active profile set, falling back to default profiles: default|

3. - | [] | [20181228 22:53:21.590] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> Started LogbackdemoApplicationTests in 1.69 seconds (JVM running for 3.525)|

4. - | [] | [20181228 22:53:21.955] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> 输出info|

5. - | [] | [20181228 22:53:21.955] | [ERROR] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> 输出error|

工程目录

总结

到此为止终于介绍完 Logback日志框架了，平时使用的时候推荐用自定义 ​​logback-spring.xml​​来配置，代码中使用日志也很简单，类里面添加 ​​privateLoggerlogger=LoggerFactory.getLogger(this.getClass());​​ 即可，如果使用 ​​lombok​​效率插件需要 ​​@Slf4j​​注解。