异常作为 Spring @Value() 的默认值

Question

我是 Java/Spring 的新手。我需要从配置中读取一些值，但如果它不存在，它应该会失败。现在我有以下代码：

public class SomeClass {

    @Value("${some.property:#{null}}")
    private String someProperty;

    public void someMethod() throws Exception {
        if (someProperty == null) throw new AopConfigException("The property must be set");
    }

}

它工作正常，但我需要添加额外的 if 块。我可以写这样的东西吗？

@Value("${some.property:#{throw new AopConfigException(\"The property must be set\")}}")
private String someProperty;

或

@Value("${some.property:#{throwException()}}")
private String someProperty;

private static void throwException() {
    throw new AopConfigException("The property must be set");
}

立即失败

更新： 如果我不使用下面建议的一些默认值，那么它对我来说仍然不会失败。我没有java.lang.IllegalArgumentException：

Answer 1

@Value 默认是必需的。所以，只需使用

@Value("${some.property}")

而不是

@Value("${some.property:#{null}}")

因此，如果该属性不存在，您的应用程序将无法启动，并出现如下异常：

Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'invalid.value' in value "${invalid.value}"

更新：如果您想拥有一个可以像这样为空的密钥：

some.property=

如果该属性为空，您想抛出异常，则使用@PostConstruct，如下所示：

    @PostConstruct
    public void validateValue() {
        if (someProperty.isEmpty()) {
            throw new MyNiceException("error");
        }
    }

更多更新：如果您想在没有注册表项的情况下初始化 null

    @Value("${some.property:#{null}}")
    private String someProperty;

然后这样做：

        @PostConstruct
        public void validateValue() {
            if (someProperty == null) {
                throw new IllegalArgumentException("error");
            }
        }

Answer 2

为了使属性替换起作用，您需要像这样 (example taken from here) 将 PropertySourcesPlaceholderConfigurer bean 添加到您的配置中：

@Bean
public static PropertySourcesPlaceholderConfigurer properties(){
  final PropertySourcesPlaceholderConfigurer pspc = new PropertySourcesPlaceholderConfigurer();
  // add your property files below
  final Resource[] resources = new ClassPathResource[]{new ClassPathResource("foo.properties")};
  pspc.setLocations( resources );
  // this will make the replacement fail, if property is not known
  pspc.setIgnoreUnresolvablePlaceholders(false); 
  return pspc;
}

如果您已经使用 @PropertySource 注释配置您的属性源，您应该能够省略手动将资源添加到 PropertySourcesPlaceholderConfigurer，因为它应该自动从 spring 环境中获取值。

一旦这个 bean 就位，只需使用

@Value("${data.import.path}")

没有默认值（正如其他答案中已经提到的），您的应用程序的初始化将在很早的阶段失败。

Answer 3

恐怕您不能仅使用@Value 注释来做到这一点。但是，您可以通过使用 spring 环境读取值来检查是否设置了某个属性。如果未设置该值，则会抛出 IllegalStateException。

因此，例如，如果您有环境变量，例如：

@Autowired
private ConfigurableEnvironment env;

然后就可以通过调用getRequiredProperty方法来初始化值了：

<T> T getRequiredProperty(java.lang.String key, java.lang.Class<T> targetType) 
      throws java.lang.IllegalStateException

因此，对于您的用例，您可以像这样初始化您的 bean：

@Bean
public SomeClass someClass () {

  String someProperty = env.getRequiredProperty ("some.property");

  return new SomeClass (someProperty);
}

Answer 4

只需在 post 构造中进行验证，以确保它在 bean 创建后立即运行：

@PostConstruct
private static void throwException() {
  if (someProperty == null) {
    throw new AopConfigException("The property must be set");
  }
}

Answer 5

请不要为您的属性提供默认值，例如 @Value("${some.property}")

如果没有设置属性，spring 将通过异常处理，你就做对了。