- 簡介
Spring boot默認(rèn)采用slf4j + logback 的方式進(jìn)行日志管理,日志系統(tǒng)的設(shè)計(jì)為門面模式,Spring boot采用slf4j作為抽象層,logback作為實(shí)現(xiàn)層,
SLF4J——Simple Logging Facade For Java,它是一個(gè)針對于各類Java日志框架的統(tǒng)一Facade抽象。Java日志框架眾多——常用的有java.util.logging, log4j, logback,commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定義了統(tǒng)一的日志抽象接口,而真正的日志實(shí)現(xiàn)則是在運(yùn)行時(shí)決定的——它提供了各類日志框架的binding。
Logback是log4j框架的作者開發(fā)的新一代日志框架,它效率更高、能夠適應(yīng)諸多的運(yùn)行環(huán)境,同時(shí)天然支持SLF4J。
依賴:
<!-- spring boot starter中默認(rèn)引入了logback -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<version>2.1.3.RELEASE</version>
</dependency>
<!-- 如需單獨(dú)引入,則添加以下依賴 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
<version>2.1.3.RELEASE</version>
</dependency>
- 自定義配置
spring boot 推薦使用logback-spring.xml作為配置文件的名稱,以此方式命名spring boot可以提供特有的配置項(xiàng)
<?xml version="1.0" encoding="UTF-8"?>
<!-- scan屬性為true時(shí),如果配置文件發(fā)生變化會被重新加載 -->
<!-- scanPeriod表示重新加載配置文件的時(shí)間間隔,僅當(dāng)scan為true時(shí)有效,默認(rèn)單位為毫秒 -->
<configuration scan="true" scanPeriod="600 seconds">
<!-- 設(shè)置上下文的名稱 -->
<contextName>data-center-log</contextName>
<!-- 多套環(huán)境配置, 以logback-spring.xml做為配置文件的名稱時(shí)有效 -->
<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>
<!-- 默認(rèn)日志路徑 -->
<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">
<!-- 當(dāng)前文件名 -->
<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>
<!--日志文檔保留天數(shù)-->
<maxHistory>15</maxHistory>
</rollingPolicy>
</appender>
<!-- 異常日志文件記錄 -->
<appender name="EXCEPTION_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 當(dāng)前文件名 -->
<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>
<!--日志文檔保留天數(shù)-->
<maxHistory>15</maxHistory>
</rollingPolicy>
</appender>
<!-- name表示具體配置的某一個(gè)包或者某一個(gè)類,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>
- 自定義logback監(jiān)聽器
監(jiān)控logback生命周期,設(shè)置在啟動時(shí)在logback上下文中加入系統(tǒng)屬性,其他方法可自行實(shí)現(xiàn)
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;
}
}