配置绑定
Spring Boot提供注解@ConfigurationProperties实现从配置文件自动注入对应的配置值到对应的Bean对象。
认识松散绑定
看下面的ServerConfig类的属性IPAddrEss和配置文件里的Ip_AddRe_S-s 能进行数据绑定
这种绑定会把中划线-、下划线_ 都去掉,且不区分大小写,叫做 松散绑定(宽松绑定)
松散绑定由@ConfigurationProperties注解支持
松散绑定又叫:宽松绑定 → 是@ConfigurationProperties 支持的格式(SpringBoot主推的做属性绑定的方式)
虽然松散绑定格式很随意,但标准格式推荐这种:烤肉串模式 ip-address
备注:
@ConfigurationProperties的属性prefix绑定前缀命名规范:仅支持纯小写字母、数字、下划线、中划线
@Value 不支持松散绑定
绑定规则
命名风格
- 驼峰式(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
注: 对于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