SpringBoot学习笔记二——日志使用

野性酷女 2021-12-17 13:37 282阅读 0赞

日志工具的出现是为了适应变化的日志记录需求，常用的日志工具有：JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j......

日志类的使用可以通过对抽象类的实现来满足不同日志需求。

通常，日志门面采用slf4j，日志实现采用logback、log4j或获log4j2。

SpringBoot抛弃了Spring使用的传统JCL而选用较新的slf4j和logback组合。

怎么解决各框架使用不同抽象层日志框架的问题呢？

log4j通过狸猫换太子的方法一统日志：[https://www.slf4j.org/images/legacy.png][https_www.slf4j.org_images_legacy.png]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkzMDcwNg_size_16_color_FFFFFF_t_70][]

# SpringBoot日志原理粗谈 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkzMDcwNg_size_16_color_FFFFFF_t_70 1][]

可以看到SpringBoot使用logback作为日志记录工具，将其他类型抽象日志框架进行slf4j的转换。

SpringBoot能自动适配所有的日志，底层使用slf4j和logback的方式记录日志，引入其他框架的时候 ，只需要把这个框架依赖的日志框架移除掉，就不需要做多余的任何配置了。

# SpringBoot使用slf4j #

Logger logger = LoggerFactory.getLogger(getClass());
     logger.trace("trace");
     logger.debug("debug");
     //SpringBoot默认打印info及以上级别（root）
     logger.info("info");
     logger.warn("warn");
     logger.error("error");

上面的日志级别从低到高，默认会记录info、warn、error级别的日志，修改日志级别可以通过添加配置的方式，在properties文件中加入如下配置：

logging.level.com.mlgg=trace

打印com.mlgg包下的所有级别的日志。

## 将日志输出到文件 ##

官方提供的file和path的区别：

<table> 
 <thead> 
  <tr> 
   <th><code>logging.file</code></th> 
   <th><code>logging.path</code></th> 
   <th>Example</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;"> <p><em>(none)</em></p> </td> 
   <td style="vertical-align:top;"> <p><em>(none)</em></p> </td> 
   <td style="vertical-align:top;">&nbsp;</td> 
   <td style="vertical-align:top;"> <p>Console only logging.</p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>Specific file</p> </td> 
   <td style="vertical-align:top;"> <p><em>(none)</em></p> </td> 
   <td style="vertical-align:top;"> <p><code>my.log</code></p> </td> 
   <td style="vertical-align:top;"> <p>Writes to the specified log file. Names can be an exact location or relative to the current directory.</p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p><em>(none)</em></p> </td> 
   <td style="vertical-align:top;"> <p>Specific directory</p> </td> 
   <td style="vertical-align:top;"> <p><code>/var/log</code></p> </td> 
   <td style="vertical-align:top;"> <p>Writes&nbsp;<code>spring.log</code>&nbsp;to the specified directory. Names can be an exact location or relative to the current directory.</p> </td> 
  </tr> 
 </tbody> 
</table>

file将日志输出到当前项目下自定义命名文件中；path采用绝对路径，第一个斜线表示当前磁盘根目录，会在定义的目录中生成spring.log文件记录日志。

## pattern ##

自定义日志模板

logging.pattern.file=...

logging.pattern.console=...

# SpringBoot加载的日志配置文件 #

<table> 
 <thead> 
  <tr> 
   <th>Logging System</th> 
   <th>Customization</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="vertical-align:top;"> <p>Logback</p> </td> 
   <td style="vertical-align:top;"> <p><code>logback-spring.xml</code>,&nbsp;<code>logback-spring.groovy</code>,&nbsp;<code>logback.xml</code>, or&nbsp;<code>logback.groovy</code></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>Log4j2</p> </td> 
   <td style="vertical-align:top;"> <p><code>log4j2-spring.xml</code>&nbsp;or&nbsp;<code>log4j2.xml</code></p> </td> 
  </tr> 
  <tr> 
   <td style="vertical-align:top;"> <p>JDK (Java Util Logging)</p> </td> 
   <td style="vertical-align:top;"> <p><code>logging.properties</code></p> </td> 
  </tr> 
 </tbody> 
</table>

logback.xml配置直接被日志框架识别；而采用logback-spring.xml命名方式不直接被识别，而是交给spring解析日志篇日志，可以使用SpringBoot的Profile功能。<springProfile> ，所以我们推荐使用后者。

# 切换SpringBoot的日志框架 #

比如我们现在使用slf4j-log4j的组合，那么我们首先需要删除log4j-to-slf4j的依赖（可以在依赖书中删除），然后加入slf4j-log4j12的依赖，再加入log4j的配置文件就OK了。但是logback是log4j的升级框架啊~

比如我们想用log4j2框架，那么需要删除logging的starter，改为log4j2的starter。

[https_www.slf4j.org_images_legacy.png]: https://www.slf4j.org/images/legacy.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkzMDcwNg_size_16_color_FFFFFF_t_70]: /images/20211213/e7d3fe3417954fdabddb3780a945b0e8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODkzMDcwNg_size_16_color_FFFFFF_t_70 1]: /images/20211213/4a806033bc874a9bac478c38a2d7e1e1.png