Spring注解 `@PropertySource` 详解与实战

Spring 注解 @PropertySource 详解与实战

在Spring框架中，@PropertySource注解用于指定一个或多个属性文件的位置，使得这些属性文件中的配置项能够被Spring的环境（Environment）所加载和使用。下面，我们将详细解析@PropertySource的用法，并通过实战案例来加深理解。

1. @PropertySource基础用法

@PropertySource可以标注在@Configuration类上，也可以标注在@Component类上。不过，一般我们习惯将其标注在配置类上，因为它主要的作用就是加载属性文件。

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

在上面的代码中，我们指定了classpath:config.properties这个属性文件的位置，Spring将会加载这个文件，并将其中的配置项添加到Environment中。

2. 使用@Value注入属性值

一旦@PropertySource加载了属性文件，我们就可以使用@Value注解来注入这些属性值。

@Configuration
@PropertySource("classpath:config.properties")
public class AppConfig {

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

    // ...
}

在上述代码中，${app.name}就是从config.properties文件中获取的app.name配置项的值。需要注意的是，Spring会默认使用StandardEnvironment来解析占位符（如${...}），并且会先查找systemProperties（系统属性），然后查找systemEnvironment（系统环境变量），最后查找applicationProperties（Spring配置文件中的属性，包括通过@PropertySource加载的属性文件）。

3. 使用多个@PropertySource

你可以在一个配置类上使用多个@PropertySource注解来加载多个属性文件。

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

需要注意的是，当多个属性文件中存在相同的配置项时，后面的属性文件会覆盖前面的属性文件中的配置项。

4. 使用PropertySourcesPlaceholderConfigurer

虽然@PropertySource注解可以很方便地加载属性文件，但在某些场景下，你可能需要更细粒度的控制，比如指定属性文件的编码、忽略某些配置项等。这时，你可以使用PropertySourcesPlaceholderConfigurer。

@Configuration
public class AppConfig {

    @Bean
    public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        configurer.setLocations(new PathMatchingResourcePatternResolver().getResources("classpath:config*.properties"));
        configurer.setIgnoreUnresolvablePlaceholders(true);
        return configurer;
    }

    // ...
}

在上面的代码中，我们创建了一个PropertySourcesPlaceholderConfigurer的Bean，并指定了需要加载的属性文件的位置和模式（这里使用了通配符*来匹配多个属性文件）。此外，我们还设置了ignoreUnresolvablePlaceholders属性为true，表示当占位符无法解析时，不会抛出异常。

5. 实战案例

假设我们有一个config.properties文件，内容如下：

app.name=MyApp
app.version=1.0

我们可以使用@PropertySource和@Value来加载和注入这些配置项。

@Configuration
@PropertySource("classpath:config.properties")
public class AppConfig {

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

    @Value("${app.version}")
    private String appVersion;

    // ...

    @Bean
    public String printAppInfo() {
        return "App Name: " + appName + ", App Version: " + appVersion;
    }
}

然后，在需要的地方（比如Controller或Service中），我们可以注入这个Bean来获取应用信息。

通过以上的介绍和实战案例，相信你已经对@PropertySource的用法有了深入的理解。在实际的项目开发中，合理地使用@PropertySource和相关的注解，可以帮助我们更好地管理配置项，提高代码的可维护性和可配置性。