SpringBoot 日志框架的使用

傷城~ 2022-01-08 01:45 316阅读 0赞

**一、日志框架**  
 市面上的日志框架:JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

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

我们在使用的时候，左边选择一个门面，右边来选择一个实现：  
  日志门面：SLF4J  
  日志实现：Logback  
SpringBoot：底层是Spring框架，Spring框架默认是用JCL。  
 SpringBoot选用 SLF4j和logback；  
**二、SLF4j使用**  
  如何使用可以参考官方文档：[https://www.slf4j.org/manual.html][https_www.slf4j.org_manual.html] 此处有流程图，可以帮我我们理解和使用  
**1.开发中使用**  
  开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；  
   给系统里面导入slf4j的jar和 logback的实现jar  
**2.历史遗留问题：** 各个框架中都有自己的日志包  
   slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx  
   统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出？  
**3.解决方案**：让系统中所有的日志都统一到slf4j  
   将系统中其他日志框架先排除出去；  
   用中间包来替换原有的日志框架；  
   我们导入slf4j其他的实现  
**三、SpringBoot日志关系**  
   SpringBoot使用它来做日志功能；  
      < dependency>  
         < groupId>org.springframework.boot< /groupId>  
         < artifactId>spring‐boot‐starter‐logging< /artifactId>  
      < /dependency>  
 底层依赖关系  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM4MDY4ODEy_size_16_color_FFFFFF_t_70]  
根据图可以总结出：  
1）、SpringBoot底层也是使用slf4j+logback的方式进行日志记录  
2）、SpringBoot也把其他的日志都替换成了slf4j；  
3）、中间替换包；  
4）、如果我们要引入其他框架？一定要把这个框架的默认日志依赖移除掉  
   如：Spring框架用的是commons-logging；  
  < dependency>  
    < groupId>org.springframework< /groupId>  
    < artifactId>spring‐core< /artifactId>  
    < exclusions>  
      < exclusion>  
        < groupId>commons‐logging< /groupId>  
        < artifactId>commons‐logging< /artifactId>  
      < /exclusion>  
    < /exclusions>  
  < /dependency>  
SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；  
**四、日志的使用**  
**1.默认配置**

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootLoggingApplicationTests { 
    	Logger logger = LoggerFactory.getLogger(this.getClass());
    	@Test
    	public void contextLoads() { 
    		// 日志的级别
    		logger.trace("这是trace日志。。。。");
    		logger.info("这是info日志。。。。。。");
    		logger.debug("这是debug日志。。。。");
    		logger.error("这是error日志。。。。。");
    		logger.warn("这是warn日志。。。。。。");
    	}
    }
    日志输出格式：
      %d表示日期时间，
      %thread表示线程名，
      %‐5level：级别从左显示5个字符宽度
      %logger{ 50} 表示logger名字最长50个字符，否则按照句点分割。
      %msg：日志消息，
      %n是换行符
    ‐‐>%d{ yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{ 50} ‐ %msg

**2.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.pat</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>

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

<table> 
 <thead> 
  <tr> 
   <th>Logging Syste</th> 
   <th>Customization</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Logback</td> 
   <td><font>logback-spring.xml <font>, logback-spring.groovy , logback.xml orlogback.groovy</font></font></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>

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

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

如在spring-logback.xml中

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
      <!‐‐ 日志输出格式： %d表示日期时间， %thread表示线程名， %‐5level：级别从左显示5个字符宽度 %logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg：日志消息， %n是换行符 ‐‐>
     <layout class="ch.qos.logback.classic.PatternLayout">
        <springProfile name="dev">
           <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level%logger{50} ‐          %msg%n</pattern>
         </springProfile>
         <springProfile name="!dev">
            <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level%logger{50} ‐ %msg%n</pattern>
          </springProfile>
     </layout>
    </appender>

**4.切换日志框架**:  
  切换log4j框架：需要排除logback‐classic和log4j‐over‐slf4j，添加slf4j‐log4j12即可

[https_www.slf4j.org_manual.html]: https://www.slf4j.org/manual.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM4MDY4ODEy_size_16_color_FFFFFF_t_70]: /images/20211220/f769dc6167ec439cacdfd24c713979a3.png