logback--基础--04--配置--appender

logback–基础–04–配置–appender

---

代码位置

https://gitee.com/DanShenGuiZu/learnDemo/tree/master/logback-learn

1、根节点< configuration>的子节点< appender>

1. 是< configuration>的子节点，是写日志的组件。
2. 有两个必要属性name和class。
   1. name指定appender名称
   2. class指定appender的全限定名。
3. appender的类型
   1. SocketAppender(不常用)
   2. SMTPAppender(不常用)
   3. DBAppender(不常用)
   4. SyslogAppender(不常用)
   5. SiftingAppender(不常用)
   6. ConsoleAppender(常用)
   7. FileAppender(常用)
   8. RollingFileAppender(常用)
4. 可以自定义Appender

2、ConsoleAppender(常用)：把日志添加到控制台

2.1、属性

2.1.1、< encoder>

对日志进行格式化。

2.1.2、< target>

1. 字符串 System.out 或者 System.err
2. 默认：System.out

2.2、测试

    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 对日志进行格式化。 -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <!--字符串 System.out 或者 System.err ，默认 System.out-->
        <target>System.err</target>
    </appender>

3、FileAppender(常用)：把日志添加到文件

3.1、属性

3.1.1、< file> 被写入的文件名

1. 可以是相对目录
2. 可以是绝对目录
3. 如果上级目录不存在会自动创建
4. 没有默认值。

3.1.2、< append>

1. 如果是true，日志被追加到文件结尾
2. 如果是false，清空现存文件
3. 默认：true。

3.1.3、< encoder>

对记录事件进行格式化

3.1.4、< prudent>

1. 如果是true
   1. 日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作
   2. 效率低
2. 默认：false。

3.2、测试

   <appender name="limeFileLogger" class="ch.qos.logback.core.FileAppender">
        <file>./logs/log.log</file>
        <append>true</append>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <prudent>false</prudent>
    </appender>

4、RollingFileAppender(常用)：滚动记录文件

1. 滚动记录文件
2. 先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。

4.1、属性

4.1.1、< file>

1. 被写入的文件名
2. 可以是相对目录
3. 可以是绝对目录
4. 如果上级目录不存在会自动创建，没有默认值。

4.1.2、< append>

1. 如果是true，日志被追加到文件结尾
2. 如果是false，清空现存文件
3. 默认：true。

4.1.3、< encoder>

对记录事件进行格式化

4.1.4、< rollingPolicy>

当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。

4.1.5、< triggeringPolicy>

告知 RollingFileAppender 何时激活滚动。

4.1.6、< prudent>

1. 当为true时
   1. 不支持FixedWindowRollingPolicy
   2. 支持TimeBasedRollingPolicy
   3. 有两个限制
      1. 不支持也不允许文件压缩
      2. 不能设置file属性，必须留空。

4.2、< rollingPolicy>

4.2.1、TimeBasedRollingPolicy

1. 常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。
2. < fileNamePattern>
   1. 文件名称格式
   2. 必要节点，包含文件名及"%d"转换符,"%d"是SimpleDateFormat指定的时间格式
   3. RollingFileAppender的file字节点可有可无
      1. 设置file：可以为活动文件和归档文件指定不同位置
         1. 当前日志总是记录到file指定的文件(活动文件)，活动文件的名字不会改变
      2. 没设置file：活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次。
   4. "/“或者”"会被当做目录分隔符。
3. < maxHistory>
   1. 可选节点
   2. 控制保留的归档文件的最大数量，超出数量就删除旧文件。
      1. 假设设置每个月滚动一次，且< maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。
      2. 注意：那些为了归档而创建的目录也会被删除。

4.2.2、FixedWindowRollingPolicy

1. 根据固定窗口算法重命名文件的滚动策略。
2. < minIndex>：窗口索引最小值。
3. < maxIndex>：窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
4. < fileNamePattern >
   1. 归档文件名称格式，必须包含"%i",例如
      1. 假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。
   2. 还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip。

4.3、triggeringPolicy

4.3.1、SizeBasedTriggeringPolicy

1. 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender触发当前活动文件滚动。
2. < maxFileSize>
   1. 活动文件的大小
   2. 默认值：10MB。

4.4、测试1–每天生成一个日志文件，保存30天的日志文件。

  <appender name="limeFileLogger" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--归档文件名称格式-->
            <fileNamePattern>limeFileLogger.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--控制保留的归档文件的最大数量，超出数量就删除旧文件-->
            <maxHistory>30</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="limeFileLogger" />
    </root>

4.5、测试2–按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志

  <appender name="limeFileLogger" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件名称-->
        <file>./logs/limeFileLogger.log</file>

        <!--根据固定窗口算法重命名文件的滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <!--归档文件名称格式-->
            <fileNamePattern>limeFileLogger.%i.log.zip</fileNamePattern>
            <!--窗口索引最小值-->
            <minIndex>1</minIndex>
            <!--窗口索引最大值-->
            <maxIndex>3</maxIndex>
        </rollingPolicy>

        <!--查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender触发当前活动文件滚动-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <!--活动文件的大小-->
            <maxFileSize>20MB</maxFileSize>
        </triggeringPolicy>

        <encoder>
            <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
        </encoder>

    </appender>

    <root level="debug">
        <appender-ref ref="limeFileLogger" />
    </root>