快捷導(dǎo)航

spring @Profiles和@PropertySource實現(xiàn)根據(jù)環(huán)境切換配置文件

更新時間：2021年11月02日 10:35:09 作者：zpzkitt

這篇文章主要介紹了spring @Profiles和@PropertySource根據(jù)環(huán)境切換配置文件，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

@Profiles和@PropertySource根據(jù)環(huán)境切換配置文件

使用@PropertySource注解加載配置文件，并制定解析配置文件的解析器默認(rèn)是properties，可以自己指定使用Yml配置文件解析器。

@SpringBootApplication
@PropertySource(value = "classpath:config-${spring.profiles.active}.yml",
        encoding = "UTF-8",
        factory = YmlPropertySourceFactory.class)
public class Application {
 
    public static void main(String[] args) {
        try {
            SpringApplication.run(Application.class, args);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

resources下的需要一個全局配置文件application.yml（我使用的是yml格式配置文件），這個配置文件就是用來切換不同環(huán)境下的配置文件的，其他配置文件就根據(jù)環(huán)境做一個不同的后綴，config-dev.yml，config-pro.yml。

Yml格式配置文件的解析需要用下面方式切換一下。就是根據(jù)文件的后綴判斷文件格式使用不同的配置文件加載器。

public class YmlPropertySourceFactory extends DefaultPropertySourceFactory {
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
        String sourceName = name != null ? name : resource.getResource().getFilename();
        if (!resource.getResource().exists()) {
            return new PropertiesPropertySource(sourceName, new Properties());
        } else if (sourceName.endsWith(".yml") || sourceName.endsWith(".yaml")) {
            Properties propertiesFromYaml = loadYml(resource);
            return new PropertiesPropertySource(sourceName, propertiesFromYaml);
        } else {
            return super.createPropertySource(name, resource);
        }
    }
 
    private Properties loadYml(EncodedResource resource) throws IOException {
        YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
        factory.setResources(resource.getResource());
        factory.afterPropertiesSet();
        return factory.getObject();
    } 
}

然后在公共配置文件application.yml中添加spring.profiles.active配置，值就是config-dev.yml中的dev或者pro。其實spring.profiles.active就是spring用來指定不同環(huán)境的，可以用@Profiles 和@ActiveProfiles注解來指定不同的配置文件，@Profiles注解在類或@bean注解的方法上可以實現(xiàn)不同的配置實例化不同的類，然后通過jvm參數(shù)來指定spring.profiles.active值就能做到運行切換配置環(huán)境了，jvm參數(shù)：

JAVA_OPTS=" -Xms1024m -Xmx1024m  -XX:PermSize=512m -XX:MaxPermSize=512m -Dspring.profiles.active=dev"

上面我提供的方式是在配置文件中修改一個參數(shù)的值達(dá)到切換配置文件的目的，@Profiles注解的方式是用jvm參數(shù)的方式在啟動時切換配置文件，可以根據(jù)情況選擇。

利用spring.profiles.active=@spring.active@不同環(huán)境下靈活切換配置文件

一、創(chuàng)建配置文件

配置文件結(jié)構(gòu)：這里建三個配置文件，application.yml作為主配置文件配置所有共同的配置；-dev和-local分別配置兩種環(huán)境下的不同配置內(nèi)容，如數(shù)據(jù)庫地址等。

application.yml中添加spring.profiles.active配置來動態(tài)加載活躍的配置文件：

spring:
  profiles:
    active: @spring.active@

二、POM文件添加PROFILES配置

<profiles>
	<profile>
		<id>local</id>
		<properties>
			<spring.active>local</spring.active>
		</properties>
		<activation>
			<activeByDefault>true</activeByDefault>
		</activation>
	</profile>
	<profile>
		<id>dev</id>
		<properties>
			<spring.active>dev</spring.active>
		</properties>
	</profile>
</profiles>

以上配置聲明有兩種配置文件、分別為dev和local。且默認(rèn)使用local（通過true設(shè)置的）。

這樣配置好的項目在maven中就多了一個配置項：