SpringBoot系列(六)Logback日志配置

墨蓝 2022-06-03 01:57 554阅读 0赞

## 前言 ##

> Logback是SpringBoot内置的日志处理框架,你会发现spring-boot-starter其中包含了spring-boot-starter-logging，该依赖内容就是 Spring Boot 默认的日志框架 logback。而spring-boot-starter-web包含了spring-boot-starter；需要的可以自己去看下引入spring-boot-starter-web后的项目JAR依赖关系；

## 一、SpringBoot默认Logback配置 ##

在前面的SpringBoot系列中，我并没有主动去配置过任何和日志打印的相关配置，但是控制台却打印了相关的启动日志；

![这里写图片描述][SouthEast]

*  时间日期：精确到毫秒
 *  日志级别：ERROR, WARN, INFO, DEBUG or TRACE
 *  进程ID
 *  分隔符：— 标识实际日志的开始
 *  线程名：方括号括起来（可能会截断控制台输出）
 *  Logger名：通常使用源代码的类名
 *  日志内容

> 我们没有配置任何其它配置，就可以看到来自logback root logger的输出信息。因为SpringBoot为Logback提供了默认的配置文件base.xml，base.xml文件里定义了默认的root输出级别为INFO

<?xml version="1.0" encoding="UTF-8"?>  
      
      
      
    <included>  
        <include resource="org/springframework/boot/logging/logback/defaults.xml" />  
        <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}/}spring.log}"/>  
        <include resource="org/springframework/boot/logging/logback/console-appender.xml" />  
        <include resource="org/springframework/boot/logging/logback/file-appender.xml" />  
        <root level="INFO">  
            <appender-ref ref="CONSOLE" />  
            <appender-ref ref="FILE" />  
        </root>  
    </included>

> Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。  
> 您还可以通过启动您的应用程序 --debug 标志来启用“调试”模式（开发的时候推荐开启）,以下两种方式皆可：

> 在运行命令后加入–debug标志，如：$ java -jar springTest.jar --debug  
> 在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。

--------------------

## 二、使用SpringBoot的配置文件application.properties或application.yml实现简单的日志配置 ##

> 默认情况下，Spring Boot将日志输出到控制台，不会写到日志文件。

> 使用Spring Boot喜欢在application.properties或application.yml配置，这样只能配置简单的场景，保存路径、日志格式等，复杂的场景（区分 info 和 error 的日志、每天产生一个日志文件等）满足不了，只能自定义配置，下面会演示。

为了方便测试，新建以下类测试日志打印：

测试Component

package com.jd.m.tg.log;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    @Component
    public class LogHelper {
    
        private static final Logger LOG= LoggerFactory.getLogger(LogHelper.class);
    
        public void helpLog(){
            LOG.debug("打印DEBUG级别");
            LOG.info("打印INFO级别");
            LOG.warn("打印WARN级别");
            LOG.error("打印ERROR级别");
        }
    
    }

测试Controller：

package com.jd.m.tg.controller;
    
    import com.jd.m.tg.log.LogHelper;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    @RequestMapping("log")
    public class TestLogController {
    
        private static final Logger LOG= LoggerFactory.getLogger(TestLogController.class);
    
        @Autowired
        private LogHelper logHelper;
    
        @ResponseBody
        @RequestMapping(value = "helpLog")
        public void testLog(){
            LOG.info("开始打印日志:INFO");
            logHelper.helpLog();
            LOG.info("结束打印日志INFO");
        }
    }

**级别控制**

所有支持的日志记录系统都可以在Spring环境中设置记录级别（例如在application.properties中）  
格式为：‘logging.level.\* = LEVEL’

logging.level：日志级别控制前缀，\*为包名或Logger名  
LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

举例：

logging.level.com.jd.m.tg.controller.TestLogController=INFO：com.jd.m.tg.controller.TestLogController.class以ERROR级别输出
    
    logging.level.root=INFO：root日志以INFO级别输出

附SpringBoot内置详细日志配置参数说明：

# LOGGING
    //定义logback配置文件位置
    logging.config= # Location of the logging configuration file. For instance `classpath:logback.xml` for Logback
    
    //日志异常时的转换语
    logging.exception-conversion-word=%wEx # Conversion word used when logging exceptions.
    
    //默认的日志文件路径和名称配置
    logging.file= # Log file name. For instance `myapp.log`
    
    //日志级别控制，支持细粒度控制
    logging.level.*= # Log levels severity mapping. For instance 
    `logging.level.org.springframework=DEBUG`
    
    //默认的日志路径配置
    logging.path= # Location of the log file. For instance `/var/log`
    
    //控制台日志的格式，只支持logback
    logging.pattern.console= # Appender pattern for output to the console. Only supported with the default logback setup.
    
    //日志文件中日志的格式，只支持logback
    logging.pattern.file= # Appender pattern for output to the file. Only supported with the default logback setup.
    
    //日志等级的格式渲染，只支持logback
    logging.pattern.level= # Appender pattern for log level (default %5p). Only supported with the default logback setup.
    
    //关掉日志的HOOK，默认false
    logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.

特别说明：

> logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=my.log

> logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：logging.path=/var/log

> 如果只配置 logging.file，会在项目的当前路径下生成一个 xxx.log 日志文件。  
> 如果只配置 logging.path，在 /var/log文件夹生成一个日志文件为 spring.log

> 注：二者不能同时使用，如若同时使用，则只有logging.file生效  
> 默认情况下，日志文件的大小达到10MB时会切分一次，产生新的日志文件，默认级别为：ERROR、WARN、INFO

--------------------

## 三、自定义logback的配置文件 ##

> 前面介绍的是SpringBoot一种简单的logback配置方式，在实际项目生产中，实际日志需求远比这复杂，所以接下来介绍生产中logback日志配置；

## **1、SpringBoot支持自定义logback配置文件的方式** ##

> 根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

> Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy

> Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml

> Log4j2：log4j2-spring.xml, log4j2.xml

> JDK (Java Util Logging)：logging.properties

*  Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项（下面会提到）。

默认的命名规则，并且放在 src/main/resources 下面即可；

> **注：使用application.yml配置多环境变量，使用logback.xml实现日志配置，不能实现多环境配置（即logback配置未生效），打印的日志路径和日志级别不是配置文件中的值。因为logback.xml加载早于application.yml，需改用logback-spring.xml实现日志配置，所以也不希望通过logging.config指定文件位置来实现不同环境的日志打印**

> 如何使用logback-spring.xml实现多环境日志打印，后面会详细讲述，主要为logback对于环境隔离的支持及application.yml中自定义变量获取；

--------------------

## **2、logback-spring.xml配置详细介绍** ##

## **(1)主要结构** ##

**根节点< configuration >包含以下属性：**

> scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。

> scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。

> debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

**注：< configuration >有5个子节点，下面会介绍**

--------------------

**子节点一 :< root >**

> root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。

> level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。

> 默认是DEBUG。

> 可以包含零个或多个元素，标识这个appender将会添加到这个loger。

--------------------

**子节点二：< contextName > 设置上下文名称**

> 每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改,可以通过%contextName来打印日志上下文名称，一般来说我们不用这个属性，可有可无。

<contextName>logback-demo</contextName>
    
    <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>
                    <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
                </pattern>
            </layout>

--------------------

**子节点三： 设置变量**

> 用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“$\{\}”来使用变量。

**注：多环境配置下，通过 application.yml 传递参数过来，< property >取不到环境参数，得用< springProperty >。**

<springProperty scope="context" name="appname" source="logback.appname"/>
        <springProperty scope="context" name="logdir" source="logback.logdir"/>

--------------------

**子节点四：< appender >**

> appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

**控制台输出示例一:**

<?xml version="1.0" encoding="UTF-8"?>
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
    
        <contextName>logback-demo</contextName>
    
        
        <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
            
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%d -1 %msg%n</pattern>
            </layout>
        </appender>
    
        
        <appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>%d -2 %msg%n</pattern>
            </encoder>
        </appender>
    
        
        <root level="INFO">
            
            <appender-ref ref="consoleLog1"/>
            <appender-ref ref="consoleLog2"/>
        </root>
    
    </configuration>

![这里写图片描述][SouthEast 1]

**可以看到layout和encoder，都可以将事件转换为格式化后的日志记录，但是控制台输出使用layout，文件输出使用encoder，具体原因可以看**  
([http://blog.csdn.net/cw\_hello1/article/details/51969554][http_blog.csdn.net_cw_hello1_article_details_51969554])

**appender 下面除了layout和encoder这两个子节点外，还有filter 子节点，下面主要介绍两种filter :**

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    	 <level>ERROR</level>
     </filter>
    
    
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            
            <level>ERROR</level>
            
            <onMatch>DENY</onMatch>
            
            <onMismatch>ACCEPT</onMismatch>
        </filter>

--------------------

**子节点五< loger >**

> **< loger >用来设置某一个包或者具体的某一个类的日志打印级别、以及指定< appender >。< loger >仅有一个name属性，一个可选的level和一个可选的addtivity属性。**

> name:用来指定受此loger约束的某一个包或者具体的某一个类。

> level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。

> addtivity:是否向上级loger传递打印信息。默认是true。

**loger在实际使用的时候有两种情况**

*  第一种：**带有loger的配置，不指定级别，不指定appender**

logback-spring.xml增加 loger 配置如下：

> < logger name=“com.jd.m.tg.controller.TestLogController” />将TestLogController类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“info”；

没有设置addtivity，默认为true，将此loger的打印信息向上级传递；

没有设置appender，此loger本身不打印任何信息。

< root level=“info”>将root的打印级别设置为“info”，指定了名字为“console”的appender。

当执行com.jd.m.tg.controller.TestLogController类的testLog方法时，所以首先执行< logger name=“com.jd.m.tg.controller.TestLogController”/>，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印；

root接到下级传递的信息，交给已经配置好的名为“console”的appender处理，“console” appender 将信息打印到控制台；

*  **第二种：带有多个loger的配置，指定级别，指定appender**

logback-spring.xml增加 loger 配置如下：

> 控制com.jd.m.tg.controller.TestLogController类的日志打印，打印级别为“WARN”;  
> additivity属性为false，表示此loger的打印信息不再向上级传递;  
> 指定了名字为“console”的appender;

> 这时候执行com.jd.m.tg.controller.TestLogController类的login方法时，先执行< logger name=“com.jd.m.tg.controller.TestLogController” level=“WARN” additivity=“false”>,将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理，在控制台中打出日志，不再向上级root传递打印信息。

**注：当然如果你把additivity="false"改成additivity="true"的话，就会打印两次，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。**

**范围有重叠的话，范围小的，有效。**

--------------------

## (2)多环境配置 ##

*  在application.yml的环境分支中，在对应的环境分支下添加需要传递给logback-spring.xml文件的环境变量，**注意这个变量是自定义的不是SpringBoot内置的logback变量，比如在当前分支环境中设置了logging.level.root=error，那么该设置会覆盖logback-spring.xml中对root的设置**；

**更多配置细节就不详细描述了，在完整的配置文件里会解释说明：**

<?xml version="1.0" encoding="UTF-8"?>
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
    
        
        
        <springProperty scope="context" name="logFile" source="logback.file"/>
        <springProperty scope="context" name="domainHost" source="serverSide.domain.host"/>
    
        
        <appender name="COMMON_FILE_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <File>${logFile}/${domainHost}.log</File>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>${logFile}/${domainHost}.%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <maxHistory>30</maxHistory>
                
                <totalSizeCap>1GB</totalSizeCap>
            </rollingPolicy>
            
            <encoder>
                <charset>UTF-8</charset>
                
                <pattern>%d [%thread] %-5level %logger{36} %line - %msg%n</pattern>
            </encoder>
        </appender>
    
        
        <springProfile name="dev">
            
            
            <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
            <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
            <conversionRule conversionWord="wEx"
                            converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
            
            <property name="CONSOLE_LOG_PATTERN"
                      value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />
    
            
            <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
                <layout>
                    <pattern>${CONSOLE_LOG_PATTERN}</pattern>
                </layout>
            </appender>
            
            <logger name="o.a.tomcat.util.scan.StandardJarScanner" level="ERROR" additivity="false">
                <appender-ref ref="CONSOLE"/>
            </logger>
            
            <root level="INFO">
                <appender-ref ref="CONSOLE"/>
            </root>
        </springProfile>
    
        
        <springProfile name="mbeta">
            <logger name="com.jd.m.tg" level="INFO" additivity="false">
                <appender-ref ref="COMMON_FILE_LOG"/>
            </logger>
            <root level="INFO">
                <appender-ref ref="COMMON_FILE_LOG"/>
            </root>
        </springProfile>
    
        
        <springProfile name="prod">
            <logger name="com.jd.m.tg" level="ERROR" additivity="false">
                <appender-ref ref="COMMON_FILE_LOG"/>
            </logger>
            <root level="ERROR">
                <appender-ref ref="COMMON_FILE_LOG"/>
            </root>
        </springProfile>
    
    </configuration>

**注：其实本地开发环境可以不用在logback-spring.xml配置，直接在分支上设置logging.level.root=INFO就行**

## (3)异步打印日志 ##

> **工作原理：**  
> 当Logging Event进入AsyncAppender后，AsyncAppender会调用appender方法，append方法中在将event填入Buffer(这里选用的数据结构为BlockingQueue)中前，会先判断当前buffer的容量以及丢弃日志特性是否开启，当消费能力不如生产能力时，AsyncAppender会超出Buffer容量的Logging  
> Event的级别，进行丢弃，作为消费速度一旦跟不上生产速度，中转buffer的溢出处理的一种方案。AsyncAppender有个线程类Worker，它是一个简单的线程类，是AsyncAppender的后台线程，所要做的工作是：从buffer中取出event交给对应的appender进行后面的日志推送。
> 
> 从上面的描述中可以看出，AsyncAppender并不处理日志，只是将日志缓冲到一个BlockingQueue里面去，并在内部创建一个工作线程从队列头部获取日志，之后将获取的日志循环记录到附加的其他appender上去，从而达到不阻塞主线程的效果。因此AsynAppender仅仅充当事件转发器，必须引用另一个appender来做事。
> 
> 在使用AsyncAppender的时候，有些选项还是要注意的。由于使用了BlockingQueue来缓存日志，因此就会出现队列满的情况。正如上面原理中所说的，在这种情况下，AsyncAppender会做出一些处理：默认情况下，如果队列80%已满，AsyncAppender将丢弃TRACE、DEBUG和INFO级别的event，从这点就可以看出，该策略有一个惊人的对event丢失的代价性能的影响。另外其他的一些选项信息，也会对性能产生影响，下面列出常用的几个属性配置信息：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>queueSize</td> 
   <td>int</td> 
   <td>BlockingQueue的最大容量，默认情况下，大小为256。</td> 
  </tr> 
  <tr> 
   <td>discardingThreshold</td> 
   <td>int</td> 
   <td>默认情况下，当BlockingQueue还有20%容量，他将丢弃TRACE、DEBUG和INFO级别的event，只保留WARN和ERROR级别的event。为了保持所有的events，设置该值为0。</td> 
  </tr> 
  <tr> 
   <td>includeCallerData</td> 
   <td>boolean</td> 
   <td>提取调用者数据的代价是相当昂贵的。为了提升性能，默认情况下，当event被加入到queue时，event关联的调用者数据不会被提取。默认情况下，只有"cheap"的数据，如线程名。</td> 
  </tr> 
 </tbody> 
</table>

示例:

参考文件：  
([http://blog.csdn.net/inke88/article/details/75007649\#默认日志-logback][http_blog.csdn.net_inke88_article_details_75007649_-logback])  
([http://blog.csdn.net/cw\_hello1/article/details/51969554][http_blog.csdn.net_cw_hello1_article_details_51969554])  
([http://blog.csdn.net/vitech/article/details/53812137][http_blog.csdn.net_vitech_article_details_53812137])  
([http://blog.csdn.net/sun\_t89/article/details/52130839][http_blog.csdn.net_sun_t89_article_details_52130839])  
[控制台彩色日志输出][Link 1]

特别转载一篇比较好的https://blog.csdn.net/quincuntial/article/details/54292917

[SouthEast]: /images/20220603/3e549e9bf6b74bf48c621126300efa44.png
[SouthEast 1]: /images/20220603/ef93f67825474feb9d81e91ab81e863c.png
[http_blog.csdn.net_cw_hello1_article_details_51969554]: http://blog.csdn.net/cw_hello1/article/details/51969554
[http_blog.csdn.net_inke88_article_details_75007649_-logback]: http://blog.csdn.net/inke88/article/details/75007649#%E9%BB%98%E8%AE%A4%E6%97%A5%E5%BF%97-logback
[http_blog.csdn.net_vitech_article_details_53812137]: http://blog.csdn.net/vitech/article/details/53812137
[http_blog.csdn.net_sun_t89_article_details_52130839]: http://blog.csdn.net/sun_t89/article/details/52130839
[Link 1]: http://blog.csdn.net/lipangeng/article/details/52104754