摘要：同時(shí)也新增了一個(gè)。將不同的配置文件用不同的對(duì)象進(jìn)行管理。由于需要支持多個(gè)配置文件，所有需要定義一個(gè)抽象類供所有的配置管理實(shí)現(xiàn)。其實(shí)就是一個(gè)結(jié)構(gòu)的緩存，用于存放所有的配置?？偨Y(jié)這就是本次中的升級(jí)內(nèi)容，包含了配置支持以及代碼重構(gòu)。

在前兩次的 cicada 版本中其實(shí)還不支持讀取配置文件，比如對(duì)端口、路由的配置。

因此我按照自己的想法創(chuàng)建了一個(gè) issue ，也收集到了一些很不錯(cuò)的建議。

最終其實(shí)還是按照我之前的想法來做了這個(gè)配置管理。

同時(shí)將 cicada 升級(jí)到了 v1.0.2。

在做之前是要把需求想好，到底怎樣的一個(gè)配置管理是對(duì)開發(fā)人員來說比較友好的？

我認(rèn)為有以下幾點(diǎn):

可以自定義配置，并且支持不同的環(huán)境（開發(fā)、測(cè)試、生產(chǎn)）。

使用靈活。對(duì)使用者來說不要有太多的束縛。

理論上來說配置這個(gè)東西應(yīng)當(dāng)完全獨(dú)立出來，由一個(gè)配置中心來負(fù)責(zé)管理并且這樣可以與應(yīng)用解耦。

不過這樣的實(shí)現(xiàn)和當(dāng)前 cicada 的定義有些沖突，我想盡量小的依賴第三方組件并可以完全獨(dú)立運(yùn)行。

因此基于這樣的情況便有了以下的實(shí)現(xiàn)。

在看實(shí)現(xiàn)之前先看看基于目前的配置管理如何在業(yè)務(wù)中使用起來。

結(jié)合現(xiàn)在大家使用 SpringBoot 的習(xí)慣，cicada 默認(rèn)會(huì)讀取 classpath 下的 application.properties 配置文件。并且會(huì)默認(rèn)讀取其中的應(yīng)用端口以及初始路由地址。

同時(shí)也新增了一個(gè) api。

public class MainStart {

    public static void main(String[] args) throws Exception {
        CicadaServer.start(MainStart.class,"/cicada-example") ;
    }
}

public class MainStart {

    public static void main(String[] args) throws Exception {
        CicadaServer.start(MainStart.class) ;
    }
}

這樣在不傳默認(rèn)地址的時(shí)候 cicada 會(huì)從 application.properties 中讀取。

考慮到后面可維護(hù)的情況，cicada 也支持配置各種不同的配置文件。

使用也比較簡(jiǎn)單，只需要繼承 cicada 提供的一個(gè)抽象類即可。

public class KafkaConfiguration extends AbstractCicadaConfiguration {

    public KafkaConfiguration() {
        super.setPropertiesName("kafka.properties");
    }


}

public class RedisConfiguration extends AbstractCicadaConfiguration {


    public RedisConfiguration() {
        super.setPropertiesName("redis.properties");
    }

}

按照這樣的配置也會(huì)默認(rèn)從 classpath 讀取這兩個(gè)配置文件。

當(dāng)然這里有個(gè)前提：代碼里配置的文件名必須得和配置文件名稱相同。

那如何在業(yè)務(wù)中讀取這兩個(gè)配置文件的內(nèi)容呢？

這也簡(jiǎn)單，代碼一看就懂：

首先需要通過 ConfigurationHolder 獲取各自不同配置的管理對(duì)象（需要顯式指定類類型）。

通過 get() 方法直接獲取配置。

同時(shí)也支持獲取 application.properties 里的配置。

同時(shí)為了支持在不同環(huán)境的使用，當(dāng)配置了啟動(dòng)參數(shù)將會(huì)優(yōu)先讀取。

-Dapplication.properties=/xx/application.properties
-Dkafka.properties=/xx/kakfa.properties
-Dredis.properties=/xx/redis.properties

這樣算是基本實(shí)現(xiàn)了上述的配置要求。

要實(shí)現(xiàn)以上的功能有幾個(gè)核心點(diǎn)：

加載所有配置文件。

將不同的配置文件用不同的對(duì)象進(jìn)行管理。

提供簡(jiǎn)易的接口使用。

由于 cicada 需要支持多個(gè)配置文件，所有需要定義一個(gè)抽象類供所有的配置管理實(shí)現(xiàn)。

定義比較簡(jiǎn)單，其中有兩個(gè)重要的成員變量：

文件名稱：用于初始化時(shí)通過名稱加載配置文件。

Properties 其實(shí)就是一個(gè) Map 結(jié)構(gòu)的緩存，用于存放所有的配置。當(dāng)然對(duì)外提供的查詢是基于它的。

接著就是在初始化時(shí)需要找出所有繼承了 AbstractCicadaConfiguration 的類。

查詢出來之后自然是要進(jìn)行遍歷同時(shí)反射創(chuàng)建對(duì)象。

由于之前已經(jīng)調(diào)用了

super.setPropertiesName("redis.properties");

來賦值配置文件名稱，所以還需要在遍歷過程中將 Properties 進(jìn)行賦值。

同時(shí)在這里也體現(xiàn)出優(yōu)先讀取的是 VM 啟動(dòng)參數(shù)中的配置文件。

String systemProperty = System.getProperty(conf.getPropertiesName());

需要額外提一點(diǎn)的是：在查找所有用戶自定義的配置管理類時(shí)需要手動(dòng)將 cicada 內(nèi)置的
ApplicationConfiguration 加入其中。

因?yàn)槭褂脩?yīng)用的包名通過反射是查詢不出該類的。

為了方便用戶在使用時(shí)候可以隨意的讀取各個(gè)配置文件，所以還需要將反射創(chuàng)建的對(duì)象保存到一個(gè)內(nèi)部緩存中，核心代碼就是上上圖中的這段代碼：

// add configuration cache
ConfigurationHolder.addConfiguration(aClass.getName(), conf);

其中 ConfigurationHolder 的定義如下。

其實(shí)也是利用一個(gè) Map 來存放這些對(duì)象。

這樣在使用時(shí)候只需要取出即可。

KafkaConfiguration configuration = (KafkaConfiguration) getConfiguration(KafkaConfiguration.class);
String brokerList = configuration.get("kafka.broker.list");

本次升級(jí)同時(shí)還重構(gòu)了部分代碼，比如啟動(dòng)類。

現(xiàn)在看上去要清爽和直接的多：

其中也有一點(diǎn)需要注意的地方。

大家如果查看日志的話會(huì)發(fā)現(xiàn)應(yīng)用啟動(dòng)之后會(huì)打印本次的耗時(shí)，自然就是在啟動(dòng)時(shí)候記錄一個(gè)時(shí)間，初始化完畢之后記錄一個(gè)即可。

在之前的實(shí)現(xiàn)中由于都是在一個(gè)方法內(nèi)，所以直接使用就行了。

但現(xiàn)在優(yōu)化之后跨越了不同的方法和類，難道要把時(shí)間作為參數(shù)在各個(gè)方法之前傳遞嘛？

那未免太不優(yōu)雅了。

所以 ThreadLocal 就有了發(fā)揮余地。

在初始化的方法中我將當(dāng)前時(shí)間寫入：

ThreadLocalHolder.setLocalTime(System.currentTimeMillis());

在最后記錄日志的地方直接取出比較即可：

這樣使用起來就完全不需要管什么參數(shù)傳遞了。

同時(shí) ThreadLocalHolder 的定義：

這里還是有一點(diǎn)需要注意，在這種長(zhǎng)生命周期的容器中一定得要記得及時(shí)清除。

我這里的時(shí)間在查詢一次之后就不用了，所以完全放心的在 getLocalTime() 方法中刪掉。

這就是本次 v1.0.2 中的升級(jí)內(nèi)容，包含了配置支持以及代碼重構(gòu)。其中有些內(nèi)容我覺得對(duì)接觸少的同學(xué)來說還是挺有幫助的。

關(guān)于上兩次的版本介紹請(qǐng)查看這里：

「造個(gè)輪子」——cicada(輕量級(jí) WEB 框架)

「造個(gè)輪子」——cicada 源碼分析

還沒點(diǎn)關(guān)注的朋友可以點(diǎn)波關(guān)注：

https://github.com/TogetherOS/cicada

也歡迎大家參與一起維護(hù)！。

同時(shí)后續(xù)關(guān)于 cicada 的更新會(huì)放慢一些。會(huì)介紹一些平時(shí)實(shí)戰(zhàn)相關(guān)的內(nèi)容，比如 Kafka 之類的，請(qǐng)持續(xù)關(guān)注。

你的點(diǎn)贊與轉(zhuǎn)發(fā)是最大的支持。