SpringBoot的日志框架

比眉伴天荒 2022-04-25 02:14 338阅读 0赞

Spring Boot的日志框架：

## 简介 ##

在项目的开发中，日志是必不可少的一个记录事件的组件，所以也会相应的在项目中实现和构建我们所需要的日志框架。

而市面上常见的日志框架有很多，比如：JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等，我们该如何选择呢？

通常情况下，日志是由一个抽象层+实现层的组合来搭建的。

<table> 
 <thead> 
 <tr> 
 <th>日志门面 （日志的抽象层）</th> 
 <th>日志实现</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging</td> 
 <td>Log4j JUL（java.util.logging） Log4j2 Logback</td> 
 </tr> 
 </tbody> 
</table>

SpringBoot：底层是Spring框架，Spring框架默认是用JCL；

SpringBoot选用 SLF4j和logback；

## SLF4j使用 ##

使用SLF4j [https://www.slf4j.org][https_www.slf4j.org]

在开法过程中,日志记录方法的调用不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 </pre></td> 
 <td><pre>@Test public static void main(String[] args) {
 Logger logger = LoggerFactory.getLogger(HelloWorld.class); logger.info("Hello World"); } </pre></td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 </pre></td> 
 <td><pre>20:33:41.673 [main] INFO com.hph.springboot.HelloWorld - Hello World </pre></td> 
 </tr> 
 </tbody> 
</table>

![AwTUds.png][]

每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；

## 遗留问题 ##

a（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、其他框架

统一日志记录，即使是别的框架和如何和我一起统一使用slf4j进行输出呢?

![AwTbeH.png][]

**如何让系统中所有的日志都统一到slf4j；**

**将系统中其他日志框架先排除出去。**

**用中间包来替换原有的日志框架。**

**我们导入slf4j其他的实现。**

## 日志关系 ##

引入springboot-logging

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 </pre></td> 
 <td><pre>&lt;dependency&gt; 	&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; 	&lt;artifactId&gt;spring-boot-starter-logging&lt;/artifactId&gt; &lt;/dependency&gt; </pre></td> 
 </tr> 
 </tbody> 
</table>

### 引入maven以来后 ###

![Aw7H3V.png][]

由上图我们可以知道在SpringBoot底层也是使用slf4j+logback的方式进行日志记录、SpringBoot也把其他的日志都替换成了slf4j；在者中间发生了什么呢？

原来是包被替换掉了

![AwHeUA.png][]

如果我们要引入其他框架？一定要把这个框架的默认日志依赖移除掉，Spring框架用的是commons-logging；

SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 </pre></td> 
 <td><pre>2019-03-28 21:15:40.771 INFO 6056 --- [ main] c.h.s.SpringBootLoggingApplicationTests : 这是info日志... 2019-03-28 21:15:40.771 WARN 6056 --- [ main] c.h.s.SpringBootLoggingApplicationTests : 这是warn日志... 2019-03-28 21:15:40.772 ERROR 6056 --- [ main] c.h.s.SpringBootLoggingApplicationTests : 这是error日志... </pre></td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <thead> 
 <tr> 
 <th>logging.file</th> 
 <th>logging.path</th> 
 <th>Example</th> 
 <th>Description</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>(none)</td> 
 <td>(none)</td> 
 <td></td> 
 <td>只在控制台输出</td> 
 </tr> 
 <tr> 
 <td>指定文件名</td> 
 <td>(none)</td> 
 <td>my.log</td> 
 <td>输出日志到my.log文件</td> 
 </tr> 
 <tr> 
 <td>(none)</td> 
 <td>指定目录</td> 
 <td>/var/log</td> 
 <td>输出到指定目录的 spring.log 文件中</td> 
 </tr> 
 </tbody> 
</table>

给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就不使用他默认配置的了

<table> 
 <thead> 
 <tr> 
 <th>Logging System</th> 
 <th>Customization</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td>Logback</td> 
 <td>logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy</td> 
 </tr> 
 <tr> 
 <td>Log4j2</td> 
 <td>log4j2-spring.xml or log4j2.xml</td> 
 </tr> 
 <tr> 
 <td>JDK (Java Util Logging)</td> 
 <td>logging.properties</td> 
 </tr> 
 </tbody> 
</table>

### 输出格式 ###

### 配置格式 ###

控制台

![Awq79I.png][]

文件

![AwqOu8.png][]

logback.xml：直接就被日志框架识别了；

### 指定配置 ###

**logback-spring.xml**：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 </pre></td> 
 <td><pre>&lt;springProfile name="staging"&gt; &lt;!-- configuration to be enabled when the "staging" profile is active --&gt; 	可以指定某段配置只在某个环境下生效 &lt;/springProfile&gt; </pre></td> 
 </tr> 
 </tbody> 
</table>

如：

如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误

`no applicable action for [springProfile]`因此我们可以把logback.xml重命名为logback-spring.xml

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 </pre></td> 
 <td><pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;!-- scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。 debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 --&gt; &lt;configuration scan="false" scanPeriod="60 seconds" debug="false"&gt; &lt;!-- 定义日志的根目录 --&gt; &lt;property name="LOG_HOME" value="D:/log" /&gt; &lt;!-- 定义日志文件名称 --&gt; &lt;property name="appName" value="hph-springboot"&gt;&lt;/property&gt; &lt;!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --&gt; &lt;appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"&gt; &lt;!-- 日志输出格式： %d表示日期时间， %thread表示线程名， %-5level：级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg：日志消息， %n是换行符 --&gt; &lt;layout class="ch.qos.logback.classic.PatternLayout"&gt; &lt;springProfile name="dev"&gt; &lt;pattern&gt;%d{yyyy-MM-dd HH:mm:ss.SSS} ----&gt; [%thread] ---&gt; %-5level %logger{50} - %msg%n&lt;/pattern&gt; &lt;/springProfile&gt; &lt;springProfile name="!dev"&gt; &lt;pattern&gt;%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n&lt;/pattern&gt; &lt;/springProfile&gt; &lt;/layout&gt; &lt;/appender&gt; &lt;!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 --&gt; &lt;appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"&gt; &lt;!-- 指定日志文件的名称 --&gt; &lt;file&gt;${LOG_HOME}/${appName}.log&lt;/file&gt; &lt;!-- 当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名 TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。 --&gt; &lt;rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"&gt; &lt;!-- 滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 %i：当文件大小超过maxFileSize时，按照i进行文件滚动 --&gt; &lt;fileNamePattern&gt;${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log&lt;/fileNamePattern&gt; &lt;!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动， 且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是， 那些为了归档而创建的目录也会被删除。 --&gt; &lt;MaxHistory&gt;365&lt;/MaxHistory&gt; &lt;!-- 当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy --&gt; &lt;timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"&gt; &lt;maxFileSize&gt;100MB&lt;/maxFileSize&gt; &lt;/timeBasedFileNamingAndTriggeringPolicy&gt; &lt;/rollingPolicy&gt; &lt;!-- 日志输出格式： --&gt; &lt;layout class="ch.qos.logback.classic.PatternLayout"&gt; &lt;pattern&gt;%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n&lt;/pattern&gt; &lt;/layout&gt; &lt;/appender&gt; &lt;!-- logger主要用于存放日志对象，也可以定义日志类型、级别 name：表示匹配的logger类型前缀，也就是包的前半部分 level：要记录的日志级别，包括 TRACE &lt; DEBUG &lt; INFO &lt; WARN &lt; ERROR additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出， false：表示只用当前logger的appender-ref，true： 表示当前logger的appender-ref和rootLogger的appender-ref都有效 --&gt; &lt;!-- hibernate logger --&gt; &lt;logger name="com.hph" level="debug" /&gt; &lt;!-- Spring framework logger --&gt; &lt;logger name="org.springframework" level="debug" additivity="false"&gt;&lt;/logger&gt; &lt;!-- root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应， 要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 --&gt; &lt;root level="info"&gt; &lt;appender-ref ref="stdout" /&gt; &lt;appender-ref ref="appLogAppender" /&gt; &lt;/root&gt; &lt;/configuration&gt; </pre></td> 
 </tr> 
 </tbody> 
</table>

![AwONeU.png][]

## 切换日志框架 ##

### 控制台 ###

![AwjC8A.png][]

### 日志 ###

![AwXjHO.png][]

## 切换为log4j2 ##

### 配置 ###

![AwvBWj.png][]

[https_www.slf4j.org]: https://www.slf4j.org
[AwTUds.png]: /images/20220210/8cac62a282e94fed8011f3113bc5e5cc.png
[AwTbeH.png]: /images/20220210/8d84bc917b304db1b7f9e652bc26d922.png
[Aw7H3V.png]: /images/20220210/425c34a9ee274ae7b1d320a084ba75c9.png
[AwHeUA.png]: /images/20220210/8a9ee264b96b42c5b56c525183f12d66.png
[Awq79I.png]: /images/20220210/74544981a613445998357ef3244ca620.png
[AwqOu8.png]: /images/20220210/7ab211cad48e4e0ca0c74ad17c044e69.png
[AwONeU.png]: /images/20220210/f33ed7d3b8f84c6e848ebe517eef76cf.png
[AwjC8A.png]: /images/20220210/20d19fbb75a545269f3bc72bbf300929.png
[AwXjHO.png]: /images/20220210/0bbd37d5317d4720b25cf44e049f1822.png
[AwvBWj.png]: /images/20220210/4af3c8b6acf04dd2a057b153073a21b3.png