Spring Boot中的屬性綁定

xfee 發布于2019-08-19 11:35 / 623人閱讀

摘要：所以適合簡單屬性值的獲取，不知何復雜對象的綁定。綁定對象綁定綁定列表轉換以及默認值綁定過程回調函數，高度定制綁定開始綁定成功綁定失敗沒有找到匹配的屬性綁定結束

Spring Boot中的屬性綁定

之前翻譯了一篇不怎么樣的文章，主要是翻譯的水平有限，自己翻譯的云里霧里，發現平時只會有@ConfigurationProperties注解，對SpringBoot強大的屬性綁定知之甚少，所以以那篇文章為線索，重新學習了一遍。

@ConfigurationProperties

在使用的時候，我們往往只關心兩件事，屬性怎么綁定，即屬性文件中的值和配置類中字段的映射關系；其次是類實例化的時機。故而衍生開來ConfigurationProperties有三種用法。

@Component + @ConfigurationProperties

這種用法最簡單，直接在POJO類上加上注解即可，Spring容器初始化時就會生成配置類實例了。適合POJO類是自定義的。

@Component
@ConfigurationProperties(prefix = "kaka.cream.mail-a",ignoreUnknownFields = false)
public class MailPropertiesA {
    private String name;
    private String sex;
    private Integer age;

@Bean + @ConfigurationProperties

在配置類中進行裝配,這兩個注解均出現在Configuration中，對POJO無侵入，使用靈活，且集中（均在配置類中處理）

@Bean
    @ConfigurationProperties(prefix = "kaka.cream.mail-b",ignoreUnknownFields = false)
    public MailPropertiesB mailPropertiesB(){
        MailPropertiesB b = new MailPropertiesB();
        return b;
    }

@EnableConfigurationProperties + @ConfigurationProperties

Pojo類上注解@ConfigurationProperties，在啟動類上注解@EnableConfigurationProperties

@Data
@ConfigurationProperties(prefix = "kaka.cream.mail-c",ignoreUnknownFields = false)
public class MailPropertiesC {
    private String name;
    private String sex;
    private Integer age;
}

@EnableConfigurationProperties(MailPropertiesC.class)
public class GomvcApplicationTests {

可以在啟動類上一目了然的看到啟動的配置，且不需要配置類，對第三方使用者比較友好，但是靈活性上沒有第二種好。在這三種里面，推薦使用第二種方式。

Environment

存在于spring boot首個版本的元老類，它繼承自PropertyResolver，通過它，我們能知道激活的配置文件，以及獲取對應參數的值，結合上面第二種在配置類中一起用。較常用的主要有

//判斷是否包含鍵值
boolean containsProperty(String key);
//獲取屬性值，如果獲取不到返回null
String getProperty(String key);
//獲取屬性值，如果獲取不到返回缺省值
String getProperty(String key, String defaultValue);
//獲取屬性對象
 T getProperty(String key, Class targetType);

其中最后一個轉換是和Converter有關的，會依據sourceType和targetType查找轉換器，這個打算下一個章節進行分析，不在這里展開。所以Environment適合簡單屬性值的獲取，不知何復雜對象的綁定。

Binder

Binder是在Spring Boot2新引入的API，從字面就可以看出來，“主打”綁定，可以非常方便的進行類型轉化，以及提供回調方法介入綁定的各個階段進行深度定制，結合上面第二種在配置類中一起用。其主要的類有Binder, BindResult和BindHandler. 比Environment好用很多，必備好類。

//綁定對象
MailPropertiesC propertiesC = Binder.get(environment).bind("kaka.cream.mail-c", Bindable.of(MailPropertiesC.class)).get();
//綁定Map
Map propMap = Binder.get(environment).bind("fish.jdbc.datasource",Bindable.mapOf(String.class, Object.class)).get();
//綁定列表
List list = Binder.get(environment).bind("kaka.cream.list",Bindable.listOf(String.class)).get();
//轉換以及默認值
String datestr =  (String) Binder.get(environment).bind("kaka.cream.date",Bindable.of(String.class))
               .map(String::toUpperCase)
               /** .map(new Function(){
                    @Override
                    public Object apply(Object o) {
                        String str = (String)o;
                        return str.toUpperCase();
                    }
                })**/
               .orElse("bad date string");
               
//綁定過程回調函數，高度定制
LocalDate str =  Binder.get(environment).bind("kaka.cream.date", Bindable.of(LocalDate.class), new BindHandler() {

            @Override
            public  Bindable onStart(ConfigurationPropertyName name, Bindable target,
                                    BindContext context) {
                log.info("綁定開始{}",name);
                return target;
            }
            @Override
            public Object onSuccess(ConfigurationPropertyName name, Bindable target, BindContext context, Object result) {
                log.info("綁定成功{}",target.getValue());
                return result;
            }

            @Override
            public Object onFailure(ConfigurationPropertyName name, Bindable target, BindContext context, Exception error) throws Exception {
                log.info("綁定失敗{}",name);
                return "沒有找到匹配的屬性";
            }

            @Override
            public void onFinish(ConfigurationPropertyName name, Bindable target, BindContext context, Object result) throws Exception {
                log.info("綁定結束{}",name);
            }
        }).get();

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://m.specialneedsforspecialkids.com/yun/77481.html

【譯】Spring Boot 2.0的屬性綁定

摘要：比如，在中，不能將屬性綁定到對象。引入了新的接口，能夠指出屬性取值的準確位置。比如，屬性綁定的驗證異常現在會顯示類允許你使用多個。我們計劃在中繼續加強的功能，而第一個想要支持的功能是不可變屬性綁定。 Spring Boot2.0的屬性綁定原文從Spring boot第一個版本以來，我們可以使用@ConfigurationProperties注解將屬性綁定到對象。也可以指定屬性的各種不...

1treeS 2019-08-19 11:35 評論0 收藏0
Spring Boot 配置文件中的花樣，看這一篇足矣！

摘要：的默認配置文件位置為。比如，我們需要自定義模塊的服務端口號，可以在中添加來指定服務端口為，也可以通過來指定應用名該名字在應用中會被注冊為服務名。同時，配置內容都對開發人員可見，本身這也是一種安全隱患。在快速入門一節中，我們輕松的實現了一個簡單的RESTful API應用，體驗了一下Spring Boot給我們帶來的諸多優點，我們用非常少的代碼量就成功的實現了一個Web應用，這是傳統的...

pingan8787 2019-08-19 11:43 評論0 收藏0
Spring Boot 2.0 外部化配置介紹

摘要：可以使用外部化配置來方便在不同環境的運行同樣的程序文件文件環境變量命令行參數內置順序實現了很多按以下順序進行合理的相同屬性的覆蓋目錄下的全局設置屬性，如果激活測試用例上的注解測試用例上的注解。簡介在應用中管理配置并不是一個容易的任務，尤其是在應用需要部署到多個環境中時。通常會需要為每個環境提供一個對應的屬性文件，用來配置各自的數據庫連接信息、服務器信息和第三方服務賬號等。通常的應用...

lmxdawn 2019-08-16 13:38 評論0 收藏0
@ConfigurationProperties 注解使用姿勢，這一篇就夠了

摘要：在項目中，為滿足以上要求，我們將大量的參數配置在或文件中，通過注解，我們可以方便的獲取這些參數值使用配置模塊假設我們正在搭建一個發送郵件的模塊。這使得在不影響其他模塊的情況下重構一個模塊中的屬性變得容易。在編寫項目代碼時，我們要求更靈活的配置，更好的模塊化整合。在 Spring Boot 項目中，為滿足以上要求，我們將大量的參數配置在 application.properties 或...

SolomonXie 2019-08-19 11:48 評論0 收藏0
@ConfigurationProperties 注解使用姿勢，這一篇就夠了

摘要：在項目中，為滿足以上要求，我們將大量的參數配置在或文件中，通過注解，我們可以方便的獲取這些參數值使用配置模塊假設我們正在搭建一個發送郵件的模塊。這使得在不影響其他模塊的情況下重構一個模塊中的屬性變得容易。在編寫項目代碼時，我們要求更靈活的配置，更好的模塊化整合。在 Spring Boot 項目中，為滿足以上要求，我們將大量的參數配置在 application.properties 或...

KoreyLee 2019-08-19 10:13 評論0 收藏0