1. springboot 配置简介
1.1 背景
通常为了能够让程序有更自由的适应性，我们会选择将一些东西作为变量放置在配置文件中，方便在不同环境，不同场景下使用相同的代码。
下面将讲述如何在springboot环境下，使用并读取配置
1.2 配置文件的格式
springboot的配置格式有两种：
- 读取配置文件，以下两种格式
- properties
- YAML
- 命令行参数 （例如：java -jar xxx.jar --spring.config='test'）
- 环境变量：System.getProperties()
1.3 配置文件的加载顺序
springboot会从各个渠道读取配置信息，并按照先后顺序读取配置信息，属性会以下顺序加载，后加载的配置会覆盖之前加载的配置。下面只列举一些关键常用的顺序，详细的请参考官网
- 命令行参数
- java 环境System.getProperties()
- 操作系统环境变量
- 没有打进 jar 包的profile配置文件，（application-{profile}.properties/yml）
- 打进 jar 包的profile配置文件，（application-{profile}.properties/yml
- 没有打进 jar 包的应用配置文件，（application.properties）
- 打进 jar 包的应用配置文件，（application.properties）
- @Configuration类上的@PropertySource注解
- 默认属性（使用SpringApplication.setDefaultProperties指定）
2. 配置加载
2.1 简单配置加载
测试类
import org.springframework.stereotype.*
import org.springframework.beans.factory.annotation.*
@Component
public class TestBean {
@Value("${name}")
private String name;
@Value("${language}")
private String[] language;
// ...
}
加载方法
方法一
java -jar xxx.jar --name="Spring Boot" --language[0]="Java" --language[1]="Html5"
或者
java -Dname='Spring Boot' -Dlanguage[0]="Java" -Dlanguage[1]="Html5" -jar myapp.jar
方法二
在application.properties中增加一行配置
name = Spring Boot
language[0] = Java
language[1] = Html5
2. 使用 javabean 加载多个配置项
测试类
@ConfigurationProperties(prefix="phone")
public class OwnerProperties {
private String model;
private String color;
private Double standardPrice;
// get set ....
}
加载方法
方法一
多个配置项建议使用配置文件，不建议使用命令行
java -jar xxx.jar --model="iphone7" --color="gold" --standardPrice=7999.9
或者
java -Dmodel="iphone7" -Dcolor="gold" -DstandardPrice=7999.9 -jar xxx.jar
方法二
在application.properties中增加一段配置
model = iphone7
color = gold
standardPrice = 7999.9
或者
standard-price = 7999.9
或者
standard_price = 7999.9
或者
STANDARD_PRICE = 7999.9
解释说明
| 属性 | 说明 |
|---|---|
| standardPrice | 标准驼峰规则 |
| standard-price | 虚线表示，推荐用于.properties和.yml文件中 |
| standard_price | 下划线表示，可以用于.properties和.yml文件中 |
| STANDARD_PRICE | 大写形式，使用系统环境变量时推荐，后期docker部署会大量使用 |
注意
使用 bean 对象加载多个配置项时的注意事项
- 需要在启动类上导入配置测试类
@SpringBootApplication
@EnableConfigurationProperties({OwnerProperties.class})
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
- 需要在使用类中注入配置测试类
@RestController
public class DemoController {
@Autowired
private OwnerProperties ownerProperties;
}
3. springboot 配置文件的特性
3.1 随机配置
应用场景
- 密钥
- 单元测试
- 随机端口
random.string=${random.value}
random.number=${random.int}
random.bignumber=${random.long}
random.number.less=${random.int(100)}
random.number.range=${random.int[1024,2048]}
3.2 参数引用
参数可以直接引用，后期在docker中会使用的更多
language.name=java
language.description=${language.name} is popular
3.3 profile
后续章节中会讲解，在不同的场景（测试、开发、生产）下加载不同的配置文件
