spring boot日志管理配置

更新時間：2017年04月24日 14:53:16 作者：牛頭人

這篇文章主要介紹了spring boot日志管理配置的相關(guān)資料,需要的朋友可以參考下

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

控制臺輸出

在Spring Boot中默認(rèn)配置了ERROR、WARN和INFO級別的日志輸出到控制臺。

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

a.在運(yùn)行命令后加入--debug標(biāo)志，如：$ Java -jar myapp.jar --debug

b.在application.properties中配置debug=true，該屬性置為true的時候，核心Logger（包含嵌入式容器、hibernate、spring）會輸出更多內(nèi)容，但是你自己應(yīng)用的日志并不會輸出為DEBUG級別。

多彩輸出

如果你的終端支持ANSI，設(shè)置彩色輸出會讓日志更具可讀性。通過在application.properties中設(shè)置spring.output.ansi.enabled參數(shù)來支持。

a.NEVER：禁用ANSI-colored輸出（默認(rèn)項）

b.DETECT：會檢查終端是否支持ANSI，是的話就采用彩色輸出（推薦項）

c.ALWAYS：總是使用ANSI-colored格式輸出，若終端不支持的時候，會有很多干擾信息，不推薦使用

文件輸出

Spring Boot默認(rèn)配置只會輸出到控制臺，并不會記錄到文件中，但是我們通常生產(chǎn)環(huán)境使用時都需要以文件方式記錄。

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

logging.file，設(shè)置文件，可以是絕對路徑，也可以是相對路徑。如：logging.file=my.log

logging.path，設(shè)置目錄，會在該目錄下創(chuàng)建spring.log文件，并寫入日志內(nèi)容，如：logging.path=/var/log

日志文件會在10Mb大小的時候被截斷，產(chǎn)生新的日志文件，默認(rèn)級別為：ERROR、WARN、INFO

級別控制

在Spring Boot中只需要在application.properties中進(jìn)行配置完成日志記錄的級別控制。

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

logging.level：日志級別控制前綴，*為包名或Logger名

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

舉例：

logging.level.com.didispace=DEBUG：com.didispace包下所有class以DEBUG級別輸出

logging.level.root=WARN：root日志以WARN級別輸出

自定義日志配置

由于日志服務(wù)一般都在ApplicationContext創(chuàng)建前就初始化了，它并不是必須通過Spring的配置文件控制。因此通過系統(tǒng)屬性和傳統(tǒng)的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根據(jù)不同的日志系統(tǒng)，你可以按如下規(guī)則組織配置文件名，就能被正確加載：

1.Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy

2.Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml

3.Log4j2：log4j2-spring.xml, log4j2.xml

4.JDK (Java Util Logging)：logging.properties

Spring Boot官方推薦優(yōu)先使用帶有-spring的文件名作為你的日志配置（如使用logback-spring.xml，而不是logback.xml）

自定義輸出格式

在Spring Boot中可以通過在application.properties配置如下參數(shù)控制輸出格式：

logging.pattern.console：定義輸出到控制臺的樣式（不支持JDK Logger）
logging.pattern.file：定義輸出到文件的樣式（不支持JDK Logger）

使用log4j記錄日志

引入log4j依賴

在創(chuàng)建Spring Boot工程時，我們引入了spring-boot-starter，其中包含了
spring-boot-starter-logging，該依賴內(nèi)容就是Spring Boot默認(rèn)的日志框架Logback，所以我們在引入log4j之前，需要先排除該包的依賴，再引入log4j的依賴，就像下面這樣：

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

配置log4j.properties

在引入了log4j依賴之后，只需要在src/main/resources目錄下加入log4j.properties配置文件，就可以開始對應(yīng)用的日志進(jìn)行配置使用。

控制臺輸出

通過如下配置，設(shè)定root日志的輸出級別為INFO，appender為控制臺輸出stdout:

# LOG4J配置
log4j.rootCategory=INFO, stdout
# 控制臺輸出
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n

輸出到文件

在開發(fā)環(huán)境，我們只是輸出到控制臺沒有問題，但是到了生產(chǎn)或測試環(huán)境，或許持久化日志內(nèi)容，方便追溯問題原因。可以通過添加如下的appender內(nèi)容，按天輸出到不同的文件中去，同時還需要為log4j.rootCategory添加名為file的appender，這樣root日志就可以輸出到logs/all.log文件中了。

log4j.rootCategory=INFO, stdout, file
# root日志輸出
log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.file=logs/all.log
log4j.appender.file.DatePattern='.'yyyy-MM-dd
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n

分類輸出

當(dāng)我們?nèi)罩玖枯^多的時候，查找問題會非常困難，常用的手段就是對日志進(jìn)行分類，比如：
可以按不同package進(jìn)行輸出。通過定義輸出到logs/my.log的appender，并對com.didispace包下的日志級別設(shè)定為DEBUG級別、appender設(shè)置為輸出到logs/my.log的名為didifile的appender。

# com.didispace包下的日志配置
log4j.category.com.didispace=DEBUG, didifile
# com.didispace下的日志輸出
log4j.appender.didifile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.didifile.file=logs/my.log
log4j.appender.didifile.DatePattern='.'yyyy-MM-dd
log4j.appender.didifile.layout=org.apache.log4j.PatternLayout
log4j.appender.didifile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L ---- %m%n

可以對不同級別進(jìn)行分類，比如對ERROR級別輸出到特定的日志文件中，具體配置可以如下:

log4j.logger.error=errorfile

# error日志輸出
log4j.appender.errorfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.errorfile.file=logs/error.log
log4j.appender.errorfile.DatePattern='.'yyyy-MM-dd
log4j.appender.errorfile.Threshold = ERROR
log4j.appender.errorfile.layout=org.apache.log4j.PatternLayout
log4j.appender.errorfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n

本文主要介紹如何在spring boot中引入log4j，以及一些基礎(chǔ)用法，對于更多l(xiāng)og4j的用法，還請參考log4j官方網(wǎng)站

目前最新spring boot版本1.5.2支持log4j2記錄日志

使用log4j2記錄日志

首先自定義一個src/main/resources/log4j2.xml文件，：

<?xml version="1.0" encoding="UTF-8"?> 
  <Configuration status="WARN"> 
    <Appenders> 
      <Console name="Console" target="SYSTEM_OUT" follow="true"> 
        <PatternLayout> 
          <pattern>%d %p %C{1.} [%t] %m%n</pattern> 
        </PatternLayout> 
      </Console> 
      <File name="File" fileName="/Users/zk_chs/logtest/zk_chs.log"> 
        <PatternLayout> 
          <pattern>%d %p %C{1.} [%t] %m%n</pattern> 
        </PatternLayout> 
      </File> 
    </Appenders> 
    <Loggers> 
      <Logger name="org.apache.catalina.util.LifecycleBase" level="error" /> 
      <Logger name="org.apache.coyote.http11.Http11NioProtocol" level="warn" /> 
      <Logger name="org.apache.tomcat.util.NET.NioSelectorPool" level="warn" /> 
      <Logger name="org.hibernate.validator.internal.util.Version" level="warn" /> 
      <Logger name="org.springframework" level="warn" /> 
      <Logger name="com.github" level="debug" /> 
      <Root level="info"> 
        <AppenderRef ref="Console" /> 
      </Root> 
    </Loggers> 
  </Configuration>

在pom.xml按照spring boot的文檔進(jìn)行定義

<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-web</artifactId> 
  </dependency> 
  <dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter</artifactId> 
    <exclusions> 
      <exclusion> 
        <groupId>org.springframework.boot</groupId> 
        <artifactId>spring-boot-starter-logging</artifactId> 
      </exclusion> 
    </exclusions> 
  </dependency> 
  <dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-log4j2</artifactId> 
  </dependency>

最后在application.properties文件中，指定加載的log文件位置：

logging.config=classpath:log4j2.xml

目前我們的日志是在控制臺進(jìn)行輸出，如果需要輸出到文件中的話，添加<AppenderRef ref="File" />即可

ps:根據(jù)spring boot官網(wǎng)的方式，

在java類中加入：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
private static Logger logger = LogManager.getLogger(IndexInterceptor2.class.getName());

報錯:

The import org.apache.logging.log4j.LogManager cannot be resolved

于是在pom.xml加入一下依賴就可以了：

 <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-api</artifactId>
      <version>2.8.2</version>
     </dependency>
     <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>2.8.2</version>
     </dependency>

以上所述是小編給大家介紹的spring boot日志管理配置，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！

您可能感興趣的文章: