SpringBoot @ConfigurationProperties注解的簡(jiǎn)單使用

目錄

源碼

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @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

那么代碼中的配置類(lèi)應該這樣寫(xiě)：

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

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

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

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

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

Spring Boot的綁定規則相當寬松，myField, my-field, my_field等都能識別綁定到myField上。

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

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

類(lèi)的字段必須要有public訪(fǎng)問(wèn)權限的setter方法。

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

以上就是SpringBoot @ConfigurationProperties注解的簡(jiǎn)單使用的詳細內容，更多關(guān)于SpringBoot @ConfigurationProperties注解的資料請關(guān)注腳本之家其它相關(guān)文章！