Spring Boot中的屬性綁定的實現(xiàn)

更新時間：2019年04月09日 10:25:40 作者：沈子平

這篇文章主要介紹了Spring Boot中的屬性綁定的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

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

@ConfigurationProperties

在使用的時候，我們往往只關(guān)心兩件事，屬性怎么綁定，即屬性文件中的值和配置類中字段的映射關(guān)系；其次是類實例化的時機。故而衍生開來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

在配置類中進行裝配,這兩個注解均出現(xiàn)在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，通過它，我們能知道激活的配置文件，以及獲取對應(yīng)參數(shù)的值，結(jié)合上面第二種在配置類中一起用。較常用的主要有

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

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

Binder

Binder是在Spring Boot2新引入的API，從字面就可以看出來，“主打”綁定，可以非常方便的進行類型轉(zhuǎn)化，以及提供回調(diào)方法介入綁定的各個階段進行深度定制，結(jié)合上面第二種在配置類中一起用。其主要的類有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();
//轉(zhuǎn)換以及默認值
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");
        
//綁定過程回調(diào)函數(shù)，高度定制
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("綁定結(jié)束{}",name);
      }
    }).get();

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: