SpringBoot多环境适配

Profile功能

为了方便多环境适配,springboot简化了profile功能。

1、application-profile功能

  • 默认配置文件 application.yaml;任何时候都会加载

  • 指定环境配置文件 application-{env}.yaml

  • 激活指定环境

    • 配置文件激活
    • 命令行激活:java -jar xxx.jar –spring.profiles.active=prod –person.name=haha
      • 修改配置文件的任意值,命令行优先
  • 默认配置与环境配置同时生效

  • 同名配置项,profile配置优先

1
2
3
4
5
//比如说再有两个的情况下,
application-myprod.yml
application-mytest.yml

spring.profiles.active=myprod

通过这种方式指定一个配置文件。

在应用程序启动时默认的配置文件先生效,然后再使用指定的配置文件,当两个配置文件有重复的配置的时候,指定的优先生效。

2、@Profile条件装配功能

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Profile("test")
@Component
@ConfigurationProperties("person")
@Data
public class Worker implements Person {

private String name;
private Integer age;
}

@Profile(value = {"prod","default"})
@Component
@ConfigurationProperties("person")
@Data
public class Boss implements Person {

private String name;
private Integer age;


}
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
31
32
33
34
35

@RestController
public class HelloController {


@Value("${person.name:李四}")
private String name;


@Autowired
private Person person;

@Value("${MAVEN_HOME}")
private String msg;

@Value("${os.name}")
private String osName;

@GetMapping("/")
public String hello(){

return person.getClass().toString();
}

@GetMapping("/person")
public Person person(){

return person;
}

@GetMapping("/msg")
public String getMsg(){
return msg+"==>"+osName;
}
}

不同的配置可以对类和返回值产生不同的影响,但一般不这么做,因为一般的项目都比较大而复杂。

3、profile分组

1
2
3
4
spring.profiles.group.production[0]=proddb
spring.profiles.group.production[1]=prodmq

使用:--spring.profiles.active=production 激活

当我们指定的指定一个的配置文件的时候,属于它的组也会依次生效

4、外部化配置

https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config

  1. 默认属性(通过设置指定SpringApplication.setDefaultProperties)。
  2. @PropertySource@Configuration类上的注释。请注意,Environment在刷新应用程序上下文之前,不会将此类属性源添加到中。现在配置某些属性(如logging.*spring.main.*在刷新开始之前先读取)为时已晚。
  3. 配置数据(例如**文件)**application.properties
  4. RandomValuePropertySource,只有在拥有性能random.*
  5. 操作系统环境变量。
  6. Java系统属性(System.getProperties())。
  7. 的JNDI属性java:comp/env
  8. ServletContext 初始化参数。
  9. ServletConfig 初始化参数。
  10. 来自的属性SPRING_APPLICATION_JSON(嵌入在环境变量或系统属性中的嵌入式JSON)。
  11. 命令行参数。
  12. properties测试中的属性。可用于测试应用程序的特定部分@SpringBootTest测试注释注释
  13. @TestPropertySource 测试中的注释。
  14. $HOME/.config/spring-boot当devtools处于活动状态时,目录中的Devtools全局设置属性

5、外部配置源

常用:Java属性文件YAML文件环境变量命令行参数

6、配置文件查找位置

(1) classpath 根路径

(2) classpath 根路径下config目录

(3) jar包当前目录

(4) jar包当前目录的config目录

(5) /config子目录的直接子目录

7、配置文件加载顺序:

  1.  当前jar包内部的application.properties和application.yml
  2.  当前jar包内部的application-{profile}.properties 和 application-{profile}.yml
  3.  引用的外部jar包的application.properties和application.yml
  4.  引用的外部jar包的application-{profile}.properties 和 application-{profile}.yml

指定环境优先,外部优先,后面的可以覆盖前面的同名配置项