Spring Boot - 部署为 WAR 时从 WEB-INF/ 文件夹加载“logback.xml”

Question

我正在努力将传统的 Spring MVC 应用程序更新为 Spring Boot（部署为 WAR）。

一个要求是，为了保持与我们的远程安装的兼容性，logback.xml 文件需要位于部署的 webapp 中的以下位置：

webapp/WEB-INF/logback.xml

在项目源中，如果我将文件放在src/main/webapp/WEB-INF/logback.xml，它会成功复制到webapp/WEB-INF/logback.xml，但我找不到从该位置加载和使用它的方法。

我尝试将 Spring Boot logging.config 属性设置为以下内容：

logging.config=/WEB-INF/logback.xml

希望自动配置能够解决这个问题，但这会失败且不会显示错误消息，而是会加载默认的 Spring Boot 日志配置。

使用 Spring Boot 处理此问题的正确方法是什么？ （欢迎使用示例代码）

Answer 1

事实证明这需要破解：

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

    // In case of regular deployments, use WEB-INF/logback.xml
    @Override 
    public void onStartup(final ServletContext servletContext) throws ServletException {
        super.onStartup(servletContext);
        configureLogging(servletContext);
        LoggerFactory.getLogger(getClass()).info("Done configuring");
    }

    // manually configure logging
    private void configureLogging(final ServletContext servletContext) {
        try {
            String realPath = servletContext.getRealPath("/WEB-INF/logback.xml");
            LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
            JoranConfigurator configurator = new JoranConfigurator();
            configurator.setContext(context);
            context.reset();
            configurator.doConfigure(realPath);
        } catch (JoranException je) {
            // StatusPrinter will handle this
        }
    }

    public static void main(String[] args) throws Exception {
        SpringApplication.run(Application.class, args);
    }

}

另外，我在src/main/resources 中有 logback-spring.xml：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="logback-include.xml" />
</configuration>

和src/main/resources中的logback-include.xml，有一些共同的配置：

<?xml version="1.0" encoding="UTF-8"?>
<included>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />

    <!-- put your loggers here -->
    <logger name="org.springframework.web" additivity="false" level="INFO">
        <appender-ref ref="CONSOLE"/>
    </logger>

    <!-- put your root here -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
</included>

最后，src/main/webapp/WEB-INF 中的 logback.xml 像 logback-spring.xml 一样导入了通用配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="logback-include.xml" />
</configuration>

Answer 2

将logback.xml 放入src/main/webapp/WEB-INF/ 会导致文件被复制到webapp/WEB-INF/，这是类路径上webapp/WEB-INF/classes/ 之上的目录级别。试着把它放在你的application.properties：

logging.config=classpath:../logback.xml

这样logback.xml 将在初始化期间正确定位。看看Common Application Properties，例如classpath: 的用法，它用于表示application.properties 中类路径的位置。

虽然，老实说，我宁愿在src/main/webapp/WEB-INF/ 中将logback.xml 设为classes/logback.xml 的符号链接（这对部署很有意义（并且在您的远程安装中很有用），因为@987654334然后@ 将链接到webapp/WEB-INF/classes/logback.xml）并通过将logback.xml 放入src/main/resources（将被复制到webapp/WEB-INF/classes/）使我的spring-boot 应用程序更加传统。由于我不知道您的远程安装的具体细节以及您所说的兼容性是什么意思，所以这可能有效，也可能无效。