文章使用版本為 Spring Boot 2.1.x
前言
對(duì)于任何項(xiàng)目來說三娩，打印日志都是必不可少的庵芭，日志的框架很多，這里我們要學(xué)習(xí)的就是非常流行的 logback雀监，logback同時(shí)也是spring boot默認(rèn)使用的日志框架双吆。在spring boot中有兩種方式配置logback，一是直接在application.yml中配置会前，這種方式可以進(jìn)行簡(jiǎn)單的配置好乐；二是在logback-spring.xml中配置，這種方式功能強(qiáng)大回官，可以進(jìn)行復(fù)雜的配置曹宴。
日志級(jí)別
日志級(jí)別從低到高依次是trace搂橙、debug歉提、info笛坦、warn、error苔巨，當(dāng)我們?cè)O(shè)置了某個(gè)日志打印級(jí)別的時(shí)候版扩，那么級(jí)別比它高的也將被打印，比如日志級(jí)別設(shè)置為info侄泽，那么info礁芦、warn、error的日志都會(huì)被打印悼尾。
在application.yml中配置
新建一個(gè)spring boot項(xiàng)目柿扣，在application.yml中添加一下配置
logging:
level:
org.schhx.springbootlearn: debug #指定日志級(jí)別
pattern:
console: "%d %-5level - %msg%n" #日志輸出格式
添加測(cè)試類
package org.schhx.springbootlearn;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class LogTest {
private final Logger logger = LoggerFactory.getLogger(LogTest.class);
@Test
public void printLog() throws Exception {
logger.trace("msg:{}", "trace");
logger.debug("msg:{}", "debug");
logger.info("msg:{}", "info");
logger.warn("msg:{}", "warn");
logger.error("msg:{}", "error");
}
}
啟動(dòng)測(cè)試類，可以看到結(jié)果如下
2018-01-21 16:30:34,470 DEBUG - msg:debug
2018-01-21 16:30:34,474 INFO - msg:info
2018-01-21 16:30:34,474 WARN - msg:warn
2018-01-21 16:30:34,474 ERROR - msg:error
可以看出日志級(jí)別和輸出格式都是和我們的設(shè)置一致闺魏，這種方式可以做些簡(jiǎn)單的配置未状，但是做復(fù)雜的配置就顯得有些心有余而力不足。
在logback-spring.xml中配置
logback-spring.xml其實(shí)就是一個(gè)普通的logback的配置文件析桥，只不過這個(gè)文件會(huì)被spring boot自動(dòng)加載司草。關(guān)于logback的常用配置，本篇文章不會(huì)過多討論泡仗，如果不太熟悉可以參考 logback常用配置埋虹。
另外spring boot允許我們通過<springProperty>標(biāo)簽把a(bǔ)pplication.yml中的配置引用到logback-spring.xml。例如娩怎，我們?cè)赼pplication.yml中配置
logging:
pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%file:%line] - %msg%n"
然后可以在logback-spring.xml使用
<springProperty name="LOG_PATTERN" source="logging.pattern"
defaultValue="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%file:%line] - %msg%n"/>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${LOG_PATTERN}</pattern>
<charset>utf8</charset>
</encoder>
</appender>
spring boot已經(jīng)內(nèi)置了一些引用我們可以直接使用搔课，例如logging.path對(duì)應(yīng)LOG_PATH，完整文檔請(qǐng)參考Spring Boot官方文檔峦树。
多環(huán)境配置
一般情況下辣辫，我們想在本機(jī)測(cè)試時(shí)，把日志打印到控制臺(tái)魁巩；而在服務(wù)器上運(yùn)行時(shí)急灭，把日志打印到文件。想實(shí)現(xiàn)這種功能我們可以使用<springProfile>標(biāo)簽谷遂，例如
<springProfile name="default">
<root level="info">
<appender-ref ref="console"/>
</root>
<logger name="org.schhx.springbootlearn" level="debug"/>
</springProfile>
<springProfile name="dev,test,prod">
<root level="info">
<appender-ref ref="file-error"/>
<appender-ref ref="file-info"/>
</root>
</springProfile>
完整配置
下面是總結(jié)上述所說葬馋，給出一個(gè)完整的logback-spring.xml配置。
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<springProperty name="LOG_PATTERN" source="logging.pattern"
defaultValue="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%file:%line] - %msg%n"/>
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<charset>UTF-8</charset>
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
<appender name="file-error" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_PATH:-.}/error.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<charset>UTF-8</charset>
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
<appender name="file-info" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>DENY</onMatch>
<onMismatch>ACCEPT</onMismatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<FileNamePattern>${LOG_PATH:-.}/info.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<charset>UTF-8</charset>
<pattern>${LOG_PATTERN}</pattern>
</encoder>
</appender>
<springProfile name="default">
<root level="info">
<appender-ref ref="console"/>
</root>
<logger name="org.schhx.springbootlearn" level="debug"/>
</springProfile>
<springProfile name="dev,test,prod">
<root level="info">
<appender-ref ref="file-error"/>
<appender-ref ref="file-info"/>
</root>
</springProfile>
</configuration>
