使用spring.profiles.active来分区配置的方法示例

时间:2022-09-22 21:57:58

很多时候,我们项目在开发环境和生成环境的环境配置是不一样的,例如,数据库配置,在开发的时候,我们一般用测试数据库,而在生产环境的时候,我们是用正式的数据,这时候,我们可以利用profile在不同的环境下配置用不同的配置文件或者不同的配置

spring boot允许你通过命名约定按照一定的格式(application-{profile}.properties)来定义多个配置文件,然后通过在application.properyies通过spring.profiles.active来具体激活一个或者多个配置文件,如果没有没有指定任何profile的配置文件的话,spring boot默认会启动application-default.properties。

profile的配置文件可以按照application.properyies的放置位置一样,放于以下四个位置,

1.当前目录的 “/config”的子目录下
2.当前目录下
3.classpath根目录的“/config”包下
4.classpath的根目录下

在这里我们就定义俩个profile文件,application-cus1.properties和application-cus2.properties,并在俩个文件中都分别写上变量cusvar=cus1和cusvar=cus2

我们在application.properyies也写上,并把profile切换到application-cus1.properties的配置文件

?
1
2
cusvar=cus3
spring.profiles.active=cus1

可以通过这样子来测试

?
1
2
3
4
5
6
7
8
9
10
11
@restcontroller
@requestmapping("/task")
public class taskcontroller {
 
  @requestmapping(value = {"/",""})
  public string helltask(@value("${cusvar}")string cusvar ){
 
    return "hello task !! myage is " + cusvar;
  }
 
}

在这里可以看到spring.profiles.active激活的profile不同,打印出来的结果也不一样。

除了可以用profile的配置文件来分区配置我们的环境变量,在代码里,我们还可以直接用@profile注解来进行配置,例如数据库配置,这里我们先定义一个接口

?
1
2
3
public interface dbconnector {
  public void configure(); 
}

分别定义俩个实现类来实现它

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
 * 测试数据库
 */
@component
@profile("testdb")
public class testdbconnector implements dbconnector {
 
  @override
  public void configure() {
 
    system.out.println("testdb");
 
  }
}
 
/**
 * 生产数据库
 */
@component
@profile("devdb")
public class devdbconnector implements dbconnector {
 
  @override
  public void configure() {
 
    system.out.println("devdb");
 
  }
 
}

通过在配置文件激活具体使用哪个实现类

?
1
spring.profiles.active=testdb

然后就可以这么用了

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
@restcontroller
@requestmapping("/task")
public class taskcontroller {
 
  @autowired dbconnector connector ;
 
  @requestmapping(value = {"/",""})
  public string helltask(){
 
    connector.configure(); //最终打印testdb  
    return "hello task !! myage is " + myage;
  }
 
}

除了spring.profiles.active来激活一个或者多个profile之外,还可以用spring.profiles.include来叠加profile

?
1
2
spring.profiles: testdb
spring.profiles.include: proddb,prodmq

以上就是spring boot用profile的作用

通过命令行设置属性值

相信使用过一段时间spring boot的用户,一定知道这条命令:java -jar xxx.jar --server.port=8888,通过使用--server.port属性来设置xxx.jar应用的端口为8888。

在命令行运行时,连续的两个减号--就是对application.properties中的属性值进行赋值的标识。所以,java -jar xxx.jar --server.port=8888命令,等价于我们在application.properties中添加属性server.port=8888,该设置在样例工程中可见,读者可通过删除该值或使用命令行来设置该值来验证。

通过命令行来修改属性值固然提供了不错的便利性,但是通过命令行就能更改应用运行的参数,那岂不是很不安全?是的,所以spring boot也贴心的提供了屏蔽命令行访问属性的设置,只需要这句设置就能屏蔽:springapplication.setaddcommandlineproperties(false)。

多环境配置

以上都不是重点,这才是重点,这才是重点,这才是重点,重要的事情说3遍。我们在开发spring boot应用时,通常同一套程序会被应用和安装到几个不同的环境,比如:开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同,如果在为不同环境打包时都要频繁修改配置文件的话,那必将是个非常繁琐且容易发生错误的事。

对于多环境的配置,各种项目构建工具或是框架的基本思路是一致的,通过配置多份不同环境的配置文件,再通过打包命令指定需要打包的内容之后进行区分打包,spring boot也不例外,或者说更加简单。

在spring boot中多环境配置文件名需要满足application-{profile}.properties的格式,其中{profile}对应你的环境标识,比如:

  • application-dev.properties:开发环境
  • application-test.properties:测试环境
  • application-prod.properties:生产环境

至于哪个具体的配置文件会被加载,需要在application.properties文件中通过spring.profiles.active属性来设置,其值对应{profile}值。

 如:spring.profiles.active=test就会加载application-test.properties配置文件内容

下面,以不同环境配置不同的服务端口为例,进行样例实验。

针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties

在这三个文件均都设置不同的server.port属性,如:dev环境设置为8080,test环境设置为9090,prod环境设置为80

application.properties中设置spring.profiles.active=dev,就是说默认以dev环境设置

测试不同配置的加载:

执行java -jar xxx.jar,可以观察到服务端口被设置为8080,也就是默认的开发环境(dev)

执行java -jar xxx.jar --spring.profiles.active=test,可以观察到服务端口被设置为9090,也就是测试环境的配置(test)

执行java -jar xxx.jar --spring.profiles.active=prod,可以观察到服务端口被设置为80,也就是生产环境的配置(prod)

按照上面的实验,可以如下总结多环境的配置思路:

application.properties中配置通用内容,并设置spring.profiles.active=dev,以开发环境为默认配置

application-{profile}.properties中配置各个环境不同的内容

通过命令行方式去激活不同环境的配置。

多环境高级应用

在某些情况下,应用的某些业务逻辑可能需要有不同的实现。例如邮件服务,假设emailservice中包含的send(string email)方法向指定地址发送电子邮件,但是我们仅仅希望在生产环境中才执行真正发送邮件的代码,而开发环境里则不发送以免向用户发送无意义的垃圾邮件。

我们可以借助spring的注解@profile实现这样的功能,这样需要定义两个实现emailservice借口的类:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
 * 发送邮件接口.
 */
public interface emailservice {
  /**发送邮件*/
  publicvoid send();
}
发送邮件的具体实现(dev-开发环境的代码):
@service
@profile("dev") //开发环境的时候.
public class devemailserviceimpl implements emailservice{
 
  @override
  publicvoid send() {
    system.out.println("devemailserviceimpl.send().开发环境不执行邮件的发送.");
  }
}

发送邮件的具体实现(prod-生产环境的代码):

?
1
2
3
4
5
6
7
8
9
10
11
@service
@profile("prod") //生产环境.
public class prodemailserviceimpl2 implements emailservice{
  
  @override
  publicvoid send() {
    system.out.println("devemailserviceimpl.send().生产环境执行邮件的发送.");
    //具体的邮件发送代码.
    //mail.send();
  }
}

@profile("dev")表明只有spring定义的profile为dev时才会实例化devemailservice这个类。那么如何设置profile呢?

在配置文件中指定

在application.properties中加入:

?
1
spring.profiles.active=dev

通过命令行参数

?
1
java -jar app.jar --spring.profiles.active=dev

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。

原文链接:http://www.cnblogs.com/xinglongbing521/p/10275291.html