Spring Boot使用Logback

USING LOGBACK WITH SPRING BOOT

Logback 为企业应用程序制作了一个优秀的日志框架-它的速度快, 具有简单但功能强大的配置选项, 而且内存占用小。在我的入门帖子中已经介绍了 logback , logback 介绍: 企业日志框架。在 Logback 的一系列帖子中, 我还讨论了如何使用 XML 和 Groovy 配置 Logback。这些帖子可用作 Logback 配置: 使用 XML 和 Logback 配置: 使用 Groovy。

在这篇文章中, 我将讨论在Spring Boot中如何使用 Logback。虽然 Java 有许多日志框架选项, 但 Spring boot选择了使用 Logback 作为默认记录器。像Spring boot 里的许多东西一样, 默认情况下, Logback 会使用合理的默认值进行配置。开箱即用, Spring Boot 使 Logback 易于使用。

Creating Loggers

在上一个帖子中, 我写了有关使用 Spring boot创建 web 应用程序的内容。我们将为这个应用程序配置 logback。该应用程序包含一个控制器, 加日志代码到IndexController控制器。IndexController的最终代码如下：

package guru.springframework.controllers; 
 
import guru.springframework.helpers.SpringLoggingHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
 
@Controller
public class IndexController {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    @RequestMapping("/")
    String index(){
        logger.debug("This is a debug message");
        logger.info("This is an info message");
        logger.warn("This is a warn message");
        logger.error("This is an error message");
        new SpringLoggingHelper().helpMethod();
        return "index";
    }
}

让我们为应用程序添加一个具有日志代码的 SpringLoggingHelper 类。尽管此类除了发出日志记录语句之外什么都不做, 但它将帮助我们了解如何在不同的包中配置日志记录。代码如下：

package guru.springframework.helpers;
 
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
public class SpringLoggingHelper {
    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    public void helpMethod(){
        logger.debug("This is a debug message");
        logger.info("This is an info message");
        logger.warn("This is a warn message");
        logger.error("This is an error message");
 
    }
}

在上面的两个类中, 我们编写了针对 SLF4J API 的日志记录代码。SLF4J 是通常使用的日志框架的门面, 例如 Java .Util.Logging、Log4J 2 和 Logback。通过对SLF4J的编写,我们的代码仍然与Logback分离,从而为我们提供了在不同的日志框架中切换的灵活性,如果以后需要的话修改其他日志框架，是很方便的

如果您想知道 SLF4J 和 Logback 依赖关系的话, 这将不需要指定任何内容。Spring Boot也包含它们。假设您使用 Maven 或 Gradle 管理 spring boot项目, 则必要的依赖项是 spring boot下的依赖项的一部分。运行 SpringBootWebApplication 主类。当应用程序启动时,使用 URL从浏览器访问http://localhost:8080,IntelliJ控制台上的日志记录输出为：

我们还没有为 Logback 写任何配置。IndexController 和 SpringLoggingHelper 类的输出都来自 logback 根记录器。请注意, DEBUG消息未被记录。默认情况下, Logback 将记录DEBUG级别消息。但是, spring boot团队为我们提供了在 spring 启动默认 Logback 配置文件 (base.xml) 。此外, Spring boot提供了两个预配置的附加目的地通过console-appender. xml 和文件file-appender.xml。base.xml 文件引用它们。

以下是从git上找到spring-boot用的base.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->
<included>
	<include resource="org/springframework/boot/logging/logback/defaults.xml" />
	<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
	<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
	<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="FILE" />
	</root>
</included>

在这里, 您可以看到 Spring boot已通过将根记录器设置为INFO来覆盖 Logback 的默认日志记录级别, 这是我们在上面的示例中没有看到调试消息的原因。正如我们在下一节中看到的, 在 Spring boot中更改日志级别非常简单

Configuration via Spring Boot’s application.properties File

在 Spring boot应用程序中, 可以将配置具体化为在不同环境中使用相同的应用程序代码。application.properties文件很可能是几种不同的方式来外部化 Spring boot配置属性的最流行的方法。在 Spring boot web 应用程序的默认结构中, 可以在 "Resources" 文件夹下定位application.properties文件。在application.properties文件中, 可以定义 Spring boot日志级别、应用日志日志级别、Hibernate日志级别、Thymeleaf 日志级别等。还可以定义一个日志文件, 以将日志消息写入到控制台之外。

下面是application.properties文件的日志配置

logging.level.org.springframework.web=INFO
logging.level.guru.springframework.controllers=DEBUG
logging.level.org.hibernate=ERROR
logging.file=logs/spring-boot-logging.log

注意: 还有一个logging.path 属性, 用于指定记录文件的路径。如果使用它, Spring boot会在指定路径中创建一个 spring.log 文件。但是, 不能同时指定logging.file和logging.path属性。如果同时配置，Spring Boot将全部忽略。

当您现在运行main 类并访问应用程序时, 从 IndexController 和 SpringLoggingHelper 的日志消息将记录到控制台和logs/spring-boot-logging.log文件。

在输出中, 请注意, IndexController 的DEBUG和更高级别的消息被记录到控制台和文件中。这是因为在application.properties文件中, 我们指定了DEBUG作为 guru.springframework.controllers 包的日志级别, IndexController 是其中的一部分。由于我们没有显式配置 SpringLoggingHelper 类, 所以使用了base.xml 文件的默认配置。因此, 仅记录了 SpringLoggingHelper 的信息和更高级别的消息。


当需要为特定类或包获取更详细的日志消息时, 可以看到这是多么简单。

Logback Configuration through an External File

Logback通过application.properties文件对于许多 Spring boot应用程序来说都是足够的。但是, 大型企业应用程序可能具有更复杂的日志记录要求。正如我前面提到的, Logback 通过 XML 和 Groovy 配置文件支持高级日志记录配置。

在 Spring boot应用程序中, 可以在项目类路径中指定Logback配置文件 logback.xml或 logback-spring.xml。不过, spring boot团队建议使用 spring 变体来进行日志配置, logback-spring. xml 比 logback xml 更可取。如果使用标准 logback 配置, 则 Spring boot可能无法完全控制日志初始化。

下面是 logback-spring.xml文件的代码。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml"/>
    <logger name="guru.springframework.controllers" level="WARN" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </logger>
    <logger name="guru.springframework.helpers" level="WARN" additivity="false">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </logger>
 </configuration>

在上面的配置代码中, 我们将base.xml文件在第三行引入, 注意到我们没有配置任何appenders。相反, 我们依赖于CONSOLE和FILE, 这些都是由 Spring boot提供的。

通过更新的 Spring boot Logback 配置, 我们的日志输出现在看起来像这样:

注意: spring boot期望 logback-spring.xml的配置文件放在类路径上。但是, 您可以将其存储在其他位置, 并使用应用程序中的application.properties文件中指定logging.config属性改变它

注意：如果 logback-spring.xml放在Spring boot resources目录，写法如下

       logging.config=classpath:logback-spring.xml

Spring Boot Profiles in Logging

在本地计算机中开发时, 通常要将日志级别设置为 "DEBUG"。这将为您的开发使用提供详细的日志消息。在生产时, 其典型设置为WARN或以上的日志级别。这是为了避免在生产中运行时使用过多的调试信息和记录开销来填充日志。虽然日志记录非常有效, 但仍有成本。

spring boot通过将 logback 配置的 spring 配置文件扩展到 <springProfile> 元素来满足这些要求。在 logback 文件中使用此元素, 可以根据活动的 spring 配置文件选择包含或排除日志配置。

注意: 对 <springProfile> logback 配置的支持可从SpringBoot 1.3.0.M2里程碑开始。

下面是一个 XML 示例, 用于使用活动的 Spring 配置文件配置 Logback。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <springProfile name="dev,staging">
        <logger name="guru.springframework.controllers" level="DEBUG" additivity="false">
            <appender-ref ref="CONSOLE" />
        </logger>>
    </springProfile>
    <springProfile name="production">
        <logger name="guru.springframework.controllers" level="WARN" additivity="false">
            <appender-ref ref="FILE" />
        </logger>
    </springProfile>
 </configuration>

在上面的配置代码中, 对于dev和staging profiles, 我们配置了 guru.springframework.controllers 记录器, 以便将DEBUG和更高级别的消息记录到控制台。对于生产配置文件, 我们配置了相同的记录器, 以便将警告和更高级别的消息记录到文件中。
若要将配置文件传递给应用程序, 请使用 -Dspring.profiles.active=  JVM 参数运行应用程序。
对于本地开发, 在 IntelliJ 中, 选择 "运行-编辑配置", 然后在 "运行/调试配置" 对话框中设置 JVM 参数, 如下所列。

现在, 当我们使用dev配置文件运行应用程序时, 我们将看到以下日志输出

在上述输出中, 观察 IndexController 的测井输出。根据dev文件的配置, 调试和更高的日志消息被记录到控制台。您可以使用production文件重新启动应用程序, 以确保将警告和更高的日志消息记录到文件中。

Conditional Processing of Configuration File

Logback 支持在 Janino 库的帮助下对配置文件进行条件处理。可以使用配置文件中的 <if>、<then> 和 <else> 元素来针对多个环境。要执行条件处理, 请将 Janino 依赖项添加到您的 Maven POM, 如下所愿。

<dependency>
   <groupId>org.codehaus.janino</groupId>
   <artifactId>janino</artifactId>
   <version>2.7.8</version>
</dependency>

完整的logback-spring.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <springProfile name="dev,staging">
        <logger name="guru.springframework.controllers" level="DEBUG" additivity="false">
            <appender-ref ref="CONSOLE" />
        </logger>>
    </springProfile>
    <springProfile name="production">
    <logger name="guru.springframework.controllers" level="WARN" additivity="false">
        <appender-ref ref="FILE" />
    </logger>
    </springProfile>
    <if condition='property("spring.profiles.active").contains("dev")'>
        <then>
            <logger name="guru.springframework.helpers" level="DEBUG" additivity="false">
                <appender-ref ref="CONSOLE" />
            </logger>
        </then>
        <else>
            <logger name="guru.springframework.helpers" level="WARN" additivity="false">
                <appender-ref ref="FILE" />
            </logger>
        </else>
    </if>
</configuration>

在上面的代码中, 我们在 <if> 元素中指定了一个条件, 以检查当前active profile 是否包dev。如果条件计算结果为 true, 则 <then> 元素内的配置代码将执行。在 <then> 元素中, 我们配置 guru.springframework.helpers 将DEBUG和更高的消息记录到控制台。我们使用 <else> 元素来配置记录器, 以便将WARN和更高的消息记录到日志文件中。<else> 元素为dev以外的任何配置文件执行。

当您使用生产配置文件运行应用程序并对其进行访问时, 两个记录器都会将警告和更高的消息记录到日志文件中, 类似于此。

对于开发人员配置文件, 两个记录器都会将调试和更高的消息记录到控制台, 类似于此。

Logback Auto-Scan Issue with Spring Boot

在 logback-spring.xml文件中, 可以通过设置scan="true" 属性启用对配置的自动扫描。启用自动扫描后, Logback 扫描配置文件中的更改。对于任何更改, Logback 会自动使用它们进行重新配置。通过将时间段传递给 scanPeriod 属性, 可以指定扫描期间, 并以毫秒、秒、分钟或小时为单位指定值。

例如, 此代码告诉 Logback 在每10秒后扫描 Logback-spring. xml。

<configuration debug="true" scan="true" scanPeriod="10 seconds" > 
  ...
</configuration>

Spring boot Logback 的一个限制是, 使用 springProfile 和 springProperty, 设置自动扫描会导致错误。

//Error on using auto-scan with springProfile

-ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:39 - no applicable action for [springProfile],   
 current ElementPath  is [[configuration][springProfile]]

//Error on using auto-scan with springProperty

 -ERROR in ch.qos.logback.core.joran.spi.Interpreter@12:125 - no applicable action for [springProperty],    
 current ElementPath  is [[configuration][springProperty]]

错误是由于不兼容问题而发生的。Spring boot使用 JoranConfigurator 子类支持 springProfile 和 springProperty。不幸的是, Logback 的 ReconfigureOnChangeTask 并没有提供一个钩子插入它。

Conclusion

Logback 在开源社区中的流行趋势。许多流行的开源项目使用 Logback 来满足他们的日志需求。Apache Camel, Gradle只是几个例子。

Logback 显然具有处理复杂企业应用程序中的日志记录需求的能力。所以, 难怪Spring boot 团队为默认的日志记录实现选择 Logback。正如您在这篇文章中看到的, Spring boot 团队提供了与 Logback 的良好集成。出框, Logback 准备使用Spring boot。 在 这 篇文章 中 ,   您 已经 看到 了在 您 的 日志 要求 不断 变化 的情况 下 ,  在   Spring  boot 中 配置   Logback   是 多么 容易

翻译自:https://springframework.guru/using-logback-spring-boot/

我现在用的配置方式(每天晚上对当天log进行压缩存储，一天一个压缩包)

<?xml version="1.0" encoding="UTF-8"?> 
<configuration>
    
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%t] [%C#%M:%L] - %msg%n</pattern>
        </encoder>
    </appender>
    
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
       <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
          <fileNamePattern>${root}/logs/stream-collector-%d{yyyyMMdd}.log.zip</fileNamePattern>
          <maxHistory>10</maxHistory>
       </rollingPolicy>
       <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%t] [%C#%M:%L] - %msg%n</pattern>
        </encoder>
    </appender>
    
    <root level="debug">
      <appender-ref ref="STDOUT" />
      <appender-ref ref="FILE" />
   </root>

</configuration>