logback-spring.xml配置文件标签（超详解）

文章目录

1、SpringBoot日志框架

市面上的日志框架；
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…
日志门面（日志的抽象层）日志实现JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-loggingLog4j JUL（java.util.logging） Log4j2 Logback
SpringBoot选用 SLF4j（日志抽象层）和logback（日志实现）
官方图：

简化的日志调用关系图：

2、logback-spring.xml配置详解

SpringBoot 配置文件的加载顺序 logback.xml—>application.properties—>logback-spring.xml
日志级别 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出
logback-spring.xml的配置项共有一个父标签、两种属性、三个节点: 一个父标签：configuration 两种属性：contextName和property 三个节点：appender、root、logger

2.1、一个父标签

scan 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true
scanPeriod 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

<configurationscan="true"scanPeriod="10 seconds"></configuration>

2.2、两种属性 contextName和property

2.2.1、contextName

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。
如果同时存在logback.xml和logback-spring.xml，或者同时存在logback.xml和自定义的配置文件，则会先加载logback.xml，再根据application配置加载指定配置文件，或加载logback-spring,xml。如果这两个配置文件的contextName不同，就会报错：

# logback.xml
<?xml version="1.0" encoding="UTF-8"?><configurationscan="true"scanPeriod="60 seconds"debug="false"><contextName>logback</contextName></configuration>

# logback-spring,xml
<?xml version="1.0" encoding="UTF-8"?><configurationscan="false"scanPeriod="60 seconds"debug="false"><contextName>logback_demo</contextName></configuration>

# application.properties
logging.config=classpath:logback-spring.xml

ERROR in ch.qos.logback.classic.joran.action.ContextNameAction - Failed to rename context [logback] as [logback_demo] java.lang.IllegalStateException: Context has been already given a name

2.2.2、property

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

<configurationscan="true"scanPeriod="60 seconds"debug="false"><propertyname="APP_Name"value="myAppName"/><contextName>${APP_Name}</contextName></configuration>

2.3、三个节点 appender、root、logger

2.3.1 append节点

appender的意思是追加器，在这里可以理解为一个日志的渲染器（或者说格式化日志输出）。比如渲染console日志为某种格式，渲染文件日志为另一种格式。
appender中有name和class两个属性，有rollingPolicy和encoder两个子节点。
name表示该渲染器的名字，class表示使用的输出策略，常见的有控制台输出策略和文件输出策略。

控制台输出appender

<propertyname="CONSOLE_LOG_PATTERN"value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/><!--输出到控制台--><appendername="CONSOLE"class="ch.qos.logback.core.ConsoleAppender"><!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息--><filterclass="ch.qos.logback.classic.filter.ThresholdFilter"><level>debug</level></filter><encoder><Pattern>${CONSOLE_LOG_PATTERN}</Pattern><!-- 设置字符集 --><charset>UTF-8</charset></encoder></appender>

encoder表示输出格式，具体说明如下：

%d表示时间
%thread表示线程名
%-5level 表示日志级别，允许以五个字符长度输出
%logger{50}表示具体的日志输出者，比如类名，括号内表示长度
%msg表示具体的日志消息，就是logger.info("xxx")中的xxx
%n表示换行

也可以设置日志的颜色和高亮，如下所示：

<propertyname="pattern-color"value="%green(%d{yyyy-MM-dd HH:mm:ss.SSS}) [%thread] %highlight(%-5level) %red(%logger{50}) - %yellow(%msg) %n"/>

<appendername="CONSOLE-WITH-COLOR"class="ch.qos.logback.core.ConsoleAppender"><encoderclass="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><pattern>${pattern-color}</pattern></encoder></appender>

未设置颜色和高亮前：

设置颜色和高亮后：

文件输入appender

文件输出主要包括配置：以指定格式将日志输出到指定文件夹下的文件中，可以配置该文件的名称、最大大小、保存时间等。

<!--输出到文件--><!-- 时间滚动输出 level为 DEBUG 日志 --><appendername="DEBUG_FILE"class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 正在记录的日志文件的路径及文件名 --><!--先将今天的日志保存在这个文件中--><file>${log.path}/log_debug.log</file><!--日志文件输出格式   %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
            %d{HH: mm:ss.SSS}——日志输出时间
            %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
            %-5level——日志级别，并且使用5个字符靠左对齐
            %logger{36}——日志输出者的名字
            %msg——日志消息
            %n——平台的换行符
           --><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern><charset>UTF-8</charset><!-- 设置字符集 --></encoder><!-- 日志记录器的滚动策略，按日期，按大小记录 --><rollingPolicyclass="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy"><!-- rollover daily --><!--如果第二天输出日志,会将当天的日志记录在<file>${log.path}/log_debug.log</file>,然后将昨天的日志归档到下面的文件中--><!--以分钟切分  %d{yyyy-MM-dd_HH-mm}--><fileNamePattern>${log.path}/debug/log-debug-%d{yyyy-MM-dd_HH-mm}.%i.log</fileNamePattern><!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB --><!--单个日志文件最大100M，到了这个值，就会再创建一个日志文件，日志文件的名字最后+1--><maxFileSize>100MB</maxFileSize><!--日志文件保留天数--><maxHistory>30</maxHistory><!--所有的日志文件最大20G，超过就会删除旧的日志--><totalSizeCap>20GB</totalSizeCap></rollingPolicy><!-- 
            此日志文件只记录debug级别的 
            onMatch和onMismatch都有三个属性值，分别为Accept、DENY和NEUTRAL
            onMatch="ACCEPT" 表示匹配该级别及以上
            onMatch="DENY" 表示不匹配该级别及以上
            onMatch="NEUTRAL" 表示该级别及以上的，由下一个filter处理，如果当前是最后一个，则表        示匹配该级别及以上
            onMismatch="ACCEPT" 表示匹配该级别以下
            onMismatch="NEUTRAL" 表示该级别及以下的，由下一个filter处理，如果当前是最后一个，则不匹配该级别以下的
            onMismatch="DENY" 表示不匹配该级别以下的
        --><filterclass="ch.qos.logback.classic.filter.LevelFilter"><level>debug</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender>

2.3.2、 root

root节点实际上是配置启用哪种appender，可以添加多个appender。

<!--root配置必须在appender下边--><!--root节点是对所有appender的管理,添加哪个appender就会打印哪个appender的日志--><!--root节点的level是总的日志级别控制,如果appender的日志级别设定比root的高,会按照appender的日志级别打印日志,--><!--如果appender的日志级别比root的低,会按照root设定的日志级别进行打印日志--><!--也就是说root设定的日志级别是最低限制,如果root设定级别为最高ERROR,那么所有appender只能打印最高级别的日志--><rootlevel="DEBUG"><appender-refref="CONSOLE"/><appender-refref="DEBUG_FILE"/><appender-refref="INFO_FILE"/><appender-refref="WARN_FILE"/><appender-refref="ERROR_FILE"/></root>

2.3.3、 logger

对单个包或类添加配置：

<!--
    name:用来指定受此loger约束的某一个包或者具体的某一个类。
    addtivity:是否向上级loger传递打印信息。默认是true。
--><!-- logback为 com.pikaqiu.logbackdemo 中的包 --><loggername="com.pikaqiu.logbackdemo"level="debug"additivity="false"><appender-refref="CONSOLE"/></logger><!-- logback为 com.pikaqiu.logbackdemo.LogbackdemoApplicationTests 这个类 --><loggername="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests"level="INFO"additivity="true"><appender-refref="STDOUT"/></logger>

2.4 logger和root的关系

root和logger是父子的关系。

logger的appender根据参数additivity决定是否要叠加root的appender，logger的级别是其自身定义的级别，和root的级别没什么关系。

logger对单个包或类添加配置，相当于局部配置，root相当于全局配置

如果logger里面配置了additivity=“false”，就会覆盖root的，只打印一遍；但是additivity=“true”，就会向上层再次传递，不会覆盖，而是打印两遍！

举例说明：
测试方法：

packagecom.pikaiqu.logbackdemo;importorg.junit.jupiter.api.Test;importorg.slf4j.Logger;importorg.slf4j.LoggerFactory;importorg.springframework.boot.test.context.SpringBootTest;@SpringBootTestclassLogbackdemoApplicationTests{privatestaticLogger log =LoggerFactory.getLogger(LogbackdemoApplicationTests.class);@TestvoidlogTest(){
        log.trace("======trace");
        log.debug("======debug");
        log.info("======info");
        log.warn("======warn");
        log.error("======error");}}

只配置root

<?xml version="1.0" encoding="UTF-8"?><configurationscan="false"scanPeriod="60 seconds"debug="false"><contextName>logback_demo</contextName><propertyname="pattern-color"value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/><appendername="STDOUT"class="ch.qos.logback.core.ConsoleAppender"><!-- encoder 默认配置为PatternLayoutEncoder --><encoder><pattern>${pattern-color}}</pattern></encoder></appender><rootlevel="INFO"><appender-refref="STDOUT"/></root></configuration>

=================================输出结果============================================
2022-04-26 15:37:48.441 [main] INFO  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info 
2022-04-26 15:37:48.441 [main] WARN  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn 
2022-04-26 15:37:48.441 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error

)
当执行测试方法时，root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；

配置root和logger，但logger不指定级别，不指定appender

<?xml version="1.0" encoding="UTF-8"?><configurationscan="false"scanPeriod="60 seconds"debug="false"><contextName>logback_demo</contextName><propertyname="pattern-color"value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/><appendername="STDOUT"class="ch.qos.logback.core.ConsoleAppender"><!-- encoder 默认配置为PatternLayoutEncoder --><encoder><pattern>${pattern-color}}</pattern></encoder></appender><loggername="com.pikaiqu.logbackdemo"></logger><rootlevel="INFO"><appender-refref="STDOUT"/></root></configuration>

=================================输出结果============================================
2022-04-26 15:39:09.351 [main] INFO  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info 
2022-04-26 15:39:09.351 [main] WARN  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn 
2022-04-26 15:39:09.351 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error

将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“INFO”；
没有设置addtivity，默认为true，将此loger的打印信息向上级（root）传递；
没有设置appender，此loger本身不打印任何信息。
将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。

当执行测试方法时，因为LogbackDemo 在包com.pikaiqu.logbackdemo中，所以首先执行，将级别为“INFO”及大于“INFO”的日志信息传递给root，本身并不打印；
root接到下级（即）传递的信息，交给已经配置好的名为“STDOUT”的appender处理，“STDOUT”appender将信息打印到控制台；

配置root和多个logger，指定级别，指定appender

<?xml version="1.0" encoding="UTF-8"?><configurationscan="false"scanPeriod="60 seconds"debug="false"><contextName>logback_demo</contextName><propertyname="pattern-color"value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/><appendername="STDOUT"class="ch.qos.logback.core.ConsoleAppender"><!-- encoder 默认配置为PatternLayoutEncoder --><encoder><pattern>${pattern-color}}</pattern></encoder></appender><loggername="com.pikaiqu.logbackdemo"></logger><loggername="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests"level="INFO"additivity="false"><appender-refref="STDOUT"/></logger><rootlevel="INFO"><appender-refref="STDOUT"/></root></configuration>

=================================输出结果============================================
2022-04-26 15:41:08.022 [main] INFO  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info 
2022-04-26 15:41:08.023 [main] WARN  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn 
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error

将控制com.pikaiqu.logbackdemo包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“INFO”；
没有设置addtivity，默认为true，将此loger的打印信息向上级传递；
没有设置appender，此loger本身不打印任何信息。

控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印，打印级别为“INFO”；
additivity属性为false，表示此loger的打印信息不再向上级（即）传递，
使用指定了名字为“STDOUT”的appender。

将root的打印级别设置为“INFO”，指定了名字为“STDOUT”的appender。

当执行测试方法时，先执行，将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理，在控制台中打出日志，不再向该loger的上级传递打印信息；

未接到任何打印信息，当然也不会给它的上级root传递任何打印信息；

如果设置，则结果如下：

<?xml version="1.0" encoding="UTF-8"?><configurationscan="false"scanPeriod="60 seconds"debug="false"><contextName>logback_demo</contextName><propertyname="pattern-color"value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg %n"/><appendername="STDOUT"class="ch.qos.logback.core.ConsoleAppender"><!-- encoder 默认配置为PatternLayoutEncoder --><encoder><pattern>${pattern-color}}</pattern></encoder></appender><loggername="com.pikaiqu.logbackdemo"></logger><loggername="com.pikaiqu.logbackdemo.LogbackdemoApplicationTests"level="INFO"additivity="true"><appender-refref="STDOUT"/></logger><rootlevel="info"><appender-refref="STDOUT"/></root></configuration>

=================================输出结果============================================
2022-04-26 15:41:08.022 [main] INFO  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info 
2022-04-26 15:41:08.022 [main] INFO  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======info 
2022-04-26 15:41:08.023 [main] WARN  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn 
2022-04-26 15:41:08.023 [main] WARN  c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======warn 
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error 
2022-04-26 15:41:08.023 [main] ERROR c.pikaiqu.logbackdemo.LogbackdemoApplicationTests - ======error

控制com.pikaiqu.logbackdemo.LogbackdemoApplicationTests类的日志打印，打印级别为“INFO”；
additivity属性为false，表示此loger的打印信息会向上级（即）传递，
使用指定了名字为“STDOUT”的appender。