logback属性配置记录

参考：logback配置文件—logback.xml详解

1、设置日志文件名称，让程序加载

根据不同的日志系统，按如下规则组织配置文件名，就能被正确加载：

• Logback：logback-spring.xml, logback-spring.groovy, logback.xml,
  logback.groovy
• Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties,
  log4j.xml
• Log4j2：log4j2-spring.xml, log4j2.xml
• JDK (Java Util Logging)：logging.properties

Spring Boot官方推荐优先使用带有-spring的文件名作为日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项。上面是默认的命名规则，并且放在src/main/resources下面即可。如果想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以在application.properties配置文件里面通过logging.config属性指定自定义的名字：

logging.config=classpath:logging-config.xml

---

2、属性介绍

2.1 根节点

包含下面三个属性

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

---

2.2 子节点

用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。

• name: 变量的名称
• value: 的值时变量定义的值

---

2.3 子节点

用来设置上下文名称，每个logger都关联到logger上下文，默认上下文名称为default。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。可以通过%contextName来打印日志上下文名称。

---

2.4 子节点

负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。

1. ch.qos.logback.core.ConsoleAppender类
   作用：把日志输出到控制台，有以下子节点
   ：对日志进行格式化。
   ：字符串System.out(默认)或者System.err

2. ch.qos.logback.classic.encoder.PatternLayoutEncoder类
   作用：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点
   ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
   ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
   ：当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类

   1.class=“ch.qos.logback.core.rolling.TimeBasedRollingPolicy”： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。有以下子节点：
   　　　　 ：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。
   如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；
   如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
   　　　　　:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件时，那些为了归档而创建的目录也会被删除。

   2.class=“ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy”： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。有以下子节点:
   　　　　　:这是活动文件的大小，默认值是10MB。
   　　　　　：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
   　　　　　: 告知 RollingFileAppender 合适激活滚动。

   3.class=“ch.qos.logback.core.rolling.FixedWindowRollingPolicy”：根据固定窗口算法重命名文件的滚动策略。有以下子节点：
   　　　　　:窗口索引最小值
   　　　　　:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
   　　　　　:必须包含“%i”，例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip

3. ch.qos.logback.core.FileAppender类
   作用：把日志添加到文件，有以下子节点
   ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
   ：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
   ：对记录事件进行格式化。
   ：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

---

2.5 子节点

SpringBoot的高级Profile功能。我们可以通过不同环境来定义不同日志的输出，如果我们使用logback-spring.xml，那么springProfile节点来表示配置应用到哪些环境中。

---

2.6 子节点

root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。level用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。可以包含零个或多个元素，使用，表示这个appender将会添加到这个logger。

---

至此一个简单的日志输出已经完成，样例如下

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration>
    <!-- 读取配置文件，没有这段话下面的${}读取不到 -->
    <property resource="application.properties" />
    <!--
    用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。
    定义变量后，可以使“${}”来使用变量。
    -->
    <property name="APP_NAME" value="${spring.application.name}" />
    <!-- spring.application.name是在properties文件配置的当前应用名 -->
    <property name="LOG_HOME" value="/logs/${spring.application.name}"/>
    <!-- 指定控制颜色的类为java类，关键字为mycolor -->
    <conversionRule conversionWord="mycolor" converterClass="com.star.dream.project.web.config.LogColor" />
    <!--
    设置上下文名称 每个logger都关联到logger上下文，
    默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。
    一旦设置，不能修改,可以通过%contextName来打印日志上下文名称。
    -->
    <contextName>${APP_NAME}</contextName>

    <!--
    输出到控制台
    负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。
    -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%contextName表示日志上下文，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %X表示MDC指定key值 :-后表示默认值 %msg：日志消息，%n是换行符-->
            <pattern>%mycolor(%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5p %-32logger{5} [%X{traceId:--}] - %m%n)
            </pattern>
        </encoder>
    </appender>

    <!-- 文件日志， 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日志文件名 -->
        <file>${LOG_HOME}/${spring.application.name}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--修改日志文件输出的文件名，增加日期-->
            <FileNamePattern>${LOG_HOME}/${spring.application.name}.log.%d{yyyy-MM-dd}</FileNamePattern>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%contextName表示日志上下文，thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%contextName] [%-16t] %-5p %-22c{0} %X{trace-id} %X{parent-id} %X{span-id} - %m%n
            </pattern>
        </encoder>
    </appender>

    <!--
    root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。
    level用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。
    默认是DEBUG。可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个logger。
    -->
    <springProfile name="dev,test">
        <root level="INFO">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
        </root>
    </springProfile>
</configuration>

---

自定义日志颜色配置类

public class LogColor extends ForegroundCompositeConverterBase<ILoggingEvent>{
    @Override
    protected String getForegroundColorCode(ILoggingEvent event) {
        Level level = event.getLevel();
        switch(level.toInt()) {
            case Level.ERROR_INT:
                return ANSIConstants.BOLD.concat(ANSIConstants.RED_FG);
            case Level.WARN_INT:
                return ANSIConstants.YELLOW_FG;
            case Level.INFO_INT:
                return ANSIConstants.GREEN_FG;
            case Level.DEBUG_INT:
                return ANSIConstants.BLUE_FG;
            case Level.TRACE_INT:
                return ANSIConstants.DEFAULT_FG;
            default:
                return ANSIConstants.DEFAULT_FG;
        }
    }
}