【spring boot】8.spring boot的日誌框架logback使用

時間  2019-11-09
標籤 spring boot 8.spring spring boot 日誌 框架 logback 使用 欄目 Spring 简体版
原文   原文鏈接

 在繼續上一篇的Debug調試以後，把spring boot的日誌框架使用狀況逐步蠶食。html

參考：http://tengj.top/2017/04/05/springbojava

開篇以前，貼上完整application.properties日誌相關配置web

 

=============================================================================================spring

簡介：spring boot的默認日誌框架Logbackwindows

SLF4J——Simple Logging Facade For Java，它是一個針對於各種Java日誌框架的統一Facade抽象。Java日誌框架衆多——經常使用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定義了統一的日誌抽象接口，而真正的日誌實現則是在運行時決定的——它提供了各種日誌框架的binding。app

 

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

默認狀況下，Spring Boot會用Logback來記錄日誌，並用INFO級別輸出到控制檯。在剛開始運行一個嶄新的spring boot項目時，你就能夠在控制檯看到INFO級別的日誌了。異步

有以下的7各部分：maven

  • ①時間日期：精確到毫秒ide

  • ②日誌級別：ERROR> WARN>INFO>DEBUG > TRACE　　優先級如前面，默認狀況下是INFO，則INFO以及優先級更高的WARN和ERROR會被顯示

  • ③進程ID　　就是PID

  • ④分隔符：--- 標識實際日誌的開始

  • ⑤線程名：方括號括起來（可能會截斷控制檯輸出）

  • ⑥Logger名：一般使用源代碼的類名

  • ⑦日誌內容

能夠從上面看到，這個spring boot是啓動在8928這個進程上的。

在任務管理器中能夠看到【若是任務管理的的進程選項卡中看不到PID，http://www.cnblogs.com/sxdcgaq8080/p/7853081.html】

 

 ======================================================================================================

1、在項目application.properties配置就可使用log功能

1.要在spring boot中使用日誌功能，在pom.xml中配置maven架包

 

<!--使用spring boot日誌框架-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>

 

可是實際上是不用配置的，由於在spring-boot-starter-web下已經引用了日誌的架包，以下圖：

 

 2.兩種使用狀況

日誌級別從低到高分爲TRACE < DEBUG < INFO < WARN < ERROR < FATAL，若是設置爲WARN，則低於WARN的信息都不會輸出。

　　2.1　控制檯輸出

Spring Boot中默認配置ERROR、WARN和INFO級別的日誌輸出到控制檯。您還能夠經過啓動您的應用程序--debug標誌來啓用「調試」模式（開發的時候推薦開啓）,如下兩種方式：

　　　　2.1.1在運行命令後加入--debug標誌，如：$ java -jar springTest.jar --debug

　　　　2.1.2在application.properties中配置debug=true，該屬性置爲true的時候，核心Logger（包含嵌入式容器、hibernate、spring）會輸出更多內容，可是你本身應用的日誌並不會輸出爲DEBUG級別。

以下：

配置文件application.properties中配置：

debug=true

啓動，觀察控制檯打印出來的日誌以下：

 

 

　　2.2文件輸出

 

默認狀況下，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

 

　　　　2.2.1　　logging.file，設置文件

　　　　　　2.2.1.1 配置文件application.properties中配置【logging.file  相對路徑】

logging.file = myloggin.log

生成日誌文件在項目【至關於項目根目錄下的相對路徑】

 

　　　　　　　　2.2.1.2　在配置文件applicarion.properties中配置【logging.file  絕對路徑】

logging.file = d:/myloggin.log

生成日誌文件，位置以下：

 

　　　　　　2.2.2　logging.path，設置目錄

 　　　　　　　　2.2.2.1　在配置文件appilication.properties中設置【logging.path  相對路徑】

logging.path = /log

生成日誌文件在當前項目所在的磁盤的根目錄下生成一個log文件夾，在文件夾中生成spring.log日誌文件【特定名字就是spring.log】

 

 　　　　　　　　2.2.2.2　在配置文件application.properties中配置【logging.path 絕對路徑】

logging.path = e:/log

會在指定目錄的文件夾中生成spring.log日誌文件【特定文件名spring.log】

 

 

 =========================================================================================================

2、日誌等級在application.properties的控制

 根據開篇貼上的配置文件中的配置屬性，能夠看到在application.properties中配置日誌等級就是一個配置，

格式爲：logging.level.* = LEVEL

  • logging.level：日誌級別控制前綴，*爲包名或Logger名

  • LEVEL：選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例：

  • logging.level.com.sxd=DEBUG　　com.sxd包下全部class以DEBUG級別輸出，包括其優先級以上

  • logging.level.root=WARN　　　　root日誌以WARN級別輸出，包括其優先級以上

 

=====================================================================================================

3、徹底控制和解析日誌配置

1.正經的提出問題：

上面兩步，能夠看到日誌能夠在控制檯或者文件中顯示出來，可是都是統一的樣式，統一的等級，或者只能配置一個路徑。

若是想徹底控制日誌，

　　　　①例如：我想在控制檯輸出的日誌格式是這樣的，可是在文件中能不能以另一種格式輸出？

 　　　　②例如：個人日誌文件輸出，能不能本身控制文件的大小，文件名，日誌文件總共多少就得清理？

　　　　③例如：能不能在不一樣的環境下，有不一樣的日誌操做，好比在生產環境下，個人Service層的日誌不會被打印，可是在開發環境下就要被打印出來

 

等等等等的，若是想徹底控制日誌的使用，往下看----->

 

2.慢慢的分析問題：

因爲日誌服務通常都在ApplicationContext建立前就初始化了，它並非必須經過Spring的配置文件控制。那如今在application.properties中配置些許的屬性已經不能徹底知足了。

因此經過系統屬性和傳統的Spring Boot外部配置文件 才 能夠很好的支持日誌控制和管理。

　　問題1：外部的日誌配置文件應該叫什麼名字呢？

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

  • 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特有的配置項【特有的就是spring boot的profile多環境配置】

　　問題2：日誌配置文件應該放在哪裏呢？

放在src/main/resources下面便可。

　　問題3：那不使用logback-spring.xml名字，使用本身定義的日誌配置文件名行不行？

若是你即想徹底掌控日誌配置，但又不想用logback.xml做爲Logback配置的名字，能夠經過logging.config屬性指定自定義的名字：

logging.config=classpath:logging-自定義.xml

　　問題4：那我想使用spring boot的profile多環境配置，日誌配置文件應該用什麼名字？使用流程是怎麼樣？

若是想使用profile多環境配置，

　　第一：日誌配置文件名應該定義成logback-spring.xml。

　　第二：而後在日誌配置文件中，使用<springProfile name="dev">  </springProfile>標籤來包住想要在這種環境下使用的配置。使用以下截圖：

　　第三：最後application.properties配置文件中，選擇激活哪種或哪幾種環境便可

附錄： 

 在沒有設置profile的狀況下，通常啓動狀況下，控制檯打印出的日誌都能看到這麼一句話：

 

 

3.拆析一個基本的logback-spring.xml文件

下面粘上一個基本的文件代碼：

<?xml version="1.0" encoding="UTF-8"?>

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logback</contextName>
    <!--定義日誌文件的存儲地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="log.path" value="E:\\log\\logback.log" />

    <!--輸出到控制檯-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <!--<pattern>%d %p (%file:%line\)- %m%n</pattern>-->
            <!--格式化輸出：%d:表示日期    %thread:表示線程名     %-5level:級別從左顯示5個字符寬度  %msg:日誌消息    %n:是換行符-->
            <pattern>控制檯-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger - %msg%n</pattern>
            <charset>GBK</charset>
        </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>
            <maxHistory>30</maxHistory>
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <!--格式化輸出：%d:表示日期    %thread:表示線程名     %-5level:級別從左顯示5個字符寬度  %msg:日誌消息    %n:是換行符-->
            <pattern>文件記錄-%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <charset>GBK</charset>
        </encoder>
    </appender>

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

    <logger name="com.sxd.controller"/>
    <logger name="com.sxd.util.LogTestController" level="WARN" additivity="false">
        <appender-ref ref="console" />
    </logger>



</configuration>
View Code

 

根節點<configuration>包含的屬性

  • scan:當此屬性設置爲true時，配置文件若是發生改變，將會被從新加載，默認值爲true。

  • scanPeriod:設置監測配置文件是否有修改的時間間隔，若是沒有給出時間單位，默認單位是毫秒。當scan爲true時，此屬性生效。默認的時間間隔爲1分鐘。

  • debug:當此屬性設置爲true時，將打印出logback內部日誌信息，實時查看logback運行狀態。默認值爲false。

根節點<configuration>的子節點：

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

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

每一個logger都關聯到logger上下文，默認上下文名稱爲「default」。但可使用<contextName>設置成其餘名字，用於區分不一樣應用程序的記錄。一旦設置，不能修改,能夠經過%contextName來打印日誌上下文名稱。

<contextName>logback</contextName>

屬性二：設置變量<property>

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

<property name="log.path" value="E:\\logback.log" />

子節點一<appender>

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

控制檯輸出ConsoleAppender：

 

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

  • %d{HH: mm:ss.SSS}——日誌輸出時間

  • %thread——輸出日誌的進程名字，這在Web應用以及異步任務處理中頗有用

  • %-5level——日誌級別，而且使用5個字符靠左對齊

  • %logger{36}——日誌輸出者的名字

  • %msg——日誌消息

  • %n——平臺的換行符

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

輸出到文件RollingFileAppender

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

 

其中重要的是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。

<root>能夠包含零個或多個<appender-ref>元素，標識這個appender將會添加到這個logger。

 

子節點三<logger>

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

  • name:用來指定受此loger約束的某一個包或者具體的某一個類。

  • level:用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，表明強制執行上級的級別。若是未設置此屬性，那麼當前loger將會繼承上級的級別。

  • addtivity:是否向上級logger傳遞打印信息。默認是true。

 

 

 

從上面能夠看到，logger在實際使用的時候有兩種狀況。

而後分別在com.sxd.controller中和com.sxd.util.LogTestController中添加相同的日誌打印，分別看看對應上面兩種<logger>的使用狀況：

 

com.sxd.controller.MainController

package com.sxd.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class MainController {

    @RequestMapping("/toLogin")
    public String hello(){
        return  "login";
    }

    Logger logger = LoggerFactory.getLogger(this.getClass());

    @RequestMapping("/log")
    @ResponseBody
    public void logTest(){
        System.out.println("進入Controller日誌控制中心----》》》");
        //日誌級別從低到高分別爲
        // TRACE < DEBUG < INFO < WARN < ERROR < FATAL
        //若是設置爲WARN，則WARN以及往上的才能打印出來
        logger.trace("日誌輸出：trace[全部痕跡]");
        logger.debug("日誌輸出：debug[debug調試]");
        logger.info("日誌輸出：info[信息級別]");
        logger.warn("日誌輸出：warn[警告級別]");
        logger.error("日誌輸出：error[錯誤級別]");
    }
}
View Code

com.sxd.util.LogTestController

package com.sxd.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class LogTestController {

    Logger logger = LoggerFactory.getLogger(this.getClass());

    @ResponseBody
    @RequestMapping("/log2")
    public void logTest(){
        System.out.println("進入util日誌控制中心----》》》");
        //日誌級別從低到高分別爲
        // TRACE < DEBUG < INFO < WARN < ERROR < FATAL
        //若是設置爲WARN，則WARN以及往上的才能打印出來
        logger.trace("日誌輸出：trace[全部痕跡]");
        logger.debug("日誌輸出：debug[debug調試]");
        logger.info("日誌輸出：info[信息級別]");
        logger.warn("日誌輸出：warn[警告級別]");
        logger.error("日誌輸出：error[錯誤級別]");
    }
}
View Code

 

 

 

 

咱們引入日誌，而且打印不一樣級別的日誌，而後根據logback-spring.xml中的配置來看看打印了哪幾種級別日誌。

第一種：帶有loger的配置，不指定級別，不指定appender[對應com.sxd.controller.MainController]

 

<logger name="com.sxd.controller"/>將控制controller包下的全部類的日誌的打印，可是並沒用設置打印級別，因此繼承他的上級<root>的日誌級別「info」；

沒有設置addtivity，默認爲true，將此loger的打印信息向上級傳遞；

沒有設置appender，此loger自己不打印任何信息。

<root level="info">將root的打印級別設置爲「info」，指定了名字爲「console」的appender。

當執行com.sxd.controller.MainController類的log方法時，MainController在包com.sxd.controllerr中，因此首先執行<logger name="com.sxd.controller"/>，將級別爲「info」及大於「info」的日誌信息傳遞給root，自己並不打印；

root接到下級傳遞的信息，交給已經配置好的名爲「console」的appender處理，「console」appender將信息打印到控制檯；

打印結果以下：【spring boot日誌亂碼的問題】

 

root接到下級傳遞的信息，交給已經配置好的名爲「file」的appender處理，「file」appender將信息寫入到日誌文件中，以下；

 

 

 

 

 

第二種：帶有多個loger的配置，指定級別，指定appender【對應com.sxd.util.LogTestController】

 

控制com.sxd.util.LogTestController類的日誌打印，打印級別爲「WARN」

additivity屬性爲false，表示此loger的打印信息再也不向上級傳遞

指定了名字爲「console」的appender

這時候執行com.sxd.util.LogTestController類的log方法時，先執行<logger name="com.sxd.util.LogTestController" level="WARN" additivity="false">,

將級別爲「WARN」及大於「WARN」的日誌信息交給此loger指定的名爲「console」的appender處理，在控制檯中打出日誌，再也不向上級root傳遞打印信息。

打印結果以下：

 

注意1：

固然，此時日誌文件中是沒有本第二天志的，由於本<logger>中指定了<appender-ref ref="console" />,特地的指出來，在console打印。因此file中並無。

注意2：

若是你把additivity="false"改爲additivity="true"的話，就會打印兩次，由於打印信息向上級傳遞，logger自己打印一次，root接到後又打印一次。此時，file中也會有日誌。

 

 

==================================================================完結=================================================================================、

因此，最後的最後。

若是你要在代碼中使用日誌的話，僅須要添加

Logger logger = LoggerFactory.getLogger(this.getClass());

而後就可使用了。

 

附錄1：spring boot中使用logback日誌亂碼處理

附錄2：spring boot中使用logback日誌顏色渲染

附錄3：spring boot使用logback-spring.xml文件後，application.properties文件中關於logging的配置還會起做用麼？

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