@ConfigurationProperties与yml配置文件属性匹配规则

标签：set 匹配 文件属性 ConfigurationProperties prefix yml 属性

@ConfigurationProperties与yml配置文件属性匹配规则

@ConfigurationProperties的prefix书写规范

1. prefix值应该用小写字母、数字、中划线“-”区分单词
2. 不能用大写字母、特殊字符，区分单词不能用下划线。

例如：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文件

1. yml文件遵循yml书写规范即可，不受@ConfigurationProperties注解prefix规则的影响
2. yml文件可以大小写、下划线、中划线同时使用
3. 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文件不同之处：

1. yml属性前缀与注解prefix值的字符断开及大小写位置完全不同
2. yml属性名与set方法名断开的位置完全不同
3. 类中没有与yml对应的属性

结果：可正常匹配

@ConfigurationProperties匹配yml属性规则

1. 去掉双方所有的下划线、中划线，且不区分大小写匹配 （仅以测试结果分析总结，详细原理可查看源码）
2. 匹配的是set方法，可以没有对应的Java属性
3. 如果属性名能匹配上，但没有set方法，会报错没有set方法，所以必须要有set方法
4. set方法不可以是静态的
5. yml中的属性在类中不存在，默认会忽略，不会报错

https://blog.csdn.net/x235cl/article/details/109965032

标签：set,匹配,文件属性,ConfigurationProperties,prefix,yml,属性
From： https://www.cnblogs.com/sunny3158/p/16637054.html