logback和slf4j的使用之appender使用

今天药忘吃喽~ 2022-07-21 11:10 945阅读 0赞

一、appender基本知识

1.appender标签是logback配置文件中**重要的组件**之一。在logback配置文件中使用appender标签进行定义。可以包含**0个或多个appender标签**。

2.appender主要作用就是：①控制打印日志的地方、②打印日志的输出格式。

3.appender**语法结构**：

1）**属性**：appender标签中包含**两个强制**需要的**属性**：①name、②class

①name：为这个appender起一个唯一标识的名称。与appender-ref中的值相对应。以引用appender。

②class：一个Appender类实例的完整类名称。

2）appender标签中可以包含**0个或者1个【**layout】标签。0个或者多个【encoder】标签，0个或者多个【filter】标签。

3）除了上面**3个公共标签**之外，还可以包含**任意多个**与appender的class属性**所在的类**中的对应的**属性标签**。准确的说是**setXXX()**的XXX标签。他就是利用了java的反射机制。例如：

<configuration>
      <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>myApp.log</file>
        <encoder>
          <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
        </encoder>
      </appender>
      <root level="debug">
        <appender-ref ref="FILE" />
      </root>
    </configuration>

在ch.qos.logback.core.FIleAppender类中有一个setFile(String file)的方法，所以就可以appender有任意数量的<file>标签

4）下面图片展示了公共结构，注意没有支持的属性标签：![Center][]

5）其中**layout标签**有一个**强制**的属性名称为**class**，他的值为layout类对象实例的完整类名称。与appender标签一样，layout标签可以包含**layout class**对应实例的属性标签（setXXX中的XXX标签）。

如果你的layout标签中class属性的值想为ch.qos.logback.classic.**PatternLayout**类的话，你可以选择不写，因为有默认值会自动填入到class属性值中。

6）**encoder**标签有一个强制的属性名称为**class**，他的值为encoder类对象实例的完整类名称。

如果你的encoder标签中**class**属性的值想为ch.qos.logback.classic.encoder.**PatternLayoutEncoder**的类的话，你可以选择不写，因为有默认值会自动填入到class属相值中。

7）**默认值**图标如下：

![Center 1][]

4.要想记录多个日志信息格式是很简单的，那就定义多个appender标签，然后将他们关联到一个logger上去。例如：

<configuration>
    
      <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>myApp.log</file>
    
        <encoder>
          <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern>
        </encoder>
      </appender>
    
      <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
          <pattern>%msg%n</pattern>
        </encoder>
      </appender>
    
      <root level="debug">
        <appender-ref ref="FILE" />
        <appender-ref ref="STDOUT" />
      </root>
    </configuration>

这个配置文件中定义两个appender标签，名称分别为FILE和STDOUT，其中FILE的appender将日志记录到名字叫myApp.log日志中。这个encoder的实例为PatternLayoutEncoder。其中格式为<pattern>标签中的格式样式。

两个appender标签都是与root元素通过【appender-ref】相关联的。

★★**注意**：每一个appender标签都有自己的encoder，encoder不能被多个appender所共享的。对于layout也是一样的。所以在**logback配置文件**中**没有**任何语法提供让**encoder或者layout**可以被**共享**。

二、appender相关概念：

1.appender的累加（**叠加**）：相关内容请看：logback和slf4j的使用之Logger使用：**activity属性描述**。

2.几个常用appender实例：

2.1.ConsoleAppender：

就想他的名字一样，将日志信息打印到控制台上，更加准确的说：使用System.out或者System.err方式输出。

使用encoder标签设置输出的格式。

主要子标签有：

2.1.1encoder：设置打印日志信息的格式

2.1.2target：【String】设置一System.out还是System.err方式输出。默认值为System.out

2.2.FileAppender:

2.2.1.用于将日志信息输出到文件中。他有一个重要的标签：file标签。用于指定输出日志所在的文件。如果日志不存在就会创建，如果存在，就会以【附加】或者【截断】的方式写入

2.2.2.主要的标签有：

append：【boolean】默认值为【true】。如果为true的话，就会以【附加】的方式写入到文件。

如果值为false。就会截断方式写入。

encoder：设置日志输出的格式信息

file：保存文件的路径。要注意【\\】反斜杠的问题。如果你想要保存到【c:\\temp\\test.log】，你肯定不想解释为【\\t】为一个整体把。正确的做法是使用【c:/temp/test.log】或者【 c:\\\\temp\\\\test.log】两个中的一个。

2.2.3独一无二的文件名称：

在应用开发或者短时间的项目中，一次运行项目都想创建一个新的日志文件信息，使用<timestamp>标签可以很容易实现这个功能

例如：

<configuration>
    
      
      <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
    
      <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        
        <file>log-${bySecond}.txt</file>
        <encoder>
          <pattern>%logger{35} - %msg%n</pattern>
        </encoder>
      </appender>
    
      <root level="DEBUG">
        <appender-ref ref="FILE" />
      </root>
    </configuration>

2.3.RollingFileAppender

从名字我们就可以得出：FileAppender是RollingFileAppender的父类。即RollingFileAppender继承FIleAppender类。**功能**：能够动态的创建一个文件。**也就是说**：到满足一定的条件，就会创建一个新的文件，然后将日志写入到新的文件中。

2.3.1.有两个重要的标签与rolingFileAppender进行交互：

2.3.1.1.RollingPolicy:

2.3.1.2.TriggeringPolicy

**注意**：为了使用RollingFileAppender必须有RollingPolicy和triggerPolicy。但是如果RoolingFileAppender中的RoolingPolicy同时也实现了TriggerPolicy接口的话，那么只要这一个模型就可以了。

2.3.2.RollingFileAppender的标签：

2.3.2.1file：与FileAppender一样。只能是确定的名称，不能改变。

2.3.2.2append：与FileAppender一样，用于附加还是截断

2.3.2.3encoder：设置输出日志的格式，与FIleAppender一样

2.3.2.4rollingPolicy：当转换文件时，他会告诉RollingFileAppender

2.3.2.5triggerPolicy.

2.3.3一个重要的RollingPolicy：（TimeBaseRollingPolicy）

这个TimeBaseRollingPolicy可能是最常用的rolling policy。

他的转换文件名是依赖时间，例如可以设置天，或者月

TimeBaseRollingPolicy实现了RollingPolicy接口，又实现了TriggerPolicy接口。

2.3.3.1TimeBaseRollingPolicy有一个强制的标签和几个可选的标签：

2.3.3.1.1fileNamePattern：这是一个强制的标签。**他的值**可以包含：文件的名称、适当的%d转换说明符。这个%d说明符可以包含一个【日期和时间】的模式。其中【模式】类似于 【SimpleDateFormat】类。如果这个【模式】没有写的话，默认就是【yyyy-MM-dd】的模式。**转换文件的名称**从fileNamePattern中得到

注意：在RollingFileAppender中有一个file标签，也是设置文件的名称的。file可以设置也可以不设置。如果你设置了file标签的话，他就不会转换到新的文件中。所有的日志 信息将会输入到同一个文件中。如果file标签没有设置。文件的名称就会在每一个阶段由filenamePattern计算得出。

其中【日期和时间】格式的形式；【%d\{格式\}】。**注意**：在fileNamePattern中无论是斜杠【/】还是反斜杠【\\】在fileNamePattern的任何位置或者在【日期时间】模式里面都作为文件分隔符。

在fileNamePattern中可以有多个%d的说明符，但是只能有一个主的%d说明付。其他的%d说明符必须使用【aux】说明是从说明符。

2.3.3.1.2maxHistory：这是一个可选的标签。用于控制文件保持的最大时间。异步的删除删除旧的文件。**时间单位**是**月**。如果你设置为6的话，那就是保持文件的时间是6个月。超过6个月的文件将会被删除。

2.3.3.1.3totalSizeCap：这是所有日志文件的总大小空间。当日志文件的空间超过了设置的最大空间数量，就会删除旧的文件。注意：这个标签必须和maxHistory标签一起使用。

2.3.4看看下面的例子

![Center 2][]

2.3.5一个RollingFileAppender的完整例子：

<configuration>
      <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logFile.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">              <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>              <maxHistory>30</maxHistory>       <totalSizeCap>3GB</totalSizeCap>     </rollingPolicy>
    
        <encoder>
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
      </appender> 
    
      <root level="DEBUG">
        <appender-ref ref="FILE" />
      </root>
    </configuration>

[Center]: /images/20220720/53d83992ffa14ecdaabbbc5ad3ff12f4.png
[Center 1]: /images/20220720/3ca39f25b1694c3e8b37664cd9fc9323.png
[Center 2]: /images/20220720/f69a03140b124172bd2a6a73397f702f.png