SpringBoot 项目中设置日记体系文件 logback-spring.xml 原理和用法介绍 ...

在 Spring Boot 项目中，logback-spring.xml 是用于设置日记体系的文件，是基于 Logback 框架，重要有以下几点功能：

  
1、日记输出控制

• 可以指定哪些类或包的日记信息应该被输出，以及输出的日记级别。
  
• 例如，可以将某些关键业务类的日记级别设置为 DEBUG，以便在开辟和测试阶段进行具体的日记记录，方便调试。
  
• 将一些基础类或库的日记级别设置为 INFO 或 WARN，避免日记信息过多造成干扰。
  

1. <logger name="com.example.business" level="DEBUG"/>
2. <logger name="org.springframework" level="INFO"/>

复制代码

这里，com.example.business 包下的日记将以 DEBUG 级别输出，而 org.springframework 包下的日记以 INFO 级别输出。
2、日记格式设置

• 可以自定义日记的输出格式，包括时间戳、日记级别、线程名、类名、日记消息等元素的排列顺序和格式。
  

1. <encoder>
2.         <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
3. </encoder>

复制代码

上述代码利用 %d 表现时间戳，%thread 表现线程名，%-5level 表现日记级别，%logger{36} 表现日记记录器名称，%msg%n 表现日记消息和换行符。
3、日记输出位置

• 可以将日记输出到差异的目的地，常见的有控制台和文件。
  

1. <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
2.         <encoder>
3.                 <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
4.         </encoder>
5. </appender>
7. <appender name="FILE" class="ch.qos.logback.core.FileAppender">
8.         <file>/log/info/info.log</file>
9.         <encoder>
10.                 <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
11.         </encoder>
12. </appender>

复制代码

上述代码中，CONSOLE 是一个将日记输出到控制台的 Appender，利用了前面定义的日记格式；FILE 是一个将日记输出到文件 /log/info/info.log 的 Appender。
4、日记滚动计谋

• 对于输出到文件的日记，可以设置日记滚动计谋，以避免日记文件过大。
  

1. <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
2.         <file>/log/info/info.log</file>
3.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
4.                 <fileNamePattern>/log/info/info-%d{yyyy-MM-dd}.log</fileNamePattern>
5.         </rollingPolicy>
6.         <encoder>
7.                 <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
8.         </encoder>
9. </appender>

复制代码

上述代码利用 TimeBasedRollingPolicy 实现了基于时间的日记滚动，天天会天生一个新的日记文件，文件名为 /log/info/info-%d{yyyy-MM-dd}.log。
5、日记级别调整

• 可以根据差异的情况（如开辟、测试、生产）动态调整日记级别。
  

1. <springProfile name="dev">
2.         <logger name="com.wen" level="DEBUG"/>
3. </springProfile>
5. <springProfile name="prod">
6.         <logger name="com.wen" level="INFO"/>
7. </springProfile>

复制代码

这里利用了 Spring Boot 的 springProfile 特性，在 dev 情况下将 com.wen 包的日记级别设置为 DEBUG，在 prod 情况下设置为 INFO。
6、日记条件过滤

• 可以对日记信息进行过滤，只输出符合特定条件的日记。
  

1. <appender name="FILTERED_CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
2.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
3.                 <level>INFO</level>
4.         </filter>
5.         <encoder>
6.                 <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
7.         </encoder>
8. </appender>

复制代码

上述代码利用 ThresholdFilter 过滤掉级别低于 INFO 的日记，只有 INFO 及以上级别的日记会被输出到控制台。
7、利用注意事项

1、日记文件所带来的优势：

• 机动性：可以根据项目的具体需求，机动设置日记输出，满意差异阶段（开辟、测试、生产）和差异场景下的日记需求。
  
• 性能优化：通过公道设置日记级别和输出目的地，可以避免不必要的日记输出，进步性能。
  
• 可维护性：集中管理日记设置，便于维护和修改，避免在代码中硬编码日记相干的逻辑。
  

2、设置文件的加载顺序：
Spring Boot 在启动时会主动查找并加载 logback-spring.xml 文件，如果找不到，会实验加载 logback.xml 文件。发起利用 logback-spring.xml，由于它支持 Spring 的一些特别设置，如 springProfile，可以根据差异的情况进行差异的日记设置。

• 设置文件中的文件路径必要根据现实情况进行调整，确保日记文件的存储位置具有足够的权限。
  
• 差异的 Appender 可以组合利用，如同时输出到控制台和文件。
  
• 对于复杂的日记设置，可以考虑将差异部门拆分成多个 <appender> 和 <logger>，以便于维护和管理。
  

8、完备示例代码

下面代码是一个项目的完备示例代码，利用了上述的一些情况，可用作常见的 SpringBoot 项目。

1. <?xml version="1.0" encoding="UTF-8"?>
2. <configuration scan="true" scanPeriod="60 seconds" debug="false">
3.         <property name="log.level" value="debug" />
4.         <property name="log.maxHistory" value="30" />
5.         <property name="log.filePath" value="log/project/" />
6.        
7.         <property name="log.pattern"
8.                 value="%d{yyyy-MM-dd HH:mm:ss:SSS} | [%thread] | [%X{request-id}] | %-5level | %class.%M %L | %msg%n" />
10.         <!-- 打印到控制台 -->
11.         <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
12.                 <encoder>
13.                         <pattern>${log.pattern}</pattern>
14.                         <charset>UTF-8</charset>
15.                 </encoder>
16.                 <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
17.                         <level>INFO</level>
18.                 </filter>
19.         </appender>
21.         <!-- INFO -->
22.         <appender name="infoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
23.                 <file>${log.filePath}/info/info.log</file>
24.                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
25.                         <!-- 文件名称 -->
26.                         <fileNamePattern>${log.filePath}/info/info-%d{yyyy-MM-dd}.log
27.                         </fileNamePattern>
28.                         <!-- 文件最大历史数量 -->
29.                         <maxHistory>${log.maxHistory}</maxHistory>
30.                         <!-- 下面这俩可不定义 -->
31.                         <maxFileSize>1GB</maxFileSize>
32.                         <totalSizeCap>128GB</totalSizeCap>
33.                 </rollingPolicy>
34.                 <encoder>
35.                         <pattern>${log.pattern}</pattern>
36.                         <charset>UTF-8</charset>
37.                 </encoder>
38.                 <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
39.                         <level>INFO</level>
40.                 </filter>
41.         </appender>
43.         <!-- DEBUG -->
44.         <appender name="debugAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
45.                 <file>${log.filePath}/debug/debug.log</file>
46.                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
47.                         <fileNamePattern>${log.filePath}/debug/%d{yyyy-MM-dd}.log
48.                         </fileNamePattern>
49.                         <maxHistory>${log.maxHistory}</maxHistory>
50.                         <maxFileSize>1GB</maxFileSize>
51.                         <totalSizeCap>128GB</totalSizeCap>
52.                 </rollingPolicy>
53.                 <encoder>
54.                         <pattern>${log.pattern}</pattern>
55.                         <charset>UTF-8</charset>
56.                 </encoder>
57.                 <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
58.                         <level>DEBUG</level>
59.                 </filter>
60.         </appender>
61.        
62.         <!-- ERROR -->
63.         <appender name="errorAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
64.                 <!-- 文件路径 -->
65.                 <file>${log.filePath}/error/error.log</file>
66.                 <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
67.                         <!-- 文件名称 -->
68.                         <fileNamePattern>${log.filePath}/error/error-%d{yyyy-MM-dd}.log
69.                         </fileNamePattern>
70.                         <!-- 文件最大历史数量 -->
71.                         <maxHistory>${log.maxHistory}</maxHistory>
72.                         <maxFileSize>1GB</maxFileSize>
73.                         <totalSizeCap>128GB</totalSizeCap>
74.                 </rollingPolicy>
75.                 <encoder>
76.                         <pattern>${log.pattern}</pattern>
77.                         <charset>UTF-8</charset>
78.                 </encoder>
79.                 <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
80.                         <level>ERROR</level>
81.                 </filter>
82.         </appender>
84.         <logger name="org.redisson" level="info" additivity="false" />
86.         <root level="INFO">
87.                 <appender-ref ref="consoleAppender" />
88.                 <appender-ref ref="debugAppender" />
89.                 <appender-ref ref="infoAppender" />
90.                 <appender-ref ref="errorAppender" />
91.         </root>
92. </configuration>

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。