如何在 Spring Boot 中设置外部配置的路径

Question

我的问题是关于 spring boot (v 2.2.x) 中配置的另一个问题，但与关于 configs (即spring boot external config ) 的现有帖子中的配置相比，我的配置结构有一个显着差异我有以下应用程序配置：

--src\
     --main\
            --resources\
                -- application.yml
                -- application-local.yml
                -- application-dev.yml
                -- application-prod.yml

我的 application-prod.yml 看起来像：

spring:
  profiles: 
    active: prod
    include:
      customization
  
logging:
  level:
    root: INFO
    org.springframework: INFO
    org.hibernate.SQL: INFO
    org.hibernate.type: INFO
  pattern:
    console: '%d{yyyy-MM-dd HH:mm:ss} - %msg%n'
    file: '%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n'
  file: ./logs/goals-service.log

我的 prod 配置必须使用（这是业务要求）外部配置和设置

• 数据库连接，
• 安全设定
• 其他服务的端点和凭据。

我想使用标准方法和 spring 自动配置 bean 的能力，我不想手动加载一些属性文件并手动配置所有 bean。 因此，为了解决这个问题，我创建了另一个配置 application-customization.yml 并通过包含将其链接到 prod 配置中（参见上面的示例）。 在这里我遇到了一个问题：我无法通过命令行参数（-Dspring.config.location 或任何它的变体）选择 application-customization.yml 的路径，但是当我将外部配置放在目录中时我可以加载自定义设置用于启动应用程序（这是 spring 搜索配置的行为），并且在这种情况下应用程序工作正常。 我想传递应用程序应该在哪里搜索我的 application-customization.yml 的路径，还有一件事我不能使用符号链接从实际配置位置链接到 ./application-customization.yml。

Answer 1

从您的应用程序开发中删除该“包含”，因为我不知道它将如何与我要说的任何内容进行交互。 然后（至少）有两种简单的方法可以做你想做的事。 （也有一些复杂的方式-大材小用您的情况，确实大多数情况下-像重写这个或定义的一个这些。）

方式 1：将-Dspring.config.location=X传递给 JVM，其中 X 是包含 Spring 应读取的文件的位置的逗号分隔列表。 在您的情况下，您可能需要-Dspring.config.location=file:/some/folder/,classpath:/ ; 第一个位置将确保您满足您的业务需求，第二个位置将确保应用程序也读取其自己的 jar 中的 application-dev.yml。

方式2：将@PropertySource("file:/some/folder/application.properties")放在用@Configuration注释的类上（注意@SpringBootApplication是用@Configuration元注释的）。 这有两个问题：一，最后读取@PropertySource的文件，并且其中的属性不会覆盖之前读取的属性； 二、有些属性不能用@PropertySource文件设置（因为在启动过程中读取文件太晚）。 我不认为任何一个问题都会打扰你，但我想为其他读者注意它们。

注意 Tomcat（可能还有其他容器）：使用方式 1 有点复杂，因为spring.config.location是系统属性； 它可能需要处理特定于应用程序的 web.xml 文件。 编辑2020年9月4日：或者你可以做这个（特别是在该代码，这是我重复第三代码段，修改属性名称和值，如果这个问题的答案永远消失：

public class ServletInitializer extends SpringBootServletInitializer {
    
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(MyApplication.class).properties("spring.config.location: /my/config1/,/my/config2/");
        }
}

）... 哪个更好。

这个答案主要是对有关此问题和相关问题的优秀官方文档的反刍。