在spring boot项目中如何配置日志管理

发布时间：2020-11-17 16:38:52 作者：Leah
来源：亿速云阅读：226

这篇文章将为大家详细讲解有关在spring boot项目中如何配置日志管理，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。

spring Boot在所有内部日志中使用Commons Logging，但是默认配置也提供了对常用日志的支持，如：Java Util Logging，Log4J,Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。

控制台输出

在Spring Boot中默认配置了ERROR、WARN和INFO级别的日志输出到控制台。

我们可以通过两种方式切换至DEBUG级别：

a.在运行命令后加入--debug标志，如：$ Java -jar myapp.jar --debug

b.在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。

多彩输出

如果你的终端支持ANSI，设置彩色输出会让日志更具可读性。通过在application.properties中设置spring.output.ansi.enabled参数来支持。

a.NEVER：禁用ANSI-colored输出（默认项）

b.DETECT：会检查终端是否支持ANSI，是的话就采用彩色输出（推荐项）

c.ALWAYS：总是使用ANSI-colored格式输出，若终端不支持的时候，会有很多干扰信息，不推荐使用

文件输出

Spring Boot默认配置只会输出到控制台，并不会记录到文件中，但是我们通常生产环境使用时都需要以文件方式记录。

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

logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=my.log

logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：logging.path=/var/log

日志文件会在10Mb大小的时候被截断，产生新的日志文件，默认级别为：ERROR、WARN、INFO

级别控制

在Spring Boot中只需要在application.properties中进行配置完成日志记录的级别控制。

配置格式：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级别输出

自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

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官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml）

自定义输出格式

在Spring Boot中可以通过在application.properties配置如下参数控制输出格式：

logging.pattern.console：定义输出到控制台的样式（不支持JDK Logger）
logging.pattern.file：定义输出到文件的样式（不支持JDK Logger）

使用log4j记录日志

引入log4j依赖

在创建Spring Boot工程时，我们引入了spring-boot-starter，其中包含了
spring-boot-starter-logging，该依赖内容就是Spring Boot默认的日志框架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配置文件，就可以开始对应用的日志进行配置使用。

控制台输出

通过如下配置，设定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

输出到文件

在开发环境，我们只是输出到控制台没有问题，但是到了生产或测试环境，或许持久化日志内容，方便追溯问题原因。可以通过添加如下的appender内容，按天输出到不同的文件中去，同时还需要为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

分类输出

当我们日志量较多的时候，查找问题会非常困难，常用的手段就是对日志进行分类，比如：
可以按不同package进行输出。通过定义输出到logs/my.log的appender，并对com.didispace包下的日志级别设定为DEBUG级别、appender设置为输出到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

可以对不同级别进行分类，比如对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，以及一些基础用法，对于更多log4j的用法，还请参考log4j官方网站

目前最新spring boot版本1.5.2支持log4j2记录日志

使用log4j2记录日志

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

<&#63;xml version="1.0" encoding="UTF-8"&#63;> 
  <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的文档进行定义

<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

目前我们的日志是在控制台进行输出，如果需要输出到文件中的话，添加<AppenderRef ref="File" />即可

ps:根据spring boot官网的方式，

在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项目中如何配置日志管理就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。

在spring boot项目中如何配置日志管理

相关阅读