使用 Logback.xml 配置文件输出日志信息

官方链接：Chapter 3: Configurationhttps://logback.qos.ch/manual/configuration.html

配置使用 logback 的方式有很多种，而使用配置文件是较为简单的一种方式，下述就是简单描述一个 logback 配置文件基本的配置项：

由于 logback 会自动检索程序的类路径下是否有 logback-test.xml 或 logback.xml 来进行相关配置，因此我们首先需要在类路径下创建一个文件，命名为 logback-test.xml 或 logback.xml。例如：logback-examples/src/main/resources/logback.xml.

在 logback 配置文件中：

该文件首先使用 <configuration> 来组织本配置文件的基本结构，其中可以包含零到多个的 <appender> 标签，零到多个 <logger> 标签，至多一个 <root> 标签：

1）<appender>：配置日志的输出形式。该标签采用两个必需属性：name 和 class。

name：指定 appender 的名称；

class：指定要实例化的 appender 类的完全限定名称。

<appender> 内可以使用多种标签，基本用法如下：

1. 如果是使用文件来输出日志，使用<file>指定日志文件路径

2. 使用 <encoder> 来定义日志格式( 代替了旧版本的 <layout> ，但是新版本中仍然支持<layout> )。内部使用<pattern>定义具体格式( <layout> 也是 )

  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>myApp.log</file>

    <encoder>
      <pattern>%date %level [%thread] %logger{10} [%file:%line] -%kvp- %msg%n</pattern>
    </encoder>
  </appender>

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%kvp %msg%n</pattern>
    </encoder>
  </appender>

2）<root>：日志根配置，也即是除了 <logger> 定义外的日志都使用该标签的配置。

该标签只有一个属性 level：配置日志级别，可选值有：TRACE、DEBUG、INFO、WARN、ERROR、ALL 或 OFF。

其中也可以包含零到多个 <appender-ref> 来引用前面定义的 <appender> ，指定当前该配置的日志需要以哪种 <appender> 来输出。

<configuration>

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -%kvp- %msg%n</pattern>
    </encoder>
  </appender>
  
  <root level="DEBUG">
    <appender-ref ref="STDOUT" />
  </root>

</configuration>

3）<logger>：用来定义特殊的日志配置。例如一个应用程序中所有日志都统一配置，但是存在少数的类或者文件需要特殊配置，就使用该标签来配置。该标签只接受一个必需的 name 属性、一个可选的 level 属性和一个可选的可加性属性( 一般不需要使用 )。

name：指定在哪个类或者文件中使用该配置，也即是作用域；

level：配置日志级别，可选值有：TRACE、DEBUG、INFO、WARN、ERROR、ALL 或 OFF。

<logger> 标签内还可以包含零到多个 <appender-ref> 来引用前面定义的 <appender> ，指定当前该配置的日志需要以哪种 <appender> 来输出。如果是零个，则为继承 <root> 中的定义。

<logger name="com.example.Test1" level="DEBUG" />

<logger name="com.example.Test2" level="DEBUG">
  <appender-ref ref="STDOUT" />
</logger>

示例：定义一个具体滚动日志文件功能的 appender：RollingFileAppender，来收集每天的日志到一个日期命名的日志文件中，并定义日志文件定期进行清理，例如30天：

<configuration>
    <springProperty scope="context" name="logDir" source="logging.file.path"/>
    <springProperty scope="context" name="springAppName" source="spring.application.name"/>

    <appender name="LOGFILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logDir}/server.log</file>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <Pattern>%d{dd-MM-yyyy HH:mm:ss.SSS} [%thread] [${springAppName}, %X{X-B3-TraceId:-}] %-5level %logger{36}.%M - %msg%n</Pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${logDir}/server_%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
            <totalSizeCap>100MB</totalSizeCap>
        </rollingPolicy>
    </appender>

    <root level="info">
        <appender-ref ref="LOGFILE" />
    </root>
</configuration>

file：先将日志文件路径定义为 ${logDir}/server.log

encoder：定义日志输出格式

rollingPolicy ：在标签内部定义滚动策略，具体如下：

1）fileNamePattern：指定滚动的日志文件命名为当天日期，也即是当日期发生变化的时候，就滚动产生一个新的日志文件，因此就是每天都产生一个新的日志文件。此处的工作原理是：先将日志信息输入到 <file> 标签定义的文件中，此处简称为 server.log，等到滚动条件生效( 此处也即是日期发生变化 )，就将 server.log 重命名为 <fileNamePattern> 中定义的命名格式的日志文件( 此处为 server_%d{yyyy-MM-dd}.log )进行存储，然后重新创建一个名为 server.log 的日志文件继续收集新的日志，重复这样的操作。

也即是：每当日期发生变化，即新的一天开始时，就会触发滚动，将旧的日志文件重命名（添加日期前缀），然后，会创建一个新的 server.log 文件来继续收集新的日志信息。

2）maxHistory：指定了保留日志文件的天数，这里设置为 30 天

3）totalSizeCap：定义了所有日志文件的总大小上限，这里设置为 100MB。达到这个大小后，最旧的日志文件将被删除

使用 Logback.xml 配置文件输出日志信息

悦读