SpringBoot2.0.x使用logback日志的配置和常见使用

2023-02-09 18:04:41

理解SpringBoot日志体系的精髓：精通logback

logback简介

logback作为当今Java程序中广泛使用的日志框架，以其兼容性、可扩展性和强大功能而著称。logback的特性涵盖日志分级、过滤、异步输出和格式化，使其成为开发人员解决日志问题的理想选择。

logback配置：XML与注解

SpringBoot默认采用logback日志框架，提供两种配置方式：XML配置文件和注解。XML配置通过logback.xml文件实现，而注解配置则使用@Slf4j注解。

XML配置范例

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <root level="INFO">
    <appender-ref ref="CONSOLE"/>
  </root>
</configuration>

此配置将日志级别设置为INFO，并指定了日志输出格式。

注解配置示例

@Slf4j
public class MyClass {

  public void logInfo() {
    log.info("This is an info log message.");
  }

  public void logError() {
    log.error("This is an error log message.", new Exception("This is an exception."));
  }
}

@Slf4j注解自动生成一个日志对象（log），可轻松记录日志信息。

常见logback用法

logback提供了丰富的API来满足各种日志需求，包括：

设置日志级别
记录日志信息
格式化日志输出
过滤日志信息
异步日志输出

logback实用技巧

利用logback的多种日志适配器，如log4j和slf4j，增强与其他框架的兼容性。
充分利用异步日志输出（AsyncAppender），提高日志记录性能。
自定义日志格式，以满足具体需求。
考虑使用日志掩码（logback-masking）隐藏敏感信息。

常见问题解答

1.如何启用logback的调试模式？

答：在application.properties或application.yml文件中添加以下配置：

logging.level.org.springframework=DEBUG

2.如何在logback中使用环境变量？

答：使用${env:VAR_NAME}格式，例如：

logging.pattern.console=%d{HH:mm:ss.SSS} ${env:MY_ENV_VAR} %-5level %logger{36} - %msg%n

3.如何记录异常堆栈轨迹？

答：使用ThrowableProxyConverter，例如：

<configuration>
  ...
  <encoder>
    <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n%throwableProxy</pattern>
  </encoder>
  ...
</configuration>

4.如何在logback中使用JSON格式？

答：使用JSONLayout，例如：

<configuration>
  ...
  <encoder class="net.logstash.logback.encoder.LogstashEncoder" />
  ...
</configuration>

5.如何使用logback异步记录？

答：使用AsyncAppender，例如：

<configuration>
  ...
  <appender name="ASYNC" class="ch.qos.logback.classic.async.AsyncAppender">
    <queueSize>512</queueSize>
    <appender-ref ref="CONSOLE"/>
  </appender>

  <root level="INFO">
    <appender-ref ref="ASYNC"/>
  </root>
  ...
</configuration>