SpringBoot系列八：日志框架

悠悠 2022-01-21 08:43 350阅读 0赞

日志框架是用来记录系统的一些运行时信息。日志框架像JDBC与数据库驱动之间的关系一样，也有一个日志门面 （日志的抽象层）和日志的实现层。SLF4j、Log4j 和 Logback 出自一人，Logback 是 Log4j 的升级版本。log4j2 是 Apache 推出的一个优秀的日志框架，但好多框架都还没有适配起来。![在这里插入图片描述][20190609123731390.png]  
SpringBoot选用 SLF4j（日志的抽象层）和logback（日志实现）作为默认的日志框架。

一、SLF4j使用  
官方文档：[https://www.slf4j.org][https_www.slf4j.org]  
导入slf4j 和 logback 的依赖。SpringBoot 底层默认已经帮我们引入了这两个依赖，这里不需要在引入。

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_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70]  
每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是使用日志实现框架自己本身的配置文件。  
![在这里插入图片描述][20190609124211768.png]  
二、日志框架统一  
 在实际开发中SpringBoot（slf4j+logback）、 Spring（commons-logging）、Hibernate（jboss-logging）等框架整合时，本身使用的日志框架是不同的，所以我们要统一日志框架，即使是别的框架和我一起统一使用slf4j进行日志记录。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 1]  
将日志都统一到slf4j的步骤：  
 1、将系统中其他日志框架先排除出去；  
 2、用中间包来替换原有的日志框架；  
 3、我们导入slf4j其他的实现。

三、SpringBoot日志关系  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 3]  
总结：  
 1、SpringBoot底层也是使用slf4j+logback的方式进行日志记录；  
 2、SpringBoot也把其他的日志都替换成了slf4j；  
 3、中间替换包：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 4]

@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();
    }

4、如果我们要引入其他框架，一定要把这个框架的默认日志依赖排除掉，避免依赖冲突。如：SpringBoot 底层也是对 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、默认配置  
SpringBoot默认帮我们配置好了日志；

//记录器
    Logger logger = LoggerFactory.getLogger(getClass());
    
    @Test
    public void contextLoads() {
    
    	//日志的级别；
    	//由低到高   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{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

SpringBoot修改日志的默认配置

logging.level.com.atguigu=trace
    
    # 不指定路径在当前项目下生成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

![在这里插入图片描述][20190609115159106.png]  
2、指定配置  
 在类路径下创建每个日志框架自己的配置文件即可；SpringBoot就会使用该配置文件指定的配置，而不使用他默认配置了。  
![在这里插入图片描述][20190609124156776.png]  
 logback.xml：直接就被日志框架识别了；如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误：`no applicable action for [springProfile]`  
 logback-spring.xml：日志框架不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。推荐使用 logback-spring.xml。

logback-spring.xml配置文件：

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration scan="false" scanPeriod="60 seconds" debug="false">
        
        <property name="LOG_HOME" value="/app/log" />
        
        <property name="appName" value="atguigu-springboot"></property>
        
        <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
            
            <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>
    
          
        <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.atguigu" level="debug" />
        
        <logger name="org.springframework" level="debug" additivity="false"></logger>
    
    
    
        
        <root level="info">
            <appender-ref ref="stdout" />
            <appender-ref ref="appLogAppender" />
        </root>
    </configuration>

五、切换日志框架  
 可以按照slf4j的日志适配图，进行相关的切换；  
1、切换为slf4j+log4j

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <exclusions>
        <exclusion>
          <artifactId>logback-classic</artifactId>
          <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
          <artifactId>log4j-over-slf4j</artifactId>
          <groupId>org.slf4j</groupId>
        </exclusion>
      </exclusions>
    </dependency>
    
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
    </dependency>

log4j.properties 配置文件：

### set log levels ###
    log4j.rootLogger = debug ,  stdout ,  D ,  E
    
    ### 输出到控制台 ###
    log4j.appender.stdout = org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.Target = System.out
    log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n
    
    #### 输出到日志文件 ###
    #log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
    #log4j.appender.D.File = logs/log.log
    #log4j.appender.D.Append = true
    #log4j.appender.D.Threshold = DEBUG  ## 输出DEBUG级别以上的日志
    #log4j.appender.D.layout = org.apache.log4j.PatternLayout
    #log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
    
    #### 保存异常信息到单独文件 ###
    #log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
    #log4j.appender.D.File = logs/error.log  ## 异常日志文件名
    #log4j.appender.D.Append = true
    #log4j.appender.D.Threshold = ERROR  ## 只输出ERROR级别以上的日志
    #log4j.appender.D.layout = org.apache.log4j.PatternLayout
    #log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

2、切换为slf4j+log4j2

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

log4j2-spring.xml 配置文件：

<?xml version="1.0" encoding="UTF-8"?>
     
     
     
    <configuration status="WARN" monitorInterval="30">
    
        
        <appenders>
        
        	
            <console name="Console" target="SYSTEM_OUT">
            	
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            </console>
            
        	
    	    <File name="log" fileName="log/test.log" append="false">
    	       <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
    	    </File>
    	    
        	
            <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
                         filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
                        
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
            </RollingFile>
            
            <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                         filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
            	
                <DefaultRolloverStrategy max="20"/>
            </RollingFile>
            
            <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                         filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
                <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
                <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
                <Policies>
                    <TimeBasedTriggeringPolicy/>
                    <SizeBasedTriggeringPolicy size="100 MB"/>
                </Policies>
            </RollingFile>
            
        </appenders>
        
        
        <loggers>
            
            <logger name="org.springframework" level="INFO"></logger>
            <logger name="org.mybatis" level="INFO"></logger>
            <root level="all">
                <appender-ref ref="Console"/>
                <appender-ref ref="RollingFileInfo"/>
                <appender-ref ref="RollingFileWarn"/>
                <appender-ref ref="RollingFileError"/>
            </root>
        </loggers>
        
    </configuration>

[20190609123731390.png]: /images/20220121/0aef2032a9c544c780b6130fbc98f033.png
[https_www.slf4j.org]: https://www.slf4j.org
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70]: /images/20220121/5081ad577cec424c86079a022a1ad75e.png
[20190609124211768.png]: /images/20220121/9b29a37e1cff43fc90a2e8ce757a966e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 1]: /images/20220121/e7e3ead96dab4304ab40cbd052662c0e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 2]: /images/20220121/b568744b4210425eadf788b560714315.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 3]: /images/20220121/2d55469a117d441aa46a10adad56a02c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpemhpcWlhbmcxMjE3_size_16_color_FFFFFF_t_70 4]: /images/20220121/df6282c3153c4cfebf243a545277c60f.png
[20190609115159106.png]: /images/20220121/c1a895b189cd48d09bc8e781eb0e850f.png
[20190609124156776.png]: /images/20220121/844f915e52ff4d64ac9d5e091d685a53.png