Spring @Value无法取值多个properties文件如何解决

在Spring框架中，@Value注解通常用于从配置文件中注入属性值。然而，当项目中有多个properties文件时，可能会遇到@Value无法正确取值的问题。本文将探讨这一问题的原因，并提供几种解决方案。

问题描述

假设我们有两个properties文件：application.properties和custom.properties。我们希望从这两个文件中读取属性值，并使用@Value注解将它们注入到Spring Bean中。

# application.properties
app.name=MyApp
app.version=1.0.0

# custom.properties
custom.property1=value1
custom.property2=value2

在Spring配置类中，我们可能会这样配置：

@Configuration
@PropertySource("classpath:application.properties")
@PropertySource("classpath:custom.properties")
public class AppConfig {
    // ...
}

然后在某个Bean中使用@Value注解：

@Component
public class MyBean {

    @Value("${app.name}")
    private String appName;

    @Value("${custom.property1}")
    private String customProperty1;

    // ...
}

然而，运行时会发现customProperty1无法正确注入，导致null值。

问题原因

Spring的@PropertySource注解默认情况下只会加载第一个指定的properties文件，后续的@PropertySource注解会被忽略。因此，custom.properties文件中的属性无法被加载，导致@Value无法正确取值。

解决方案

1. 使用PropertySourcesPlaceholderConfigurer

可以通过显式配置PropertySourcesPlaceholderConfigurer来确保所有properties文件都被加载。

@Configuration
public class AppConfig {

    @Bean
    public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        configurer.setLocations(
            new ClassPathResource("application.properties"),
            new ClassPathResource("custom.properties")
        );
        return configurer;
    }
}

2. 使用@PropertySources注解

Spring 4.0引入了@PropertySources注解，可以用于指定多个@PropertySource。

@Configuration
@PropertySources({
    @PropertySource("classpath:application.properties"),
    @PropertySource("classpath:custom.properties")
})
public class AppConfig {
    // ...
}

3. 使用Environment对象

可以通过注入Environment对象来手动获取属性值。

@Component
public class MyBean {

    @Autowired
    private Environment env;

    public void someMethod() {
        String appName = env.getProperty("app.name");
        String customProperty1 = env.getProperty("custom.property1");
        // ...
    }
}

4. 使用@ConfigurationProperties

如果属性较多，可以考虑使用@ConfigurationProperties注解来批量注入属性。

@Configuration
@ConfigurationProperties(prefix = "app")
public class AppProperties {

    private String name;
    private String version;

    // getters and setters
}

@Configuration
@ConfigurationProperties(prefix = "custom")
public class CustomProperties {

    private String property1;
    private String property2;

    // getters and setters
}

然后在需要的地方注入这些配置类：

@Component
public class MyBean {

    @Autowired
    private AppProperties appProperties;

    @Autowired
    private CustomProperties customProperties;

    // ...
}

总结

在Spring中，@Value注解无法从多个properties文件中取值的问题通常是由于@PropertySource的默认行为导致的。通过使用PropertySourcesPlaceholderConfigurer、@PropertySources、Environment对象或@ConfigurationProperties，可以有效地解决这一问题。根据项目的具体需求，选择最适合的解决方案。