springBoot加载配置文件

本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net

1. 说明

Spring Boot 会自动加载application.properties或application.yml，所放置的位置如下表，所有位置的文件都会被加载（互补配置），高优先级配置内容会覆盖低优先级配置内容。

2. 获取配置信息

2.1 @Value

（1） 说明

可直接用 @Value 注解获取已加载指定 key 的配置数据。

可通过 :defaultValue 设置默认值，不设置默认值时 key 不存在时会抛出异常

（2）示例

@Value("${key:defaultValue}")
    private String demoKey;

2.2 @ConfigurationProperties

（1） 说明

将指定前缀的配置封装到实体类中。有如下属性：

（2）示例

@Component
@ConfigurationProperties(prefix="demo")
public class DemoProperties {
    // 获取demo.a1
    private String a1;
    // 获取demo.a2
    private String a2;
    
    //todo set/get方法
}

2.3 Environment

（1） 说明

是一个提供访问环境变量的类**。**常用方法有：

（2）示例

@Autowired
    Environment environment;
    @Test
    void contextLoads2() throws Exception {
        System.out.println(environment.getProperty("demo.k1"));
    }

3. 引入外部配置文件

3.1 @PropertySource

（1） 说明

用于指定资源文件读取的位置，它不仅能读取 properties 文件，也能读取 xml 文件，并且还可通过 YAML 解析器，配合自定义 PropertySourceFactory 实现解析 YAML 文件。

（2）示例

@Component
@PropertySource(value = "classpath:demo.properties",encoding = "utf-8")
public class Config {
}

3.2 PropertySourcesPlaceholderConfigurer

（1） 说明

读取外部配置文件，并将配置文件中的属性值注入到应用程序中。

（2）示例

/**
     * 加载yml配置文件
     */
    @Bean
    public static PropertySourcesPlaceholderConfigurer yamlConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
        yaml.setResources(new ClassPathResource("demo.yml"));
        configurer.setProperties(Objects.requireNonNull(yaml.getObject()));
        return configurer;
    }
    /**
     * 加载properties配置文件
     */
    @Bean
    public PropertySourcesPlaceholderConfigurer propertiesConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        configurer.setLocations(new ClassPathResource("demo.properties"));
        return configurer;
    }

3.3 直接加载并获取配置信息

（1） 说明

Properties 是一个 Map 体系集合类，继承于 Hashtable。主要用于读取 Java 的 properties 配置文件。

注：也可使用其他类库直接读取配置文件。

（2）示例

InputStream ips = new FileInputStream("config.properties");
Properties props = new Properties();
props.load(ips);
ips.close();
String value= props.getProperty("key");

3.4 命令行参数

（1） 说明

可以通过 --spring.config.location参数来指定配置文件的位置。

可以通过 --spring.config.name 参数指定配置文件名称。

注：也可 使用 --app.key=value  修改配置文件中的配置

（2）示例

// 加载 /path/config/ 下的myconfig.properties或myconfig.yml配置文件
java -jar app.jar --spring.config.location=file:/path/config/  --spring.config.name=myconfig

4. 分环境加载配置文件

4.1 默认加载的配置文件

（1） 说明

可通过 application-{profile}.properties 或 application-{profile}.yml 的方式配置多个配置文件。

注：application.properties 或 application.yml 可配置公共配置数据。

4.2 @Profile

（1） 说明

常和 @Component、@Configuration、@Bean 注解一块使用，用于标明需要 spring 管理类是否需要管理的环境。

注：只有配置了 spring.profiles.active 或 spring.profiles.default 时 @Profile 才会生效。

（2）示例

//Config类只有在dev环境时由spring管理
//可通过配置多个不同环境的相同类来做到分环境加载配置
@Component
@Profile("dev")
public class Config {
    //DataSource类只有在test环境时由spring管理
    @Bean
    @Profile("test")
    public DataSource getTestDataSource () {
        return null;
    }
}

4.3 引入外部配置文件时自定义不同环境的文件名

@Bean
    public PropertySourcesPlaceholderConfigurer configurer1(Environment environment) {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        String[] activeProfiles = environment.getActiveProfiles();
        if (activeProfiles != null && activeProfiles.length > 0) {
            YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
            ClassPathResource[] resources=new ClassPathResource[activeProfiles.length];
            for (int i = 0; i < activeProfiles.length; i++) {
                resources[i]=new ClassPathResource("demo-" + activeProfiles[i] + ".yml");
            }
            yaml.setResources(resources);
            configurer.setProperties(Objects.requireNonNull(yaml.getObject()));
        }
        return configurer;
    }
    @Bean
    public PropertySourcesPlaceholderConfigurer configurer2(Environment environment) {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        String[] activeProfiles = environment.getActiveProfiles();
        if (activeProfiles != null && activeProfiles.length > 0) {
            for (int i = 0; i < activeProfiles.length; i++) {
                configurer.setLocations(new ClassPathResource("demo-" + activeProfiles[i] + ".properties"));
            }
        }
        return configurer;
    }

5. 配置文件常用语法

 （1）可使用 ${key} 获取其他配置数据