不修改配置文件，让不同的部署环境使用不同的配置
需求场景
在游戏服务器部署时，一般会有这样几个环境：本地开发运行环境，本地测试运行环境，外网测试运行环境和正式上线运行环境。每个环境所使用的到配置文件参数是不一样的，比如数据库连接，消息队列连接，端口，以及一些启动参数。特别是在开发联调的时候，开发人员使用的本地开发环境，测试人员使用的本地测试运行环境，如果在测试的时候遇到了bug，需要开发人员使用IDE连接调试，不得不把配置参数都修改为测试环境的，然后测试完之后，再修改过来。
问题所在
这样来回在不同的运行环境中修改配置参数，不仅仅容易出错，还浪费时间。能不能有一种方法：不修改配置文件，让不同的部署环境使用不同的配置，并方便来回切换。Spring Boot的Environment Profile解决了这个问题。
Spring Boot Environment Profile
Environment是一个抽象的接口，profile是一个逻辑分组，它如某个profile被激活了，那么它定义的bean和配置信息就会注册到spring 容器之中。
代码中Profile的定义
假如，在两个不同的运行环境中，使用的数据源是不一样的，那么可以这样定义：
@Configuration
@Profile("development")
public class StandaloneDataConfig {
@Bean
public DataSource dataSource() {
return new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.HSQL)
.addScript("classpath:com/bank/config/sql/schema.sql")
.addScript("classpath:com/bank/config/sql/test-data.sql")
.build();
}
}
@Configuration
@Profile("production")
public class JndiDataConfig {
@Bean(destroyMethod="")
public DataSource dataSource() throws Exception {
Context ctx = new InitialContext();
return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
}
}
也可以放在同一个类里面,这里需要注意的是方法可以不一样，但是bean的名字必须是一样的：
@Configuration
public class AppConfig {
@Bean("dataSource")
@Profile("development")
public DataSource standaloneDataSource() {
return new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.HSQL)
.addScript("classpath:com/bank/config/sql/schema.sql")
.addScript("classpath:com/bank/config/sql/test-data.sql")
.build();
}
@Bean("dataSource")
@Profile("production")
public DataSource jndiDataSource() throws Exception {
Context ctx = new InitialContext();
return (DataSource) ctx.lookup("java:comp/env/jdbc/datasource");
}
}
上面定义的两个数据源，一个是在开发环境下生效(development)，一个是在生产环境下生效(production)
如何激活使用哪个Profile
- 通过启动时的参数激活使用的Profile
java -Dspring.profiles.active="development" -jar xxx.jar
- 可以在application.yml配置文件中配置激活使用的Profile
spring:
profiles:
active:
- development
如果有多个profile要激活，可以使用逗号分隔，如：
-Dspring.profiles.active="profile1,profile2"
另外，我们也可以把不同环境的一些参数配置在配置文件，在启动的时候激活指定的配置文件。但是配置文件的命名有个约定，比如dev环境的配置文件名字必须是：application-dev.yml，要和application.yml在同一个文件目录下面，然后在在application中激活dev:
spring:
profiles:
active:
- dev
如果aplication.yml和application-dev.yml中有两同的配置，那么dev中的配置会覆盖application.yml中的配置。
总结
- 在不同的运行环境中，可以在代码中通过配置不同的profile Bean，在启动的时候指定激活对应的profile即可。
-
也可以配置不同运行环境的运行配置文件，启动服务的时候指定激活对应的profile文件即可。
这样就可以不用修改配置文件，让不同的部署环境使用不同的配置了
欢迎关注
