如何根据属性有条件地使 Spring Boot 应用程序在启动时终止

Question

我想实现以下用例 - 我的 Spring Boot 应用程序只有在设置了 application.yaml 中的某个属性时才应该启动：

myapp:
  active: true

如果未设置该属性，则上下文初始化应失败并显示该属性缺失的消息。

我在这个主题中找到了如何实现它：Spring Boot - Detect and terminate if property not set? 但是我不能遵循这种方法的问题是，在检查这个属性的 bean 加载之前上下文初始化可能会失败。

例如，如果某个其他 bean 因缺少另一个属性而无法加载，那么上下文初始化将在此时失败，并且检查所需属性的我的 bean 将不会被加载。这对我来说不行，因为我希望在加载任何其他 bean 之前先检查 myapp.active 属性。

我想要这样的原因是在运行应用程序时应该设置某个配置文件 - application-[profile].yaml 包含 myapp.active: true 和加载上下文所需的其他一些强制属性。

我希望我的应用程序总是因为 myapp.active 不正确而失败，以便我可以输出一条有意义的消息，告知配置文件丢失并且该应用程序必须使用其中一个配置文件运行（来自给定的配置文件列表)。一些不是开发人员的人正在运行该应用程序，所以我希望他们知道为什么该应用程序没有运行，否则他们会认为该应用程序中存在一些错误。

我怎样才能做到这一点？是否有可能在加载 bean 之前以某种方式读取属性？我想避免在所有 bean 上设置 @DependsOn（或通过 BeanPostProcesser 做同样的事情）并寻求更优雅的解决方案。

Answer 1

如果您使用属性条件，应用程序将不会启动。够快吗？

 @SpringBootApplication
 @ConditionalOnProperty(name = "myapp.active")
 public class FastFailWhenPropertyNotPresentApplication {

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

}

基本上@SpringBootApplication 只是一个@Configuration 类。

您有一个选项matchIfMissing，可用于指定如果未设置属性，条件是否应匹配。默认为 false。

编辑：

更好的解决方案是通过@ConfigurationProperties 结合@Validated 来配置您的属性，这样您就可以使用 javax.validation.constraints 注释。

package stackoverflow.demo;

import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.NotNull;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

@Component
@ConfigurationProperties(prefix = "myapp")
@Validated
public class MyAppProperties {

  @AssertTrue
  @NotNull
  private Boolean active;

  public Boolean getActive() {
    return active;
  }

  public void setActive(Boolean active) {
    this.active = active;
  }

}

注意：你可以省略@ConditionalOnProperty(name = "myapp.active")

将@AssertTrue 与@NotNull 结合使用，因为@AssertTrue认为空元素是有效的。

spring-boot 会免费生成一个不错的错误消息：

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'myapp' to stackoverflow.demo.MyAppProperties failed:

    Property: myapp.active
    Value: false
    Origin: class path resource [application.properties]:1:16
    Reason: must be true


Action:

Update your application's configuration

---

编辑（更新问题后）

---

更快的方法：您的应用程序不会启动，也不会加载应用程序上下文

package stackoverflow.demo;

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.core.io.ClassPathResource;

@SpringBootApplication
public class FastFailWhenPropertyNotPresentApplication {

  static Boolean active;

  static {

    YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
    yaml.setResources(new ClassPathResource("application.yaml"));

    active = (Boolean) yaml.getObject().getOrDefault("myapp.active", false);

  }


    public static void main(String[] args) {
        if (!active) {
          System.err.println("your fail message");
        } else {
          SpringApplication.run(FastFailWhenPropertyNotPresentApplication.class, args);
        }
    }

}

---

编辑

另一种可能最适合您需求的解决方案...

通过收听ApplicationEnvironmentPreparedEvent

在 {@link SpringApplication} 启动时发布的事件并且 * {@link Environment} 首先可用于检查和修改。 *

注意：您不能使用@EventListener，但您已将侦听器添加到SpringApplication

package stackoverflow.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
import org.springframework.context.ApplicationListener;

@SpringBootApplication
public class FastFailWhenPropertyNotPresentApplication {


  static class EnvironmentPrepared implements ApplicationListener<ApplicationEnvironmentPreparedEvent>{
    @Override
    public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
      Boolean active = event.getEnvironment().getProperty("myapp.active",Boolean.class,Boolean.FALSE);
      if(!active) {
        throw new RuntimeException("APPLICATION FAILED TO START: ACTIVE SHOULD BE TRUE ");
      }
    }
  };


  public static void main(String[] args) throws Exception {
    SpringApplication springApplication = new SpringApplication(FastFailWhenPropertyNotPresentApplication.class);
    springApplication.addListeners(new FastFailWhenPropertyNotPresentApplication.EnvironmentPrepared());
    springApplication.run(args);
  }

}

Answer 2

一种选择是创建一个 bean 来检查属性是否存在，如果没有设置属性，则在 bean 创建期间抛出异常。

@Component
public static EnsureApplicationActive {
    @Value("${myapp.active}")
    private Boolean active;

    @PostConstruct
    public void ensureApplicationActive() {
        if (!Boolean.TRUE.equals(active)) {
            throw new IllegalStateException("TODO: Meaningful message goes here");
        }
    }
}