快捷導(dǎo)航

spring boot自定義配置源操作步驟

更新時(shí)間：2017年10月18日 09:04:59 作者：atheva

這篇文章主要介紹了spring boot自定義配置源操作步驟,需要的朋友可以參考下

概述

我們知道，在Spring boot中可以通過(guò)xml或者@ImportResource 來(lái)引入自己的配置文件，但是這里有個(gè)限制，必須是本地，而且格式只能是 properties(或者 yaml)。那么，如果我們有遠(yuǎn)程配置，如何把他引入進(jìn)來(lái)來(lái)呢。

如何做

其實(shí)自定義配置源只需要3步

第一步，編寫(xiě)PropertySource

編寫(xiě)一個(gè)類繼承EnumerablePropertySource，然后實(shí)現(xiàn)它的抽象方法即可，抽象方法看名字就知道作用，簡(jiǎn)單起見(jiàn)，這里使用一個(gè)map來(lái)保存配置，例如：

public class MyPropertySource extends EnumerablePropertySource<Map<String,String>> {
  public MyPropertySource(String name, Map source) {
    super(name, source);
  }
  //獲取所有的配置名字
  @Override
  public String[] getPropertyNames() {
    return source.keySet().toArray(new String[source.size()]);
  }
  //根據(jù)配置返回對(duì)應(yīng)的屬性
  @Override
  public Object getProperty(String name) {
    return source.get(name);
  }
}

第二步，編寫(xiě)PropertySourceLocator

PropertySourceLocator 其實(shí)就是用來(lái)定位我們前面的PropertySource，需要重寫(xiě)的方法只有一個(gè)，就是返回一個(gè)PropertySource對(duì)象，例如，

public class MyPropertySourceLocator implements PropertySourceLocator {
  @Override
  public PropertySource<?> locate(Environment environment) {
    //簡(jiǎn)單起見(jiàn)，這里直接創(chuàng)建一個(gè)map,你可以在這里寫(xiě)從哪里獲取配置信息。
    Map<String,String> properties = new HashMap<>();
    properties.put("myName","lizo");
    MyPropertySource myPropertySource = new MyPropertySource("myPropertySource",properties);
    return myPropertySource;
  }
}

第三步，讓PropertySourceLocator生效

新建一個(gè)配置類，例如

@Configuration
public class MyConfigBootstrapConfiguration {
  @Bean
  public MyPropertySourceLocator myPropertySourceLocator(){
    return new MyPropertySourceLocator();
  }
}

最后再創(chuàng)建/更新 META-INFO/spring.factories(如果做過(guò)自定義Spring boot開(kāi)發(fā)的都知道這個(gè)文件)

org.springframework.cloud.bootstrap.BootstrapConfiguration=\
com.lizo.MyConfigBootstrapConfiguration

簡(jiǎn)單來(lái)說(shuō)就是給Spring Boot說(shuō)，這個(gè)是一個(gè)啟動(dòng)配置類（一種優(yōu)先級(jí)很高的配置類）。

編寫(xiě)測(cè)試

測(cè)試一

@SpringBootApplication
public class Test2 {
  public static void main(String[] args) throws SQLException {
    ConfigurableApplicationContext run = SpringApplication.run(Test2.class, args);
    Ser bean = run.getBean(Ser.class);
    System.out.println(bean.getMyName());
  }
  @Component
  public static class Ser{
    @Value("${myName}")
    private String myName;
    public String getMyName() {
      return myName;
    }
    public void setMyName(String myName) {
      this.myName = myName;
    }
  }
}

正確輸出

測(cè)試二

我們?cè)赼pplication配置文件中，引入這個(gè)變量呢，例如在application.properties中