在SpringBoot中使用Logback管理日誌

Joepis發表於2018-05-16
Spring Boot

SpringBoot的預設日誌配置

SpringBoot開箱即用，預設幫你配置了日誌框架，使用 Commons Logging ，但是預設配置也提供了對常用日誌的支援，如： Java Util Logging ， Log4J , Log4J2 和 Logback。每種Logger都可以通過配置使用控制檯或者檔案輸出日誌內容。

控制檯輸出

關於log日誌，首先說說的5個日誌級別 LEVEL： 從高到低分別是ERROR、WARN、INFO、DEBUG、TRACE 低階別的會輸出高階別資訊，高階別不會輸出低階別資訊。例如：等級設為ERROR的話，WARN、INFO、DEBUG的資訊是不會輸出的。 在SpringBoot中預設配置了ERROR 、WARN和INFO級別的日誌輸出到控制檯。 Logback中沒有FATAL級別，它會被當作ERROR級別來處理。

我們可以通過兩種方式切換至 DEBUG 級別：

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

多彩輸出

SpringBoot從1.4.0版本開始支援彩色日誌輸出了。 如果你的終端支援ANSI，設定彩色輸出會讓日誌更具可讀性。通過在 application.properties 中設定 spring.output.ansi.enabled 引數來支援。

  • NEVER：禁用ANSI-colored輸出（預設項）
  • DETECT：會檢查終端是否支援ANSI，是的話就採用彩色輸出（推薦項）
  • ALWAYS：總是使用ANSI-colored格式輸出，若終端不支援的時候，會有很多干擾資訊，不推薦使用

檔案輸出

SpringBoot預設配置只會輸出到控制檯，並不會記錄到檔案中，但是我們通常生產環境使用時都需要以檔案方式記錄。

若要增加檔案輸出，需要在 application.properties 中配置 logging.file 或 logging.path 屬性。

  • logging.file:設定檔案，可以是絕對路徑，也可以是相對路徑。如： logging.file=my.log
  • logging.path:設定目錄，會在該目錄下建立spring.log檔案，並寫入日誌內容，如： logging.path=/var/log

日誌檔案會在10Mb大小的時候被截斷，產生新的日誌檔案，預設級別為：ERROR、WARN、INFO

級別控制

在SpringBoot中只需要在 application.properties 中進行配置完成日誌記錄的級別控制。

配置格式： logging.level.*=LEVEL

  • logging.level ：日誌級別控制字首， * 為包名或Logger名
  • LEVEL ：選項TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

舉例：

  • logging.level.com.controller=DEBUG ： com.controller 包下所有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

SpringBoot官方推薦優先使用帶有 -spring 的檔名作為你的日誌配置（如使用 logback-spring.xml ，而不是 logback.xml ）

自定義輸出格式

在SpringBoot中可以通過在 application.properties 配置如下引數控制輸出格式：

  • logging.pattern.console：定義輸出到控制檯的樣式（不支援JDK Logger）
  • logging.pattern.file：定義輸出到檔案的樣式（不支援JDK Logger）

也可以直接在日誌配置檔案中定義這些格式，而不是在應用配置檔案中。

常用的Logback配置檔案模板

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<!--定義日誌檔案的儲存地址 勿在 LogBack 的配置中使用相對路徑-->
    <property name="LOG_HOME" value="d:/logs"/>

    <!-- 彩色日誌依賴的渲染類 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
    <conversionRule conversionWord="wex"
                    converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
    <conversionRule conversionWord="wEx"
                    converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
    <!-- 彩色日誌格式 -->
    <property name="CONSOLE_LOG_PATTERN"
              value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(--){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    <!-- Console 輸出設定 -->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<!--格式化輸出：%d表示日期，%thread表示執行緒名，%-5level：級別從左顯示5個字元寬度%msg：日誌訊息，%n是換行符-->
			<!--<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>-->
			<pattern>${CONSOLE_LOG_PATTERN}</pattern>
			<charset>utf8</charset>
		</encoder>
	</appender>

    <!-- 按照每天生成日誌檔案 -->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日誌檔案輸出的檔名-->
            <fileNamePattern>${LOG_HOME}/mixedSys.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 日誌logger(包.類)的輸出級別 -->
	<logger name="org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver" level="DEBUG" >
		<appender-ref ref="console" />
		<appender-ref ref="file" />
	</logger>

    <logger name="org.springframework.boot" level="DEBUG"/>
    <!-- 為 Hibernate sql 定製 -->
    <!-- <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"  level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />  -->

    <!-- 日誌輸出級別 -->
    <root level="INFO"> <!-- 此時debug級別的資訊會被過濾 -->  
        <appender-ref ref="console" />   
        <appender-ref ref="file" />   
    </root> 
    
	<!--日誌非同步到資料庫 -->    
    <!-- <appender name="DB" class="ch.qos.logback.classic.db.DBAppender">  
        日誌非同步到資料庫   
        <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">  
            連線池   
            <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">  
              <driverClass>com.mysql.jdbc.Driver</driverClass>  
              <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>  
              <user>root</user>  
              <password>root</password>  
            </dataSource>  
        </connectionSource>  
    </appender> -->
	
</configuration>
複製程式碼

相關文章