如何在 Spring Boot 中指定 logback.xml 文件的位置？

1、概览

日志记录是任何软件应用的重要组件，用于监控、调试和维护系统的健康状况。在 Spring Boot 生态系统中，Logback 作为默认的日志记录框架，提供了灵活和强大的功能。虽然 Spring Boot 简化了应用的许多方面，但有时仍然需要通过 logback.xml 配置文件来配置 Logback 以满足特定要求。

本文将会带你了解如何在 Java、Spring Boot 应用中指定 logback.xml 配置文件的位置。

2、logback.xml

logback.xml 文件是 Logback 的配置文件，用于定义日志记录规则、appender 和日志格式（log format）。

默认情况下，Logback 会在 classpath 根目录中搜索该文件。这意味着将 logback.xml 文件放在 Spring Boot 项目的 src/main/resources 目录中就足够了，因为 Logback 会在运行时自动检测到它。不过，在某些情况下，自定义其位置也是必要的。

3、指定 logback.xml 位置

3.1、使用 System Properties

如果 logback.xml 配置文件不在打包后的 Jar 中，可以使用 System Properties 指定其位置。例如，在运行 Spring Boot 应用时，可以使用 JVM 参数：

java -Dlogback.configurationFile=/path/to/logback.xml -jar application.jar

命令 -Dlogback.configurationFile=/path/to/logback.xml 将系统属性 logback.configurationFile 设置为指定路径，指定 Logback 使用提供的配置文件。

3.2、编程式配置 logback.xml 的位置

在某些情况下，我们可能需要在 Spring Boot 应用中以编程式配置 logback.xml 配置文件的位置，实现这一目标的方法之一是使用专用的配置组件来封装设置 logback.xml 位置的逻辑。

首先，创建一个配置组件来设置 logback.xml 的位置：

@Component
public class LogbackConfiguration {
    public void setLogbackConfigurationFile(String path) {
        System.setProperty("logback.configurationFile", path);
    }
}

在上述组件中，定义了一个 setLogbackConfigurationFile() 方法，该方法将 logback.xml 文件的路径作为参数，并相应地设置 logback.configurationFile 系统属性。

接下来，编写一个单元测试来验证 LogbackConfiguration 组件是否正确设置了 logback.xml 的位置：

public class LogbackConfigurationTests {
    @Autowired
    private LogbackConfiguration logbackConfiguration;

    @Test
    public void givenLogbackConfigurationFile_whenSettingLogbackConfiguration_thenFileLocationSet() {
        String expectedLocation = "/test/path/to/logback.xml";
        logbackConfiguration.setLogbackConfigurationFile(expectedLocation);
        assertThat(System.getProperty("logback.configurationFile")).isEqualTo(expectedLocation);
    }
}

在此测试中，自动装配 LogbackConfiguration 组件，并使用预期的 logback.xml 位置调用其 setLogbackConfigurationFile() 方法。然后，验证系统属性是否正确设置为预期位置。

为确保通过编程式配置的 logback.xml 位置的有效性，LogbackConfiguration 中的配置逻辑必须在应用启动时运行。如果在应用初始化过程中未初始化此配置组件，可能会导致在运行时未应用配置，从而可能导致意外行为或忽略指定的 logback.xml 文件位置。

通过将修改定义 logback.xml 位置的 logback.configurationFile 系统属性的逻辑封装在一个专用的配置组件中，并确保该配置逻辑在应用程序启动时运行，从而保证了整个应用生命周期中 logback.xml 配置的可靠性和一致性。

4、 Spring Boot 的配置属性

Spring Boot 本身提供了指定 logback.xml 配置文件地址的配置属性：

logging.config=classpath:spring-logback.xml

Spring Boot 并不推荐使用 logback.xml 作为 Logback 配置文件的名称。 这是因为，logback.xml 是 Logback 的默认配置文件名称，因此 Logback 会早于 Spring 加载此配置文件。而 Spring 对 Logback 配置文件有一套自己的解析机制以及各种预定义的配置，如果让 Logback 先于 Spring 加载了配置，那么可能会导致 Spring 的特殊配置失效。

所以，上述配置示例中指定的配置文件名称为 spring-logback.xml 而不是默认的 logback.xml，这是推荐的做法。

5、总结

本文介绍了如何在 Spring Boot 应用中指定 logback.xml 配置文件的位置，以及需要注意的地方。

Ref：https://www.baeldung.com/java-logback-xml-custom-location