springboot日志详解

心已赠人 2022-12-10 11:24 182阅读 0赞

# 一. 主流日志框架 #

市场上存在非常多的日志框架。 JUL（java.util.logging），JCL（Apache  
Commons Logging），Log4j，Log4j2，Logback、 SLF4j、 jboss-logging等。  
Spring Boot在框架内容部使用JCL，spring-boot-starter-logging采用了  
slf4j+logback的形式，Spring Boot也能自动适配（jul、 log4j2、 logback） 并  
简化配置。

**在写[log4j的两种配置方式（xml和propertiies）][log4j_xml_propertiies]时我就在想“为什么使用log4j时需要导入self4j、log4j和整合jar包”？**

经过一番的周折之后，终于获取到了答案，其实答案很简单，日志分为两类：日志门面和日志实现两种，这两个之间的关系相当于java中接口和实现类的关系，接下来对上面的日志框架做一下简单的分类：

<table> 
 <thead> 
  <tr> 
   <th>日志门面</th> 
   <th>日志实现</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>JCL (Jakarta Common Logging)</td> 
   <td>Log4j</td> 
  </tr> 
  <tr> 
   <td>SLF4J(Simple Logging for Java)</td> 
   <td>JUL(java.util .logging)</td> 
  </tr> 
  <tr> 
   <td>jboss-logging</td> 
   <td>Log4j2</td> 
  </tr> 
  <tr> 
   <td>…</td> 
   <td>Logback …</td> 
  </tr> 
 </tbody> 
</table>

他们之间不是一一对应关系，只是这样写看起来美观点。

# 二、日志的使用 #

*  SpringBoot：底层是Spring框架，Spring框架默认是用JCL
 *  SpringBoot选用SLF4j和logback
 *  以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；给系统里面导入slf4j的jar和logback的实现jar

public class HelloWorld { 
      Logger logger = LoggerFactory.getLogger(HelloWorld.class);  
    }

## 1、jar包的引入 ##

从上面可知，导入日志需要在上面表中选择一个日志门面和一个日志实现。下面以Slf4j为例展示其对应关系如下：  
![image][]

**这里又有一个问题，springboot默认使用SLF4j和logback，底层spring默认使用JCL，然后如果导入了Hibernate（jboss-logging），如何使别的框架和我一起统一使用slf4j进行输出？**

查看Slf4j的官方文档时，确实有解决方法，如下：

![image][image 1]  
其解决思路如下：

*  将系统中其他日志框架先排除出去；
 *  用中间包来替换原有的日志框架；
 *  我们导入slf4j其他的实现

### springboot中的日志关系 ###

<dependency>
        <groupId>org.springframework.boot</groupId>
         <artifactId>spring‐boot‐starter</artifactId>
    </dependency>

![image][image 2]

**总结：**

*  SpringBoot底层也是使用slf4j+logback的方式进行日志记录
 *  SpringBoot也把其他的日志都替换成了slf4j；
 *  中间替换包如：log4j-to-slf4j.jar…

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring‐core</artifactId>
        <exclusions>
            <exclusion>
                <groupId>commons‐logging</groupId>
                <artifactId>commons‐logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

springboot的处理方法和上面的图解如出一辙，先把其它都转换为Slf4j,支持多种日志实现。springboot2.1.6.RELEASE默认导入了Slf4j、logback和log4j,因此你不需要导入日志的相关jar包就可以使用日志的功能！

## 2、配置文件的编写 ##

*  每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文  
    件；
 *  log4j的配置文件请参考：  
    https://javacfox.github.io/2019/06/28/Log4j%E6%97%A5%E5%BF%97%E9%85%8D%E7%BD%AE/
 *  logback的配置文件请参考：

#指定日志配置文件路径
    # logging.config=classpath:/logback-spring.xml
    
    # 日志文件存放路径
    #logging.path=/spring/log
    
    
    # 指定日志文件名
    # logging.file=my.log
    
    # 历史日志文件的最大保存量
    # logging.file.max-history=100000
    
    # 指定日志打印级别,可以配置多个
    #logging.level.com.hiberate.orcal_and_hiberate=debug
    ##
    ### 日志文件最大空间
    ##logging.file.max-size=10M
    
    # 日志输出格式：
    # %d表示日期时间，
    # %thread表示线程名，
    # %‐5level：级别从左显示5个字符宽度
    # %logger{50}表示logger名字最长50个字符，否则按照句点分割。
    # %msg：日志消息，
    # %n是换行符
    
    # 日志控制台打印格式
    #logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level%logger{50}-%msg%n
    #
    ## 日志输出的时间格式
    #logging.pattern.dateformat=%d{yyyy-MM-dd HH:mm:ss.SSS}
    #
    ## 日志输出到文件中的格式
    #logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS}[%thread]%-5level%logger{50}-%msg%n
    #
    ## 在输出日志中添加输出级别
    #logging.pattern.level=%5p
    #
    #logging.exception-conversion-word=%wEx

[log4j_xml_propertiies]: https://javacfox.github.io/2019/06/28/Log4j%E6%97%A5%E5%BF%97%E9%85%8D%E7%BD%AE/
[image]: /images/20221123/c89f3fb6e46048cdb32d2e4c6b4f86c5.png
[image 1]: /images/20221123/43f4037142bd4846836333b564515e32.png
[image 2]: /images/20221123/936b442da5104a7fae1033ed5459f439.png