配置绑定
Spring Boot提供注解@ConfigurationProperties实现从配置文件自动注入对应的配置值到对应的Bean对象。
示例java代码
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("demo.binding")
public class DemoPropertiesBinding {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
application.properties配置
demo.binding.name=demoProperties
绑定规则
命名风格
- 驼峰式（camel case,如：relaxedBinding）
- 短横线隔开式（ kebab case,如：relaxed-binding，推荐首选在.properties和.yml 文件使用）
- 下划线表示法 (underscore notation,如：relaxed_binding，备选在.properties和.yml 文件使用)
- 大写格式 (upper case format ,如：RELAXED_BINDING，环境变量中使用)
注：
ConfigurationProperties的prefix的值必须是短横线隔开式，如demo.relaxed-binding
各种property源的绑定规则
| Property Source | 简单值 | 列表值 |
|---|---|---|
| Properties 文件 | 驼峰式, 短横线隔开式,下划线表示法 | [ ]或值逗号分隔 |
| YAML 文件 | 驼峰式, 短横线隔开式,下划线表示法 | - 或值逗号分隔 |
| 环境变量 | 大写格式 | 数值下标，如RELAXED_0_BINDING |
| 系统属性 | 驼峰式, 短横线隔开式,下划线表示法 | [ ]或值逗号分隔 |
注：
推荐使用短横线隔开式（kebab case）。
Map绑定
规则如下
- key只能包含小写的字母数字和短横线
- 非以上字符将会被去掉
- 如key需要包含其他字符，需要包在中括号里
示例代码
demo:
map:
"[/key1]": value1
"[/key2]": value2
/key3: value3
以上配置会绑定到map上，key为 /key1,/key2, key3
注： 对于YAML文件中括号需要放在引号里。
环境变量绑定
由于操作系统对环境变量的命名都有严格的要求，如Linux shell变量，只能是字母（一般大写）、数字及下划线。
标准形式（ canonical-form）转到环境变量的规则
- 使用下划线替换点号
- 去掉短横线(dash -)
- 转为大写
如：demo.test.ab-cd-ef 转为DEMO_TEST_ABCDEF。
环境变量的列表形式
demo.test[0].ab-cd-ef
demo.test[1].ab-cd-ef
DEMO_TEST_0_ABCDEF
DEMO_TEST_1_ABCDEF
