在SpringBoot中使用Logback管理日誌

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