Spring boot 默认日志配置

1. 简介

Spring boot默认采用slf4j + logback 的方式进行日志管理，日志系统的设计为门面模式，Spring boot采用slf4j作为抽象层，logback作为实现层，

SLF4J——Simple Logging Facade For Java，它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口，而真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。

Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。

依赖：

<!-- spring boot starter中默认引入了logback -->
<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.1.3.RELEASE</version>
</dependency>
<!-- 如需单独引入，则添加以下依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
    <version>2.1.3.RELEASE</version>
</dependency>

2. 自定义配置

spring boot 推荐使用logback-spring.xml作为配置文件的名称，以此方式命名spring boot可以提供特有的配置项

<?xml version="1.0" encoding="UTF-8"?>
<!-- scan属性为true时，如果配置文件发生变化会被重新加载 -->
<!-- scanPeriod表示重新加载配置文件的时间间隔，仅当scan为true时有效，默认单位为毫秒 -->
<configuration scan="true" scanPeriod="600 seconds">
    <!-- 设置上下文的名称 -->
    <contextName>data-center-log</contextName>
    <!-- 多套环境配置， 以logback-spring.xml做为配置文件的名称时有效 -->
    <springProfile name="dev">
        <property name="name" value="value1"/>
    </springProfile>
    <springProfile name="test">
        <property name="name" value="value2"/>
    </springProfile>
    <springProfile name="pro">
        <property name="name" value="value3"/>
    </springProfile>

    <!-- 默认日志路径 -->
    <property name="LOG_PATH" value="/var/log"/>
    <!-- 无色日志输出格式 -->
    <property name="DEFAULT_PATTERN"
              value="%magenta(%date{yyyy-MM-dd HH:mm:ss.SSS})  %highlight(%-5level) %yellow(---) %green([%15thread]) %cyan(%40.40logger) %yellow(:) %green(%message) %red(%n%exception{full})"/>
    <!-- 彩色日志输出格式 -->
    <property name="DEFAULT_PATTERN_NONE_COLOR"
              value="%date{yyyy-MM-dd HH:mm:ss.SSS}  %-5level --- [%15thread] %40.40logger : %message %n%exception{full}"/>


    <!-- 控制台输出appender -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 控制最低日志输出级别 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <pattern>${DEFAULT_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!-- 文件日志记录 -->
    <appender name="APP_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 当前文件名 -->
        <file>${LOG_PATH}/app.log</file>
        <!-- 输出INFO及以上级别日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <!--日志文档输出格式-->
        <encoder>
            <pattern>${DEFAULT_PATTERN_NONE_COLOR}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--日志记录器的滚动策略、按日期记录-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${LOG_PATH}/app.%d{yyyy-MM-dd}.log</fileNamePattern>
             <!--日志文档保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- 异常日志文件记录 -->
    <appender name="EXCEPTION_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 当前文件名 -->
        <file>${LOG_PATH}/exception.log</file>
        <!-- 只输出ERROR级别日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!--日志文档输出格式-->
        <encoder>
            <pattern>${DEFAULT_PATTERN_NONE_COLOR}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--日志记录器的滚动策略、按日期记录-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${LOG_PATH}/exception.%d{yyyy-MM-dd}.log</fileNamePattern>
             <!--日志文档保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- name表示具体配置的某一个包或者某一个类，additivity表示是否向上级logger打印信息 -->
    <logger name="com.chuangqi.center.web" level="info" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="CONNECT_FILE"/>
        <appender-ref ref="LOGSTASH_EVENT"/>
    </logger>

    <root level="info">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="EXCEPTION_FILE"/>
        <appender-ref ref="APP_FILE"/>
    </root>

</configuration>

3. 自定义logback监听器

监控logback生命周期，设置在启动时在logback上下文中加入系统属性，其他方法可自行实现

package connect.service.config;

import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.spi.LoggerContextListener;
import ch.qos.logback.core.Context;
import ch.qos.logback.core.spi.ContextAwareBase;
import ch.qos.logback.core.spi.LifeCycle;
import com.taobao.api.internal.util.StringUtils;

public class LogBackLifeListener extends ContextAwareBase implements LoggerContextListener, LifeCycle {

    private boolean isStarted = false;
    private static final String LOGSTASH_ADDRESS = "host:port";

    @Override
    public void start() {
        if(isStarted){
            return;
        }
        Context context = super.getContext();
        String profile = System.getProperty("spring.profiles.active");
        if (!StringUtils.isEmpty(profile) && profile.equals("prod")){
            context.putProperty("logback.address", LOGSTASH_ADDRESS);
        }else if (!StringUtils.isEmpty(profile) && profile.equals("test")){
            context.putProperty("logback.address", LOGSTASH_ADDRESS);
        }
        isStarted = true;
    }

    @Override
    public void onStart(LoggerContext context) {
    }

    @Override
    public boolean isResetResistant() {
        return true;
    }

    @Override
    public void onReset(LoggerContext context) {
    }

    @Override
    public void onStop(LoggerContext context) {
    }

    @Override
    public void onLevelChange(Logger logger, Level level) {
    }

    @Override
    public void stop() {
    }

    @Override
    public boolean isStarted() {
        return isStarted;
    }
}