Spring Boot乾貨系列：（七）默認日誌logback配置解析 | 掘金技術徵文

時間  2019-11-16
標籤 spring boot 乾貨 系列 默認 日誌 logback 配置 解析 技術 徵文 欄目 Spring 简体版
原文   原文鏈接

本來地址：Spring Boot乾貨系列：（七）默認日誌logback配置解析
博客地址：tengj.top/javascript

前言

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

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

正文

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

默認日誌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。java

Logback是log4j框架的做者開發的新一代日誌框架，它效率更高、可以適應諸多的運行環境，同時自然支持SLF4J。git

默認狀況下，Spring Boot會用Logback來記錄日誌，並用INFO級別輸出到控制檯。在運行應用程序和其餘例子時，你應該已經看到不少INFO級別的日誌了。
github

從上圖能夠看到，日誌輸出內容元素具體以下：spring

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

添加日誌依賴

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

<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根據狀況初始化並使用。api

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

<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配置的名字，能夠經過logging.config屬性指定自定義的名字：

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="E:\\test\\logback.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">
        <file>${log.path}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>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來打印日誌上下文名稱。 

<contextName>logback</contextName>複製代碼

屬性二：設置變量<property>

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

<property name="log.path" value="E:\\logback.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">
    <file>${log.path}</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>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>logback.%d{yyyy-MM-dd}.log</fileNamePattern>定義了日誌的切分方式——把每一天的日誌歸檔到一個文件中，<maxHistory>30</maxHistory>表示只保留最近30天的日誌，以防止日誌填滿整個磁盤空間。同理，可使用%d{yyyy-MM-dd_HH-mm}來定義精確到分的日誌切分方式。<totalSizeCap>1GB</totalSizeCap>用來指定日誌文件的上限大小，例如設置爲1GB的話，那麼到了這個值，就會刪除舊的日誌。

子節點二<root>

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

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

子節點三<loger>

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

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

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

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中的配置來看看打印了哪幾種級別日誌。

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

<logger name="com.dudu.controller"/>複製代碼

<logger name="com.dudu.controller" />將控制controller包下的全部類的日誌的打印，可是並沒用設置打印級別，因此繼承他的上級 的日誌級別「info」；
沒有設置addtivity，默認爲true，將此loger的打印信息向上級傳遞；
沒有設置appender，此loger自己不打印任何信息。
<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將信息打印到控制檯；

打印結果以下：

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複製代碼

第二種：帶有多個loger的配置，指定級別，指定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，表示此loger的打印信息再也不向上級傳遞;
指定了名字爲「console」的appender;

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

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接到後又打印一次。

多環境日誌輸出

據不一樣環境（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乾貨系列總綱

源碼下載

(￣︶￣)↗[相關示例完整代碼]

一直以爲本身寫的不是技術，而是情懷，一篇篇文章是本身這一路走來的痕跡。靠專業技能的成功是最具可複製性的，但願個人這條路能讓你少走彎路，但願我能幫你抹去知識的蒙塵，但願我能幫你理清知識的脈絡，但願將來技術之巔上有你也有我,但願大爺你看完打賞點零花錢給我。

訂閱博主微信公衆號：嘟爺java超神學堂（javaLearn）三大好處：

  • 獲取最新博主博客更新信息，首發公衆號
  • 獲取大量視頻，電子書，精品破解軟件資源
  • 能夠跟博主聊天，歡迎程序媛妹妹來撩我

掘金技術徵文

掘金技術徵文第三期：聊聊你的最佳實踐

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程