Spring Cloud 中自定義外部化擴充套件機制原理及實戰

跟著Mic學架構發表於2022-02-25
SpringCloud套件

Spring Cloud針對Environment的屬性源功能做了增強，

在spring-cloud-contenxt這個包中，提供了PropertySourceLocator介面，用來實現屬性檔案載入的擴充套件。我們可以通過這個介面來擴充套件自己的外部化配置載入。這個介面的定義如下

public interface PropertySourceLocator {

   /**
    * @param environment The current Environment.
    * @return A PropertySource, or null if there is none.
    * @throws IllegalStateException if there is a fail-fast condition.
    */
   PropertySource<?> locate(Environment environment);
}

locate這個抽象方法，需要返回一個PropertySource物件。

這個PropertySource就是Environment中儲存的屬性源。 也就是說，我們如果要實現自定義外部化配置載入，只需要實現這個介面並返回PropertySource即可。

按照這個思路，我們按照下面幾個步驟來實現外部化配置的自定義載入。

自定義PropertySource

既然PropertySourceLocator需要返回一個PropertySource，那我們必須要定義一個自己的PropertySource，來從外部獲取配置來源。

GpDefineMapPropertySource 表示一個以Map結果作為屬性來源的類。

/**
 * 咕泡教育，ToBeBetterMan
 * Mic老師微信: mic4096
 * 微信公眾號： 跟著Mic學架構
 * https://ke.gupaoedu.cn
 * 使用Map作為屬性來源。
 **/
public class GpDefineMapPropertySource extends MapPropertySource {
    /**
     * Create a new {@code MapPropertySource} with the given name and {@code Map}.
     *
     * @param name   the associated name
     * @param source the Map source (without {@code null} values in order to get
     *               consistent {@link #getProperty} and {@link #containsProperty} behavior)
     */
    public GpDefineMapPropertySource(String name, Map<String, Object> source) {
        super(name, source);
    }

    @Override
    public Object getProperty(String name) {
        return super.getProperty(name);
    }

    @Override
    public String[] getPropertyNames() {
        return super.getPropertyNames();
    }
}

擴充套件PropertySourceLocator

擴充套件PropertySourceLocator，重寫locate提供屬性源。

而屬性源是從gupao.json檔案載入儲存到自定義屬性源GpDefineMapPropertySource中。

public class GpJsonPropertySourceLocator implements PropertySourceLocator {

    //json資料來源
    private final static String DEFAULT_LOCATION="classpath:gupao.json";
    //資源載入器
    private final ResourceLoader resourceLoader=new DefaultResourceLoader(getClass().getClassLoader());

    @Override
    public PropertySource<?> locate(Environment environment) {
        //設定屬性來源
        GpDefineMapPropertySource jsonPropertySource=new GpDefineMapPropertySource
                ("gpJsonConfig",mapPropertySource());
        return jsonPropertySource;
    }

    private Map<String,Object> mapPropertySource(){
        Resource resource=this.resourceLoader.getResource(DEFAULT_LOCATION);
        if(resource==null){
            return null;
        }
        Map<String,Object> result=new HashMap<>();
        JsonParser parser= JsonParserFactory.getJsonParser();
        Map<String,Object> fileMap=parser.parseMap(readFile(resource));
        processNestMap("",result,fileMap);
        return result;
    }
    //載入檔案並解析
    private String readFile(Resource resource){
        FileInputStream fileInputStream=null;
        try {
            fileInputStream=new FileInputStream(resource.getFile());
            byte[] readByte=new byte[(int)resource.getFile().length()];
            fileInputStream.read(readByte);
            return new String(readByte,"UTF-8");
        } catch (IOException e) {
            e.printStackTrace();
        }finally {
            if(fileInputStream!=null){
                try {
                    fileInputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return null;
    }
    //解析完整的url儲存到result集合。 為了實現@Value注入
    private void processNestMap(String prefix,Map<String,Object> result,Map<String,Object> fileMap){
        if(prefix.length()>0){
            prefix+=".";
        }
        for (Map.Entry<String, Object> entrySet : fileMap.entrySet()) {
            if (entrySet.getValue() instanceof Map) {
                processNestMap(prefix + entrySet.getKey(), result, (Map<String, Object>) entrySet.getValue());
            } else {
                result.put(prefix + entrySet.getKey(), entrySet.getValue());
            }
        }
    }
}

Spring.factories

在/META-INF/spring.factories檔案中，新增下面的spi擴充套件，讓Spring Cloud啟動時掃描到這個擴充套件從而實現GpJsonPropertySourceLocator的載入。

org.springframework.cloud.bootstrap.BootstrapConfiguration=\
  com.gupaoedu.env.GpJsonPropertySourceLocator

編寫controller測試

@RestController
public class ConfigController {
    @Value("${custom.property.message}")
    private String name;
    
    @GetMapping("/")
    public String get(){
        String msg=String.format("配置值:%s",name);
        return msg;
    }
}

階段性總結

通過上述案例可以發現，基於Spring Boot提供的PropertySourceLocator擴充套件機制，可以輕鬆實現自定義配置源的擴充套件。

於是，引出了兩個問題。

  1. PropertySourceLocator是在哪個被觸發的？
  2. 既然能夠從gupao.json中載入資料來源，是否能從遠端伺服器上載入呢？

PropertySourceLocator載入原理

先來探索第一個問題，PropertySourceLocator的執行流程。

SpringApplication.run

在spring boot專案啟動時，有一個prepareContext的方法，它會回撥所有實現了ApplicationContextInitializer的例項，來做一些初始化工作。

ApplicationContextInitializer是Spring框架原有的東西， 它的主要作用就是在,ConfigurableApplicationContext型別(或者子型別)的ApplicationContext做refresh之前，允許我們對ConfiurableApplicationContext的例項做進一步的設定和處理。

它可以用在需要對應用程式上下文進行程式設計初始化的web應用程式中，比如根據上下文環境來註冊propertySource，或者配置檔案。而Config 的這個配置中心的需求恰好需要這樣一個機制來完成。

public ConfigurableApplicationContext run(String... args) {
   //省略程式碼...
        prepareContext(context, environment, listeners, applicationArguments, printedBanner);
   //省略程式碼
    return context;
}

PropertySourceBootstrapConfiguration.initialize

其中,PropertySourceBootstrapConfiguration就實現了ApplicationContextInitializer，initialize方法程式碼如下。

@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
    List<PropertySource<?>> composite = new ArrayList<>();
    //對propertySourceLocators陣列進行排序，根據預設的AnnotationAwareOrderComparator
    AnnotationAwareOrderComparator.sort(this.propertySourceLocators);
    boolean empty = true;
    //獲取執行的環境上下文
    ConfigurableEnvironment environment = applicationContext.getEnvironment();
    for (PropertySourceLocator locator : this.propertySourceLocators) {
        //回撥所有實現PropertySourceLocator介面例項的locate方法，並收集到source這個集合中。
        Collection<PropertySource<?>> source = locator.locateCollection(environment);
        if (source == null || source.size() == 0) { //如果source為空，直接進入下一次迴圈
            continue;
        }
        //遍歷source，把PropertySource包裝成BootstrapPropertySource加入到sourceList中。
        List<PropertySource<?>> sourceList = new ArrayList<>();
        for (PropertySource<?> p : source) {
            sourceList.add(new BootstrapPropertySource<>(p));
        }
        logger.info("Located property source: " + sourceList);
        composite.addAll(sourceList);//將source新增到陣列
        empty = false; //表示propertysource不為空
    }
     //只有propertysource不為空的情況，才會設定到environment中
    if (!empty) {
        //獲取當前Environment中的所有PropertySources.
        MutablePropertySources propertySources = environment.getPropertySources();
        String logConfig = environment.resolvePlaceholders("${logging.config:}");
        LogFile logFile = LogFile.get(environment);
       // 遍歷移除bootstrapProperty的相關屬性
        for (PropertySource<?> p : environment.getPropertySources()) {
            
            if (p.getName().startsWith(BOOTSTRAP_PROPERTY_SOURCE_NAME)) {
                propertySources.remove(p.getName());
            }
        }
        //把前面獲取到的PropertySource，插入到Environment中的PropertySources中。
        insertPropertySources(propertySources, composite);
        reinitializeLoggingSystem(environment, logConfig, logFile);
        setLogLevels(applicationContext, environment);
        handleIncludedProfiles(environment);
    }
}

上述程式碼邏輯說明如下。

  1. 首先this.propertySourceLocators，表示所有實現了PropertySourceLocators介面的實現類，其中就包括我們前面自定義的GpJsonPropertySourceLocator。
  2. 根據預設的 AnnotationAwareOrderComparator 排序規則對propertySourceLocators陣列進行排序。
  3. 獲取執行的環境上下文ConfigurableEnvironment
  4. 遍歷propertySourceLocators時
  • 呼叫 locate 方法，傳入獲取的上下文environment
  • 將source新增到PropertySource的連結串列中
  • 設定source是否為空的標識標量empty
  1. source不為空的情況，才會設定到environment中
  • 返回Environment的可變形式，可進行的操作如addFirst、addLast
  • 移除propertySources中的bootstrapProperties
  • 根據config server覆寫的規則，設定propertySources
  • 處理多個active profiles的配置資訊
注意：this.propertySourceLocators這個集合中的PropertySourceLocator，是通過自動裝配機制完成注入的，具體的實現在BootstrapImportSelector這個類中。

ApplicationContextInitializer的理解和使用

ApplicationContextInitializer是Spring框架原有的東西， 它的主要作用就是在,ConfigurableApplicationContext型別(或者子型別)的ApplicationContext做refresh之前，允許我們對ConfiurableApplicationContext的例項做進一步的設定和處理。

它可以用在需要對應用程式上下文進行程式設計初始化的web應用程式中，比如根據上下文環境來註冊propertySource，或者配置檔案。而Config 的這個配置中心的需求恰好需要這樣一個機制來完成。

建立一個TestApplicationContextInitializer

public class TestApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext>{
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        ConfigurableEnvironment ce=applicationContext.getEnvironment();
        for(PropertySource<?> propertySource:ce.getPropertySources()){
            System.out.println(propertySource);
        }
        System.out.println("--------end");
    }
}

新增spi載入

建立一個檔案/resources/META-INF/spring.factories。新增如下內容

org.springframework.context.ApplicationContextInitializer= \
  com.gupaoedu.example.springcloudconfigserver9091.TestApplicationContextInitializer

在控制檯就可以看到當前的PropertySource的輸出結果。

ConfigurationPropertySourcesPropertySource {name='configurationProperties'}
StubPropertySource {name='servletConfigInitParams'}
StubPropertySource {name='servletContextInitParams'}
PropertiesPropertySource {name='systemProperties'}
OriginAwareSystemEnvironmentPropertySource {name='systemEnvironment'}
RandomValuePropertySource {name='random'}
MapPropertySource {name='configServerClient'}
MapPropertySource {name='springCloudClientHostInfo'}
OriginTrackedMapPropertySource {name='applicationConfig: [classpath:/application.yml]'}
MapPropertySource {name='kafkaBinderDefaultProperties'}
MapPropertySource {name='defaultProperties'}
MapPropertySource {name='springCloudDefaultProperties'}
版權宣告：本部落格所有文章除特別宣告外，均採用 CC BY-NC-SA 4.0 許可協議。轉載請註明來自 Mic帶你學架構！
如果本篇文章對您有幫助，還請幫忙點個關注和贊，您的堅持是我不斷創作的動力。歡迎關注同名微信公眾號獲取更多技術乾貨！

相關文章