「造個輪子」——cicada 設計一個配置模塊

fsmStudy 發布于2019-08-19 11:09 / 3239人閱讀

摘要：同時也新增了一個。將不同的配置文件用不同的對象進行管理。由于需要支持多個配置文件，所有需要定義一個抽象類供所有的配置管理實現。其實就是一個結構的緩存，用于存放所有的配置。總結這就是本次中的升級內容，包含了配置支持以及代碼重構。

前言

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

因此我按照自己的想法創建了一個 issue ，也收集到了一些很不錯的建議。

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

同時將 cicada 升級到了 v1.0.2。

目標

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

我認為有以下幾點:

可以自定義配置，并且支持不同的環境（開發、測試、生產）。

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

理論上來說配置這個東西應當完全獨立出來，由一個配置中心來負責管理并且這樣可以與應用解耦。

不過這樣的實現和當前 cicada 的定義有些沖突，我想盡量小的依賴第三方組件并可以完全獨立運行。

因此基于這樣的情況便有了以下的實現。

使用

在看實現之前先看看基于目前的配置管理如何在業務中使用起來。

結合現在大家使用 SpringBoot 的習慣，cicada 默認會讀取 classpath 下的 application.properties 配置文件。并且會默認讀取其中的應用端口以及初始路由地址。

同時也新增了一個 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) ;
    }
}

這樣在不傳默認地址的時候 cicada 會從 application.properties 中讀取。

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

使用也比較簡單，只需要繼承 cicada 提供的一個抽象類即可。

public class KafkaConfiguration extends AbstractCicadaConfiguration {

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


}

public class RedisConfiguration extends AbstractCicadaConfiguration {


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

}

按照這樣的配置也會默認從 classpath 讀取這兩個配置文件。

當然這里有個前提：代碼里配置的文件名必須得和配置文件名稱相同。

那如何在業務中讀取這兩個配置文件的內容呢？

這也簡單，代碼一看就懂：

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

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

同時也支持獲取 application.properties 里的配置。

同時為了支持在不同環境的使用，當配置了啟動參數將會優先讀取。

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

這樣算是基本實現了上述的配置要求。

實現

要實現以上的功能有幾個核心點：

加載所有配置文件。

將不同的配置文件用不同的對象進行管理。

提供簡易的接口使用。

由于 cicada 需要支持多個配置文件，所有需要定義一個抽象類供所有的配置管理實現。

定義比較簡單，其中有兩個重要的成員變量：

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

Properties 其實就是一個 Map 結構的緩存，用于存放所有的配置。當然對外提供的查詢是基于它的。

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

查詢出來之后自然是要進行遍歷同時反射創建對象。

由于之前已經調用了

super.setPropertiesName("redis.properties");

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

同時在這里也體現出優先讀取的是 VM 啟動參數中的配置文件。

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

需要額外提一點的是：在查找所有用戶自定義的配置管理類時需要手動將 cicada 內置的
ApplicationConfiguration 加入其中。

因為使用應用的包名通過反射是查詢不出該類的。

保存自定義配置管理

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

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

其中 ConfigurationHolder 的定義如下。

其實也是利用一個 Map 來存放這些對象。

這樣在使用時候只需要取出即可。

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

重構

本次升級同時還重構了部分代碼，比如啟動類。

現在看上去要清爽和直接的多：

其中也有一點需要注意的地方。

大家如果查看日志的話會發現應用啟動之后會打印本次的耗時，自然就是在啟動時候記錄一個時間，初始化完畢之后記錄一個即可。

在之前的實現中由于都是在一個方法內，所以直接使用就行了。

但現在優化之后跨越了不同的方法和類，難道要把時間作為參數在各個方法之前傳遞嘛？

那未免太不優雅了。

所以 ThreadLocal 就有了發揮余地。

在初始化的方法中我將當前時間寫入：

ThreadLocalHolder.setLocalTime(System.currentTimeMillis());

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

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

同時 ThreadLocalHolder 的定義：

這里還是有一點需要注意，在這種長生命周期的容器中一定得要記得及時清除。

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

總結

這就是本次 v1.0.2 中的升級內容，包含了配置支持以及代碼重構。其中有些內容我覺得對接觸少的同學來說還是挺有幫助的。

關于上兩次的版本介紹請查看這里：

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

「造個輪子」——cicada 源碼分析

還沒點關注的朋友可以點波關注：

https://github.com/TogetherOS/cicada

也歡迎大家參與一起維護！。

同時后續關于 cicada 的更新會放慢一些。會介紹一些平時實戰相關的內容，比如 Kafka 之類的，請持續關注。

你的點贊與轉發是最大的支持。

云服務器 GPU云服務器模塊設計 cicada html模塊表格設計登錄模塊設計html

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://m.specialneedsforspecialkids.com/yun/77107.html

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

摘要：前言俗話說不要重復造輪子，關于是否有必要不再本次討論范圍。我把他定義為一個快速輕量級框架沒有過多的依賴，核心包僅。只需要創建一個項目，并引入核心包。在測試條件為并發連續壓測兩輪內存單核。 showImg(https://segmentfault.com/img/remote/1460000016244423?w=1500&h=1000); 前言俗話說「不要重復造輪子」，關于是否有必...

caohaoyu 2019-08-19 11:05 評論0 收藏0
造個輪子，基于 Laravel5.4 的下一代 PHP 開發框架（API/SPA/Vue2/iVi

摘要：像操作系統一樣，你可以通過安裝軟件，成為適用于你的電腦。先進的技術方案，使得你無需擔心后期功能拓展與迭代問題，大大降低了維護成本。對于一個超過三年生命周期的項目來說，最適合不過。總之，是新的技術方向標，能讓每個藝術家像構建工程一樣構建程序。這是我們團隊的一個非盈利項目，以Apache2.0協議開源...不限制商用 Notadd是什么 Notadd 是基于Laravel 和 Vue 的...

Rocture 2019-06-27 16:29 評論0 收藏0
造個輪子,我學到了什么

摘要：閱讀原文造個輪子我學到了什么聽說的最多的是不是不要重復的造輪子不要被這句話蒙騙了，這句話應該還沒說完整，在什么情況下不要造輪子實際項目中由于工期和質量原因，肯定不希望你造輪子，你造輪子花費時間且質量不如現有的輪子。閱讀原文：造個輪子,我學到了什么聽說的最多的是不是不要重復的造輪子？不要被這句話蒙騙了，這句話應該還沒說完整，在什么情況下不要造輪子?實際項目中由于工期和質量原因，肯定不...

Acceml 2019-08-16 16:43 評論0 收藏0
用Vue自己造個組件輪子，以及實踐背后帶來的思考

摘要：用造個組件輪子吧閏土大叔如果你掌握了的組件知識，相關的指令事件，花點時間你也可以造出這么個入門級的小輪子。接下來，拋出造輪子實踐背后帶來的一些思考。以上三部分內容構成了的整個執行過程。 showImg(https://segmentfault.com/img/bV1Tnu?w=754&h=500); 前言首先，向大家說聲抱歉。由于之前的井底之蛙，誤認為Vue.js還遠沒有覆蓋到二三線...

icyfire 2019-08-22 13:45 評論0 收藏0