@ConfigurationProperties的prefix书写规范
- prefix值应该用小写字母、数字、中划线“-”区分单词
- 不能用大写字母、特殊字符,区分单词不能用下划线。
例如:my-info,不要用my_info、myInfo
springboot的提示 :
Reason: Canonical names should be kebab-case ('-' separated), lowercase alpha-numeric characters and must start with a letter
意思是:规范化名称应该是kebab-case(’-’分开) ,小写字母数字字符,并且必须以字母开头。
yml文件
- yml文件可以大小写、下划线、中划线同时使用;
- yml与@ConfigurationProperties的prefix的规范不同。yml文件不受@ConfigurationProperties注解prefix规则的影响
示例
yml代码片段:
AB_CD:
I_Ma-GE:
aliy_unI-mageHos-t: aaaa
Java代码:
@Component
@ConfigurationProperties(prefix="ab-cd.imag-e")//字母必须小写,用“-”而不是“_”,
public class PropertiesConfig {
public static String imageHost;//静态属性,属性名与yml不同
public void setAli_yunIma_geHost(String asfas) {//set方法名与yml断开位置不同,非static
PropertiesConfig.imageHost = asfas;
}
}
可以发现yml与Java文件不同之处:
- yml属性前缀与注解prefix值的字符断开及大小写位置完全不同
- yml属性名与set方法名断开的位置完全不同
- 类中没有与yml对应的属性
结果:可正常匹配
@ConfigurationProperties匹配yml属性规则
- 去掉双方所有的下划线、中划线,且不区分大小写匹配 (仅以测试结果分析总结,详细原理可查看源码)
- 属性匹配的是set方法,类中可以没有对应的属性
- 属性必须要有set方法。如果属性名能正常匹配,但没有set方法,会报错“没有set方法”。
- set方法不可以是静态的
- yml中的属性在类中不存在,默认会忽略,不会报错