@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ConfigurationProperties { @AliasFor('prefix') String value() default ''; @AliasFor('value') String prefix() default ''; boolean ignoreInvalidFields() default false; boolean ignoreUnknownFields() default true;}使用

向注解中傳入配置文件中的前綴名，如果配置文件如下：

myConfigs: config1: field1: f1 field2: f2 field3: f3

那么代碼中的配置類應(yīng)該這樣寫(xiě)：

@Component@ConfigurationProperties('myConfigs.config1')public class MyConfig1 { String field1; String field2; String field3;}

如上所示，field1, field2, field3三個(gè)屬性就被綁定到了對(duì)象上。

注意到我們使用了@Component，實(shí)際上我們使用配置類都是將其注入到其他類中，所以我們往往將其注冊(cè)為Bean。

ignoreInvalidFields默認(rèn)為false，不合法的屬性的屬性會(huì)默認(rèn)拋出異常；ignoreUnknownFields默認(rèn)為true, 未能識(shí)別的屬性會(huì)被忽略(所以打錯(cuò)了名字就會(huì)被忽略了)

@ConfigurationProperties(prefix='config.prefix', ignoreInvalidFields=true, ignoreUnknownFields=false)public class MyConfig { // fields}

Spring Boot的綁定規(guī)則相當(dāng)寬松，myField, my-field, my_field等都能識(shí)別綁定到myField上。

可以給字段設(shè)定默認(rèn)值，這樣配置中沒(méi)有傳入時(shí)會(huì)使用默認(rèn)值。

@ConfigurationProperties('your.prefix')public class YourConfig { private String field = 'Default' // setter}

類的字段必須要有public訪問(wèn)權(quán)限的setter方法。

在很多情況下public的setter方法時(shí)必須的，使用IDEA的話，這里推薦Alt+Insert(Windows, Mac使用Alt+n)生成；當(dāng)然，想使用Lombok也可以

以上就是SpringBoot @ConfigurationProperties注解的簡(jiǎn)單使用的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot @ConfigurationProperties注解的資料請(qǐng)關(guān)注好吧啦網(wǎng)其它相關(guān)文章！