Spring Boot中的屬性綁定

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> T getProperty(String key, Class<T> 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<String,Object> propMap = Binder.get(environment).bind("fish.jdbc.datasource",Bindable.mapOf(String.class, Object.class)).get();
//綁定列表
List<String> 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 <T> Bindable<T> onStart(ConfigurationPropertyName name, Bindable<T> 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();