SpringBoot與日誌

1、日誌框架

​ 一、市面上的日誌框架：JUL、JCL(Apache 基金會的)、Jboss-logging、logback、log4j、log4j2、slf4j....

日誌門面（日誌抽象層）	日誌實現
JCL（Jakarta Commons Logging-屬於Apache基金會） jboss-logging	JUL（java.util.logging-Java JDK自帶的）
SLF4j（Simple Logging Facade for Java）	Log4j 、Log4j2、 Logback

​ 二、其中 SLF4j 與 Log4j 、 Logback 出自同一人之手，Logback 是 Log4j 的升級版；而 Log4j2 只是借用了Log4j 的名號而已

​ 三、SpringBoot 底層是 Spring 框架，而 Spring 框架默認是用 JCL，可是 SpringBoot選用的是 SLF4j 和 logback，因此SpringBoot 的日誌框架重點是學習使用 SLF4j 和 logback。

​ 四、因此爲了開發日誌系統擴展性更好的應用，就得從上表中左右兩邊各選擇一個進行日誌接口和實現進行開發，並且編碼的時候應該調用左邊的接口，而不是右邊的實現，這樣利於未來擴展。

2、SLF4J的使用

1.使用log4做爲實現的demo

<!--日誌-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.25</version>
</dependency>

<!--log4j須要slf4j-log4j12進行適配,slf4j-log4j12同時依賴了log4j，導入slf4j-log4j12便可-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.25</version>
</dependency>

log4j.properties

#指定輸出信息的級別--以及輸出的位置
log4j.rootLogger=DEBUG,console,logFile
#表示Logger不會在父Logger的appender裏輸出，默認爲true
log4j.additivity.org.apache=true

#控制檯
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout.ConversionPattern=%5p [%t] (%c:%L) %d{yyyy-MM-dd HH:mm:ss,SSS} ---- %m%n

#日誌文件
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.txt
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

package com.hucheng.log.log4j;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * @author HuCheng
 */
public class Test {
    public static void main(String[] args) {
        Logger logger = LoggerFactory.getLogger(Test.class);
        logger.info("Hello Slf4j/Log4j");
        logger.error("error print");
    }
}

開發時，日誌記錄方法的調用，不該該直接調用日誌的實現類，而是調用日誌抽象層的方法。每個日誌的實現框架都有本身的配置文件，使用slf4j時，須要使用日誌實現框架的配置文件。

2.slf4j與實現框架圖總覽

圖中，能夠看出：

​ 若是隻導入了slf4j-api.jar日誌門面，則調用日誌記錄的方法無效。

​ 若是導入slf4j-api.jar和日誌實現logback-classic.jar，則調用slf4j以後底層會以logback進行記錄。

​ 若是導入slf4j-api.jar和日誌實現log4j.jar，中間還須要導入一個適配包slf4j-log412.jar，因此當應用中調用SLF4J記錄日誌的時候，會先通過適配包，最後調用實現包。

​ 第4個是jul和log4j類似，一樣須要適配包......

3.統一日誌記錄

如何將系統中的全部日誌都統一到slf4j？

一、將系統中其餘日誌框架先排除出去；

二、用中間包來替換原有的日誌框架；

三、咱們導入slf4j其餘的實現;

3、SpringBoot日誌關係

​ 經過分析spring-boot-starter的底層依賴關係，能夠看出springboot經過依賴spring-boot-starter-logging來作日誌。SpringBoot底層是經過slf4j+logback的方式進行日誌記錄，同時將其餘的日誌都替換成了slf4j。

​ 如何替換呢？

​ 建立的LogFactory其實是用SLF4JLogFactory的實例

@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

    static LogFactory logFactory = new SLF4JLogFactory();

​ SpringBoot能自動適配全部的日誌，並且底層使用slf4j+logback的方式記錄日誌，引入其餘框架的時候，只須要把這個框架依賴的日誌框架排除掉便可。

​ 好比Spring框架使用的是commons-logging，springboot底層使用spring框架須要排除掉commons-logging：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <exclusions>
        <exclusion>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

4、SpringBoot中日誌的使用

1.默認配置

​ SpringBoot默認配置好了日誌

//日誌記錄器
    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    public void contextLoads() {
        //日誌的級別；
        //由低到高   trace<debug<info<warn<error
        //能夠調整輸出的日誌級別；日誌就只會在這個級別以之後的高級別生效
        logger.trace("這是trace日誌...");
        logger.debug("這是debug日誌...");
        //SpringBoot默認給咱們使用的是info級別的，沒有指定級別的就用SpringBoot默認規定的級別；root級別
        logger.info("這是info日誌...");
        logger.warn("這是warn日誌...");
        logger.error("這是error日誌...");
    }

輸出：

2019-11-04 16:35:43.636  INFO 12604 --- [           main] c.h.log.SpringbootLogApplicationTests    : 這是info日誌...
2019-11-04 16:35:43.636  WARN 12604 --- [           main] c.h.log.SpringbootLogApplicationTests    : 這是warn日誌...
2019-11-04 16:35:43.637 ERROR 12604 --- [           main] c.h.log.SpringbootLogApplicationTests    : 這是error日誌...

日誌輸出格式：

%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

注：
    %d表示日期時間，
    %thread表示線程名，
    %-5level：級別從左顯示5個字符寬度
    %logger{50} 表示logger名字最長50個字符，不然按照句點分割。 
    %msg：日誌消息，
    %n是換行符

springboot修改日誌的默認配置

# 修改日誌的級別，默認級別爲info
logging.level.com.atguigu=trace

# 指定完整的路徑
#logging.file=G:/springboot.log

# 僅指定路徑，使用 spring.log 做爲默認文件
logging.path=/spring/log

# 在控制檯輸出的日誌的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日誌輸出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

​ 當配置文件中logging.file和logging.path存在或不存在時（推薦僅使用logging.path）：

logging.file	logging.path	Description
無	無	只在控制檯輸出
有	無	輸出日誌到指定文件中
無	有	輸出到指定目錄的 spring.log 文件中
有	有	至關於logging.file僅存的狀況

2.指定配置

​ 給類路徑下放上每一個日誌框架本身的配置文件便可，就會替代SpringBoot的默認配置，如下是各日誌實現的配置文件默認文件名：

日誌實現	文件名
Logback	logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JUL	logging.properties

​ SpringBoot官方建議使用logback-spring.xml,具體的配置參考logback-spring.xml文件。

​ 當使用logback.xml，應用啓動時會被日誌框架logback識別而使用，不通過SpringBoot,若是須要使用SpringBoot的Profile高級功能即文檔塊功能則就須要使用logback-spring.xml。

​ profile需新增配置：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    <layout class="ch.qos.logback.classic.PatternLayout">
        <springProfile name="dev">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
        </springProfile>
        <springProfile name="!dev">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
        </springProfile>
    </layout>
</appender>

5、切換日誌框架

​ 使用slf4j+log4j的方式

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>logback-classic</artifactId>
            <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
            <artifactId>log4j-over-slf4j</artifactId>
            <groupId>org.slf4j</groupId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
</dependency>

​ 使用slf4j+log4j2的方式

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>spring-boot-starter-logging</artifactId>
            <groupId>org.springframework.boot</groupId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>