是否可以在自定义Spring Boot启动器中设置默认application.yml？

Question

我的自定义spring boot starter和作为依赖项使用的spring boot应用程序消费者面临一个问题。我在两份申请中都有。yml但似乎我正在寻找的配置只有在消费者中定义时才有效。

我在starter中的配置如下：

@Getter
@Setter
@Configuration
@ConfigurationProperties(prefix = "security")
public class StarterSecurityConfig {
    private boolean jwtEnabled;
    private String[] unsecuredPaths;
    private String[] securedPaths;
}

我在自动配置类中定义了这个bean：

@Bean
public StarterSecurityConfig starterSecurityConfig() {
    return new StarterSecurityConfig();
}

拥有此应用程序的使用者可以完美地检索到它。yml和其他变量：

    security:
  jwt-enabled: true
  secured-paths:
    - /user/**
  unsecured-paths:
    - /**

但如果我将其从消费者中删除并放入应用程序中。启动程序bean在创建它们时没有这些属性。

也许我错过了什么？

Answer 1

您可以尝试在启动器本身上初始化成员变量。如果消费者想要覆盖他们可以用他们的应用程序配置来实现的值。

@Getter
@Setter
@Configuration
@ConfigurationProperties(prefix = "security")
public class StarterSecurityConfig {
    private boolean jwtEnabled = true;
    private String[] unsecuredPaths = { "/user/**" };
    private String[] securedPaths = { "/**" };
}

Fews更多想法：

我将使jwtEnable为false，并从上面的类中删除@Configuration和@ConfigurationProperties，并使用其他bean创建一个SecurityAutoConfiguration类。

@Configuration
public class SecurityAutoConfiguration{

   @Bean
   @ConfigurationProperties(prefix = "security")
   public StarterSecurityConfig starterSecurityConfig(){
     return new StarterSecurityConfig();
   }

   @Bean
   @ConditionalOnProperty(value="security.jwtEnabled", havingValue = "true")
   public JwtService jwtService(StarterSecurityConfig starterSecurityConfig) {
     return new JwtService(starterSecurityConfig);
   }   

}

消费者将能够使用启用标志使用其应用程序配置启用或禁用security.jwt安全启动器。

Answer 2

如果我正确理解了你的问题，就在上周我遇到了这样的问题...我正在检查这个问题，我有一些发现（官方留档不支持它们）：如果你添加了依赖项并想使用它的资源，你有一个情况，当两个application.yml文件具有相同的位置-classpath：application.yml，并且或者它们不能一起加载，或者其中一个被另一个覆盖。无论如何，在我的应用程序中，它不起作用。

如果您只需要从依赖配置文件加载配置，那么这是一个简单明了的解决方案—重命名它并以可能的方式加载（从YAML、属性源的初始值设定项等手动加载）

但是，如果这个配置文件应该在任何地方使用，我们可以在上下文中手动加载属性。在依赖项（在您的情况下是消费者）中创建另一个配置文件，例如，@配置类中的consumer-application.yml和下一个bean：

@Bean
public static PropertySourcesPlaceholderConfigurer properties() {
    var propertySourcesPlaceholderConfigurer = new PropertySourcesPlaceholderConfigurer();
    var yamlPropertiesFactoryBean = new YamlPropertiesFactoryBean();
    yamlPropertiesFactoryBean.setResources(new ClassPathResource("consumer-application.yaml"));
    propertySourcesPlaceholderConfigurer.setProperties(yamlPropertiesFactoryBean.getObject());
    return propertySourcesPlaceholderConfigurer;
}

您可以使用@Value在两个应用程序中使用YAML文件中的属性。

但最简单的方法是使用属性配置。在这种情况下，您只需在consumer和PropertySource（value={“classpath：application.properties”，“classpath：consumer application.properties”）中设置PropertySource（“classpath：consumer application.properties”），在我的情况下，这两个变体都可以正常工作。