Spring Boot 日志

逃离我推掉我的手 2022-01-13 14:52 178阅读 0赞

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][]

> 文章首发于微信公众号《程序员果果》 地址：[https://mp.weixin.qq.com/s/6C9GzwI2m30ju9Rba67k4A][https_mp.weixin.qq.com_s_6C9GzwI2m30ju9Rba67k4A]

## 日志框架 ##

市面上的日志框架： JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j ...

<table> 
 <thead> 
  <tr> 
   <th align="left">日志门面</th> 
   <th align="right">日志实现</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">&lt;del&gt;JUL（Jakarta Commons Logging）&lt;/del&gt; <strong>SLF4j</strong>(Simple Logging Facade for Java) &lt;del&gt; jboss-logging&lt;/del&gt;</td> 
   <td align="right">Log4j JUL(java.util.logging) Log4j2 <strong>Logback</strong></td> 
  </tr> 
 </tbody> 
</table>

划线的是我们开发中不常用的，所以我们首选的日志框架是**SLF4j**，log4j性能问题，所以其作者开发了新的 logback；log4j2是apache开的的日志框架，性能很好，但是现在市面上用它的还比较少，我们若使用可能会出现兼容问题，所以我们开发中一般的选择是：  
日志门面：SLF4j 日志实现：logback SpringBoot：底层是Spring框架，Spring框架默认是用JCL；SpringBoot对其进行了包装，Srping Boot选用 SLF4j和logback。

## SLF4j ##

\#\#\#1、如何在系统中使用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");
    	}
    }

### 2、日志框架适配SLF4j的图解 ###

![f3830a9b25759938d880aa2d935096da122.jpg][]

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

### 3、统一日志框架 ###

#### 1.问题 ####

实际开发中项目可能是整合了很多框架例如 Spring（commons-logging）、Hibernate（jboss-logging）等等  
我们怎么统一使用slf4j进行输出 ？

#### 2.统一日志框架图解 ####

![4dacbde4ac81a58971b26ce6bbcc741b4be.jpg][]

**让系统中所有的日志都统一到slf4j：** 1、将系统中的其他日志框架先排除出去 2、用中间包来替换原有的日志框架 3、我们导入slf4j其他的实现

### 4、SpringBoot日志关系 ###

#### 1.pom.xml ####

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-logging</artifactId>
    </dependency>
    <dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-core</artifactId>
    	<exclusions>
    		<exclusion>
    			<groupId>commons-logging</groupId>
    			<artifactId>commons-logging</artifactId>
    		</exclusion>
    	</exclusions>
    </dependency>

#### 2.底层依赖关系图 ####

![Image 1][]

#### 3.总结 ####

*  SpringBoot底层也是使用slf4j+logback的方式进行日志记录
 *  SpringBoot把其他的日志替换成了slf4j

## 日志的使用 ##

### 1、默认配置 ###

SpringBoot默认帮我配置好了日志.

package com.gf;
    
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringbootLoggingApplicationTests {
    
    	//日志记录器
    	Logger logger = LoggerFactory.getLogger( this.getClass() );
    
    	@Test
    	public void contextLoads() {
    
    		//日志级别（由高到底）：trace < debug < info < warn < error
    		//可以调整输出的日志级别，日志只会在这个级别以后的高级别生效
    		logger.trace( "这是trace日志..." );
    		logger.warn( "这是warn日志..." );
    		logger.debug( "这是error日志..." );
    		//SpringBoot默认给我们使用的是info级别，没有指定级别就使用SpringBoot默认的规定
    		logger.info( "这是error日志..." );
    		logger.warn( "这是error日志..." );
    		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

### 2、修改SpringBoot日志的默认配置 ###

logging.level.com.gf=trace
    
    #logging.path 和 logging.path 是冲突设置 ，两者都设置时只有 logging.path 起作用
    #指定文件名，就在项目下生产springboot.log日志
    #logging.file=springboot.log
    
    # 在当前磁盘路径下创建spring文件夹和里面的log文件夹；使用spring.log 作为默认文件
    logging.path=/Users/huanchu/Documents/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

### 3、logback.xml指定配置 ###

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration scan="true" scanPeriod="10 seconds" debug="false">
        
        <property name="LOG_HOME" value="log" />
        
        <property name="appName" value="springboot-logging"></property>
        
        <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
            
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </layout>
        </appender>
    
        
        <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${LOG_HOME}/${appName}.log</file>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
                
                <MaxHistory>365</MaxHistory>
                
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            </layout>
    
        </appender>
    
        
        
        <logger name="com.gf" level="debug" />
        
        
    
        
        <root level="info">
            <appender-ref ref="stdout" />
            <appender-ref ref="appLogAppender" />
        </root>
    </configuration>

配置文件命名为logback.xml时，直接被日志框架识别。如果我们把文件名更改成**logback-spring.xml**，这样就不会被日志框架直接识别，**这样配置文件就由SpringBoot加载**，就可以使用SpringBoot的一些高级功能:

<springProfile name="staging">
     
    </springProfile>

例如：

<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="test">
       		<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ===== [%thread] ===== %-5level %logger{50} - %msg%n</pattern>
        </springProfile>
        <springProfile name="test">
        	<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
    	</springProfile>
    </layout>

## 关注我 ##

欢迎扫码或微信搜索公众号《程序员果果》关注我，关注有惊喜~ ![4e846e2118f8489ffe1c8946491f4850d5b.jpg][]

转载于:https://my.oschina.net/u/2367201/blog/3054840

[2019_Python_]: https://my.oschina.net/u/2663968/blog/3061697
[hot3.png]: /images/20220113/c6e0e49d3f7d4750a401af517cc197ee.png
[https_mp.weixin.qq.com_s_6C9GzwI2m30ju9Rba67k4A]: https://mp.weixin.qq.com/s/6C9GzwI2m30ju9Rba67k4A
[f3830a9b25759938d880aa2d935096da122.jpg]: /images/20220113/eadc1ce71ce44f7f8589994be3ab4635.png
[4dacbde4ac81a58971b26ce6bbcc741b4be.jpg]: /images/20220113/0fc7fefb82324a008c92e1e0c6cf6081.png
[Image 1]: 
[4e846e2118f8489ffe1c8946491f4850d5b.jpg]: /images/20220113/d6563b7efbdb406e894595a15a076e26.png