https://segmentfault.com/a/1190000021150594

https://juejin.im/post/5b51f85c5188251af91a7525

前言

今天來介紹下Spring Boot如何配置日誌logback,我剛學習的時候，是帶着下面幾個問題來查資料的，你呢

如何引入日誌？
日誌輸出格式以及輸出方式如何配置？
代碼中如何使用？

正文

Spring Boot在所有內部日誌中使用Commons Logging，但是默認配置也提供了對常用日誌的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每種Logger都可以通過配置使用控制檯或者文件輸出日誌內容。

默認日誌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會用Logback來記錄日誌，並用INFO級別輸出到控制檯。在運行應用程序和其他例子時，你應該已經看到很多INFO級別的日誌了。

從上圖可以看到，日誌輸出內容元素具體如下：

時間日期：精確到毫秒
日誌級別：ERROR, WARN, INFO, DEBUG or TRACE
進程ID
分隔符：--- 標識實際日誌的開始
線程名：方括號括起來（可能會截斷控制檯輸出）
Logger名：通常使用源代碼的類名
日誌內容

添加日誌依賴

假如maven依賴中添加了spring-boot-starter-logging：

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

那麼，我們的Spring Boot應用將自動使用logback作爲應用日誌框架，Spring Boot啓動的時候，由org.springframework.boot.logging.Logging-Application-Listener根據情況初始化並使用。

但是呢，實際開發中我們不需要直接添加該依賴，你會發現spring-boot-starter其中包含了 spring-boot-starter-logging，該依賴內容就是 Spring Boot 默認的日誌框架 logback。而博主這次項目的例子是基於上一篇的，工程中有用到了Thymeleaf，而Thymeleaf依賴包含了spring-boot-starter，最終我只要引入Thymeleaf即可。

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

具體可以看該圖

默認配置屬性支持

Spring Boot爲我們提供了很多默認的日誌配置，所以，只要將spring-boot-starter-logging作爲依賴加入到當前應用的classpath，則“開箱即用”。
下面介紹幾種在application.properties就可以配置的日誌相關屬性。

控制檯輸出

日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置爲WARN，則低於WARN的信息都不會輸出。
Spring Boot中默認配置ERROR、WARN和INFO級別的日誌輸出到控制檯。您還可以通過啓動您的應用程序–debug標誌來啓用“調試”模式（開發的時候推薦開啓）,以下兩種方式皆可：

在運行命令後加入--debug標誌，如：$ java -jar springTest.jar --debug
在application.properties中配置debug=true，該屬性置爲true的時候，核心Logger（包含嵌入式容器、hibernate、spring）會輸出更多內容，但是你自己應用的日誌並不會輸出爲DEBUG級別。

文件輸出

默認情況下，Spring Boot將日誌輸出到控制檯，不會寫到日誌文件。如果要編寫除控制檯輸出之外的日誌文件，則需在application.properties中設置logging.file或logging.path屬性。

logging.file，設置文件，可以是絕對路徑，也可以是相對路徑。如：logging.file=my.log
logging.path，設置目錄，會在該目錄下創建spring.log文件，並寫入日誌內容，如：logging.path=/var/log

如果只配置 logging.file，會在項目的當前路徑下生成一個 xxx.log 日誌文件。
如果只配置 logging.path，在 /var/log文件夾生成一個日誌文件爲 spring.log

注：二者不能同時使用，如若同時使用，則只有logging.file生效

默認情況下，日誌文件的大小達到10MB時會切分一次，產生新的日誌文件，默認級別爲：ERROR、WARN、INFO

級別控制

所有支持的日誌記錄系統都可以在Spring環境中設置記錄級別（例如在application.properties中）
格式爲：’logging.level.* = LEVEL’

logging.level：日誌級別控制前綴，*爲包名或Logger名
LEVEL：選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例：

logging.level.com.dudu=DEBUG：com.dudu包下所有class以DEBUG級別輸出
logging.level.root=WARN：root日誌以WARN級別輸出

自定義日誌配置

由於日誌服務一般都在ApplicationContext創建前就初始化了，它並不是必須通過Spring的配置文件控制。因此通過系統屬性和傳統的Spring Boot外部配置文件依然可以很好的支持日誌控制和管理。

根據不同的日誌系統，你可以按如下規則組織配置文件名，就能被正確加載：

Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2：log4j2-spring.xml, log4j2.xml
JDK (Java Util Logging)：logging.properties

Spring Boot官方推薦優先使用帶有-spring的文件名作爲你的日誌配置（如使用logback-spring.xml，而不是logback.xml），命名爲logback-spring.xml的日誌配置文件，spring boot可以爲它添加一些spring boot特有的配置項（下面會提到）。

上面是默認的命名規則，並且放在src/main/resources下面即可。

如果你即想完全掌控日誌配置，但又不想用logback.xml作爲Logback配置的名字，可以在application.properties配置文件裏面通過logging.config屬性指定自定義的名字：

1	logging.config=classpath:logging-config.xml

雖然一般並不需要改變配置文件的名字，但是如果你想針對不同運行時Profile使用不同的日
志配置，這個功能會很有用。

下面我們來看看一個普通的logback-spring.xml例子

<?xml version="1.0" encoding="UTF-8"?>
<configuration  scan="true" scanPeriod="60 seconds" debug="false">
    <contextName>logback</contextName>
    <property name="log.path" value="/Users/tengjun/Documents/log" />
    <!--輸出到控制檯-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
       <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>-->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!--輸出到文件-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="console" />
        <appender-ref ref="file" />
    </root>

    <!-- logback爲java中的包 -->
    <logger name="com.dudu.controller"/>
    <!--logback.LogbackDemo：類的全路徑 -->
    <logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
        <appender-ref ref="console"/>
    </logger>
</configuration>

根節點<configuration>包含的屬性

scan:當此屬性設置爲true時，配置文件如果發生改變，將會被重新加載，默認值爲true。
scanPeriod:設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。
debug:當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。

根節點<configuration>的子節點：
<configuration>下面一共有2個屬性，3個子節點，分別是：

屬性一：設置上下文名稱<contextName>

每個logger都關聯到logger上下文，默認上下文名稱爲“default”。但可以使用設置成其他名字，用於區分不同應用程序的記錄。一旦設置，不能修改,可以通過%contextName來打印日誌上下文名稱。

1	<contextName>logback</contextName>

屬性二：設置變量<property>

用來定義變量值的標籤，有兩個屬性，name和value；其中name的值是變量的名稱，value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量後，可以使“${}”來使用變量。

1	<property name="log.path" value="/Users/tengjun/Documents/log" />

子節點一<appender>

appender用來格式化日誌輸出節點，有倆個屬性name和class，class用來指定哪種輸出策略，常用就是控制檯輸出策略和文件輸出策略。

#####控制檯輸出ConsoleAppender：

<!--輸出到控制檯-->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>ERROR</level>
    </filter>
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

<encoder>表示對日誌進行編碼：

%d{HH: mm:ss.SSS}——日誌輸出時間
%thread——輸出日誌的進程名字，這在Web應用以及異步任務處理中很有用
%-5level——日誌級別，並且使用5個字符靠左對齊
%logger{36}——日誌輸出者的名字
%msg——日誌消息
%n——平臺的換行符

ThresholdFilter爲系統定義的攔截器，例如我們用ThresholdFilter來過濾掉ERROR級別以下的日誌不輸出到文件中。如果不用記得註釋掉，不然你控制檯會發現沒日誌~

輸出到文件RollingFileAppender

另一種常見的日誌輸出到文件，隨着應用的運行時間越來越長，日誌也會增長的越來越多，將他們輸出到同一個文件並非一個好辦法。RollingFileAppender用於切分文件日誌：

<!--輸出到文件-->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
		<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
		<totalSizeCap>1GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

其中重要的是rollingPolicy的定義，上例中<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>定義了日誌的切分方式——把每一天的日誌歸檔到一個文件中，<maxHistory>30</maxHistory>表示只保留最近30天的日誌，以防止日誌填滿整個磁盤空間。同理，可以使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日誌切分方式。<totalSizeCap>1GB</totalSizeCap>用來指定日誌文件的上限大小，例如設置爲1GB的話，那麼到了這個值，就會刪除舊的日誌。

補:如果你想把日誌直接放到當前項目下，把${log.path}/去掉即可。

logback 每天生成和大小生成衝突的問題可以看這個解答：傳送門

子節點二<root>

root節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個level屬性。

level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能設置爲INHERITED或者同義詞NULL。
默認是DEBUG。
可以包含零個或多個元素，標識這個appender將會添加到這個logger。
1 2 3 4
<root level="debug"> <appender-ref ref="console" /> <appender-ref ref="file" /> </root>

子節點三<logger>

<logger>用來設置某一個包或者具體的某一個類的日誌打印級別、以及指定<appender>。<logger>僅有一個name屬性，一個可選的level和一個可選的addtivity屬性。

name:用來指定受此logger約束的某一個包或者具體的某一個類。
level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。如果未設置此屬性，那麼當前logger將會繼承上級的級別。
addtivity:是否向上級logger傳遞打印信息。默認是true。

logger在實際使用的時候有兩種情況
先來看一看代碼中如何使用

package com.dudu.controller;
@Controller
public class LearnController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping(value = "/login",method = RequestMethod.POST)
    @ResponseBody
    public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){
        //日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設置爲WARN，則低於WARN的信息都不會輸出。
        logger.trace("日誌輸出 trace");
        logger.debug("日誌輸出 debug");
        logger.info("日誌輸出 info");
        logger.warn("日誌輸出 warn");
        logger.error("日誌輸出 error");
        Map<String,Object> map =new HashMap<String,Object>();
        String userName=request.getParameter("userName");
        String password=request.getParameter("password");
        if(!userName.equals("") && password!=""){
            User user =new User(userName,password);
            request.getSession().setAttribute("user",user);
            map.put("result","1");
        }else{
            map.put("result","0");
        }
        return map;
    }
}

這是一個登錄的判斷的方法，我們引入日誌，並且打印不同級別的日誌，然後根據logback-spring.xml中的配置來看看打印了哪幾種級別日誌。

第一種：帶有logger的配置，不指定級別，不指定appender

1	<logger name="com.dudu.controller"/>

<logger name="com.dudu.controller" />將控制controller包下的所有類的日誌的打印，但是並沒用設置打印級別，所以繼承他的上級的日誌級別“info”；
沒有設置addtivity，默認爲true，將此logger的打印信息向上級傳遞；
沒有設置appender，此logger本身不打印任何信息。
<root level="info">將root的打印級別設置爲“info”，指定了名字爲“console”的appender。

當執行com.dudu.controller.LearnController類的login方法時，LearnController 在包com.dudu.controller中，所以首先執行<logger name="com.dudu.controller"/>，將級別爲“info”及大於“info”的日誌信息傳遞給root，本身並不打印；
root接到下級傳遞的信息，交給已經配置好的名爲“console”的appender處理，“console”appender將信息打印到控制檯；

打印結果如下：

1
2
3

16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.dudu.controller.LearnController - 日誌輸出 info
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日誌輸出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日誌輸出 error

第二種：帶有多個logger的配置，指定級別，指定appender

<!--logback.LogbackDemo：類的全路徑 -->
<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
    <appender-ref ref="console"/>
</logger>

控制com.dudu.controller.LearnController類的日誌打印，打印級別爲“WARN”;
additivity屬性爲false，表示此logger的打印信息不再向上級傳遞;
指定了名字爲“console”的appender;

這時候執行com.dudu.controller.LearnController類的login方法時，先執行<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">,
將級別爲“WARN”及大於“WARN”的日誌信息交給此logger指定的名爲“console”的appender處理，在控制檯中打出日誌，不再向上級root傳遞打印信息。
打印結果如下：

1
2

16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日誌輸出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日誌輸出 error

當然如果你把additivity=”false”改成additivity=”true”的話，就會打印兩次，因爲打印信息向上級傳遞，logger本身打印一次，root接到後又打印一次。

注：使用mybatis的時候，sql語句是debug下才會打印，而這裏我們只配置了info，所以想要查看sql語句的話，有以下兩種操作：

第一種把<root level="info">改成<root level="DEBUG">這樣就會打印sql，不過這樣日誌那邊會出現很多其他消息。
第二種就是單獨給dao下目錄配置debug模式，代碼如下，這樣配置sql語句會打印，其他還是正常info級別：
1 2 3
<logger name="com.dudu.dao" level="DEBUG" additivity="false"> <appender-ref ref="console" /> </logger>

多環境日誌輸出

據不同環境（prod:生產環境，test:測試環境，dev:開發環境）來定義不同的日誌輸出，在 logback-spring.xml中使用 springProfile 節點來定義，方法如下：

文件名稱不是logback.xml，想使用spring擴展profile支持，要以logback-spring.xml命名

<!-- 測試環境+開發環境. 多個使用逗號隔開. -->
<springProfile name="test,dev">
    <logger name="com.dudu.controller" level="info" />
</springProfile>
<!-- 生產環境. -->
<springProfile name="prod">
    <logger name="com.dudu.controller" level="ERROR" />
</springProfile>

可以啓動服務的時候指定 profile （如不指定使用默認），如指定prod 的方式爲：
java -jar xxx.jar –spring.profiles.active=prod
關於多環境配置可以參考
Spring Boot乾貨系列：（二）配置文件解析

總結

到此爲止終於介紹完日誌框架了，平時使用的時候推薦用自定義logback-spring.xml來配置，代碼中使用日誌也很簡單，類裏面添加private Logger logger = LoggerFactory.getLogger(this.getClass());即可。

想要查看更多Spring Boot乾貨教程,可前往：Spring Boot乾貨系列總綱

springboot+logback日誌輸出企業實踐

前言

正文

默認日誌Logback

添加日誌依賴

默認配置屬性支持

控制檯輸出

文件輸出

級別控制

自定義日誌配置

多環境日誌輸出

總結

Arthas排查java性能問題

Spring 中異常處理的各種姿勢 ExceptionHandler

springboot+logback日誌輸出企業實踐

外部訪問k8s 裏面pod的方式方法

Hystrix HystricCommand配置參數全解析

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結