Spring Boot日志框架的搭建

超、凢脫俗 2021-10-14 06:16 533阅读 0赞

今天对学习的springboot的日志搭建做个总结记录。

### 一：日志框架简介 ###

**市面上的日志框架；**  
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…  
这些框架有些是日志框架的抽象（规范），有些是具体的实现：

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

左边选一个门面（抽象层）、右边来选一个实现；  
JCL是spring的底层日志框架，但是很早就不更新了，所以springboot选的是SLF4J，至于实现层logback是在Log4j基础上优化的，springboot选择的是logback  
**日志门面： SLF4J；  
日志实现：Logback；**

### 二：SLF4J日志框架的使用 ###

#### 1.如何在系统中使用slf4j ####

我们在日常开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是遵循统一抽象层的规范调用日志抽象层里面的方法；  
springboot中使用SLF4J很简单，**给系统里面导入slf4j的jar和 logback的实现jar**，调用如下：

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    public class HelloWorld {
    	public static void main(String[] args) {
    		Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    		logger.info("Hello World");
    	}
    }

我们看官网给我们的图例：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70]以上是SLF4J和几种不同日志实现层的搭配时需要导入的jar文件，值得注意的是：每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；我们可以单独写logback.xml来配置我们想要的日志属性。

#### 2.遗留问题 ####

Springboot（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx  
由于不同的框架在实现过程中默认采用的底层日志框架并不相同，这就导致了我们在组合运用这些框架时会有一些冲突。  
所以我们需要**统一日志记录**，即使是别的框架和我一起也要统一使用slf4j进行输出？  
这个问题slf4j官网为我们做了说明，提供了解决方法，如图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 1]如何让系统中所有的日志都统一到slf4j；  
**1、将系统中其他日志框架先排除出去；  
2、用中间包来替换原有的日志框架；  
3、我们导入slf4j其他的实现**

### 三.Spring Boot日志关系 ###

SpringBoot使用它来做日志功能；

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

底层依赖关系  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 2]  
总结：  
1）、SpringBoot底层使用slf4j+logback的方式进行日志记录  
2）、SpringBoot也把其他的日志都替换成了slf4j；  
3）、中间替换包如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 3]  
可以看到这些转换包的类名还是用的需要替换的日志框架相同的类名（目的是让spring等框架仍能找到这些类从而正常初始化），但内部实现已经转化为slf4j的实现了

@SuppressWarnings("rawtypes")
    public abstract class LogFactory {
    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J ="http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
    static LogFactory logFactory = new SLF4JLogFactory(); //这里是new SLF4J的

### 四.日志使用 ###

#### 1.默认配置 ####

SpringBoot默认帮我们配置好了日志；

//记录器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public void contextLoads() {
    	//System.out.println();
    	//日志的级别；
    	//由低到高 trace<debug<info<warn<error
    	//可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效
    	logger.trace("这是trace日志...");
    	logger.debug("这是debug日志...");
    	//SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；root级别
    	logger.info("这是info日志...");
    	logger.warn("这是warn日志...");
    	logger.error("这是error日志...");
    }
    
    日志输出格式：
    %d表示日期时间，
    %thread表示线程名，
    %‐5level：级别从左显示5个字符宽度
    %logger{50} 表示logger名字最长50个字符，否则按照句点分割。
    %msg：日志消息，
    %n是换行符
    %d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n

**SpringBoot修改日志的默认配置**

logging.level.com.atguigu=trace
    #logging.path=
    # 不指定路径在当前项目下生成springboot.log日志
    # 可以指定完整的路径；
    #logging.file=G:/springboot.log
    # 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
    logging.path=/spring/log
    # 在控制台输出的日志的格式
    logging.pattern.console=%d{yyyy‐MM‐dd} [%thread] %‐5level %logger{50} ‐ %msg%n
    # 指定文件中日志输出的格式
    logging.pattern.file=%d{yyyy‐MM‐dd} === [%thread] === %‐5level === %logger{50} ==== %msg%n

<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>

#### 2.指定配置文件 ####

给类路径下放上每个日志框架自己的配置文件即可，文件名已经规定好了；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>JUL (Java Util Logging)</td> 
   <td>logging.properties</td> 
  </tr> 
 </tbody> 
</table>

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

<springProfile name="staging">
    <!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
    可以指定某段配置只在某个环境下生效
    </springProfile>

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

no applicable action for [springProfile]

以上是对springboot的日志底层学习的总结，还有在做日志框架切换的时候需要注意将原来的jar清楚，并导入相关的中间jar，这里就不做详细的说明了。欢迎大家的批评指正！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70]: /images/20211013/4c23d1858de644d0bfef5787262c0baa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 1]: /images/20211013/f3999e9e3a0242c18d78c929b3babe7a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 2]: /images/20211013/f3dd7baef58644e5968097be05f35206.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 3]: /images/20211013/a4478007b89b499a9214a40c98ae47fe.png