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

文章目录

• 1、SpringBoot日志框架
• 2、logback-spring.xml配置详解
• • 2.1、 一个父标签
  • 2.2、两种属性 contextName和property
  • • 2.2.1、contextName
    • 2.2.2、property
  • 2.3、三个节点 appender、root、logger
  • • 2.3.1 append节点
    • 2.3.2、 root
    • 2.3.3、 logger
  • 2.4 logger和root的关系
  • 2.5 环境配置
• 3、完整的logback-spring.xml配置文件

1、SpringBoot日志框架

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

日志门面 （日志的抽象层）

日志实现

JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging

Log4j JUL（java.util.logging） Log4j2 Logback

SpringBoot选用 SLF4j（日志抽象层）和logback（日志实现）
官方图：

简化的日志调用关系图：

2、logback-spring.xml配置详解

1. SpringBoot 配置文件的加载顺序

    logback.xml—>application.properties—>logback-spring.xml
   

2. 日志级别

    日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出
   

3. logback-spring.xml的配置项

   共有一个父标签、两种属性、三个节点:

     一个父标签：configuration
     两种属性：contextName和property
     三个节点：appender、root、logger
   

2.1、 一个父标签

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

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

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

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"?>
<configuration  scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>
</configuration>


# logback-spring,xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="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上下文时使用。

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <property name="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表示使用的输出策略，常见的有控制台输出策略和文件输出策略。

1. 控制台输出appender

   debug ${CONSOLE_LOG_PATTERN} UTF-8

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

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

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

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


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

未设置颜色和高亮前：

设置颜色和高亮后：

2. 文件输入appender

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

   <!--输出到文件-->
    <!-- 时间滚动输出 level为 DEBUG 日志 -->
    <appender name="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>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
 
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- rollover daily -->