Springboot入门之集成Logback

Logback是由log4j创始人设计的又一个开源日志组件，可以理解是Log4j的升级版。logback分成三个模块：logback-core、logback- classic和logback-access。logback-core是其它两个模块的基础模块；logback-classic是log4j的一个改良版本，它完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。    

Springboot默认集成了Logback在使用时无需添加其他依赖，只需按需编写自定义Logback配置文件即可。

1.编写配置文件

logback-spring.xml【springboot默认识别】

其他配置文件logback.xml、logback.groovy、logback-spring.groovy

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true">
    <property name="LOG_PATH" value="./log-demo/"/>
    <property name="APP_NAME" value="demo"/>
    <property name="maxFileSize" value="128MB" />
    <property name="maxHistory" value="180" />
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] [%method] %-5level %logger{36} - tid:%X{tid}- uid:%X{uid}- %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${APP_NAME}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/%d{yyyy-MM}/${APP_NAME}-%d{yyyy-MM-dd}-%i.log.gz</fileNamePattern>
            <maxFileSize>128MB</maxFileSize>
            <maxHistory>7</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%method] %-5level %logger{50} - tid:%X{tid}- uid:%X{uid}- %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
    </appender>


    <!-- info日志 appender  -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${LOG_PATH}/${server_name}-info-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的历史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，这里设置为50MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%date{yyyy-MM-dd HH:mm:ss} | %highlight(%-5level) | %boldYellow(%thread) | %boldGreen(%logger) | %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印info日志 -->
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 出错日志 appender  -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${LOG_PATH}/${server_name}-error-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 日志最大的历史 180天 -->
            <maxHistory>${maxHistory}</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，这里设置为50MB -->
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%date{yyyy-MM-dd HH:mm:ss} | %highlight(%-5level) | %boldYellow(%thread) | %boldGreen(%logger) | %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 只打印错误日志 -->
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <root level="INFO">
        <appender-ref ref="INFO" />
        <appender-ref ref="ERROR" />
        <appender-ref ref="FILE"/>
        <appender-ref ref="STDOUT"/>
    </root>
</configuration>

2.配置说明

2.1 configuration

日志配置的根节点。

2.2 contextName(一对一)

configuration的子节点，设置应用名称默认‘default’。

3.property：(一对多)

configuration的子节点，定义变量。
有两个属性，name：变量的名称，value：是变量的值。
在Logger上下文中可以使“${}”来使用变量。

4.appender(一对多) 

configuration的子节点，负责写日志的组件。       
有两个必要属性：name：appender名称。class：指定appender的全限定名。
encode：appender的子节点，负责对日志进行格式化。
pattern：appender的子节点，负责定义义日志的具体输出格式。
charset：appender的子节点，负责设置编码方式。
file：appender的子节点，表示日志文件的位置，如果上级目录不存在会自动创建，没有默认值。
append：appender的子节点，默认true日志追加到文件结尾，false服务重启后清空现存文件。
rollingPolicy：appender的子节点，用来定义滚动策略（常见TimeBasedRollingPolicy）。
        fileNamePattern：rollingPolicy的子节点，负责定义义日志的具体输出格式。
        maxHistory：归档日志文件保留的最大时间
        TimeBasedRollingPolicy：根据时间定义翻转策略，。
        SizeAndTimeBasedRollingPolicy：基于时间和日志文件大小的翻滚策略。
ConsoleAppender 控制日志 FileAppender文件日志        
 

5.logger(一对多)

configuration的子节点，用来设置某一个包或具体某一个类的日志打印级别、指定appender
有两个必要属性name和level
name：指定受此logger约束的某一个包或者具体的某一个类，
level：用来设置打印级别：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF
appender-ref：logger的子节点，标识这个appender将会添加到这个logger。

3.自定义参数TID与UID自动生成

TID用于链路追踪标识一个事务。

UID用于用户身份识别标识用户信息。

import org.slf4j.MDC;
import org.springframework.stereotype.Component;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.UUID;

/**
 * MDC日志自定义实现过滤器
 */
@Component
public class LogMdcFilter implements Filter {
    // TID 链路追踪标识
    private static final String TID = "tid";
    // UID 操作用户标识
    private static final String UID = "uid";

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        try {
            HttpServletRequest httpServletRequest = (HttpServletRequest) request;
            String token = httpServletRequest.getHeader("token");
            MDC.put(TID, UUID.randomUUID().toString());
            MDC.put(UID, token);
            chain.doFilter(request, response);
        } finally {
            MDC.remove(TID);
            MDC.remove(UID);
        }
    }

}