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

来源:https://www.cnblogs.com/crossoverJie/archive/2018/09/14/9644274.html
-Advertisement-
Play Games

在前兩次的 cicada 版本中其實還不支持讀取配置文件,比如對埠、路由的配置。 因此我按照自己的想法創建了一個 issue ,也收集到了一些很不錯的建議。 ...


前言

在前兩次的 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

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

實現

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

  1. 載入所有配置文件。
  2. 將不同的配置文件用不同的對象進行管理。
  3. 提供簡易的介面使用。

由於 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 中的升級內容,包含了配置支持以及代碼重構。其中有些內容我覺得對接觸少的同學來說還是挺有幫助的。

關於上兩次的版本介紹請查看這裡:

還沒點關註的朋友可以點波關註:

https://github.com/TogetherOS/cicada

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

同時後續關於 cicada 的更新會放慢一些。會介紹一些平時實戰相關的內容,比如 Kafka 之類的,請持續關註。

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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 通過計算某個扇形區域的值占整個圓的百分比來得到這個扇形的角度,從而根據startAngle這個屬性來設定圖形的開始渲染的角度,使點擊某個扇形時圓環旋轉使之始終對準某個點。 期間考慮到某扇形區域太小點擊不到,來設置最小扇形區域。 const myChartContainer = document.ge ...
  • 原諒轉行小白比較笨,看了那麼多的文檔API仍是沒學好webpack,這陣子公司閑決定把webpack學完,現在開始表演,希望獲得老師轉身! 1、開門見山首先就是安裝,先安裝node.js,然後打開命令行(cmd)安裝webpack,執行命令:npm install webpack -g ok,檢查你 ...
  • const myChartContainer = document.getElementById( id ); const resizeMyChartContainer = function () { myChartContainer.style.width = ( window.innerWidt ...
  • co-dialog 版本v2.0.0 瀏覽器預設的alert彈出框 這是一個基礎的彈出框 co-dialog彈出框 你可以拖動我一下 這是一個layout佈局,靠右下角顯示的彈出框 超時自動關閉 顯示取消按鈕和功能 彈出框內容自定義 自定義動畫 確認回調函數 沒有圖片 線上地址 https://ko ...
  • 其實超級簡單,雖然網上很多,但是我順便記錄下相當於做筆記吧 1nodejs 的安裝, 在node官網下載,點擊安裝,安裝的時候最好選擇路徑在d盤 2設置環境變數 我的電腦-->屬性-->系統環境變數- 系統變數新增一個NODE_PATH , 在用戶變數上面加上這個path 安裝成功後,在cmd 輸入 ...
  • Web客戶端與伺服器之間基於Ajax(http)的常用通信方式,分為短連接與長輪詢。 短連接:客戶端和伺服器每進行一次HTTP操作,就建立一次連接,任務結束就中斷連接。 在長輪詢機制中,客戶端像傳統輪詢一樣從伺服器請求數據。然而,如果伺服器沒有可以立即返回給客戶端的數據,則不會立刻返回一個空結果, ...
  • BootStrap popover彈出框預設樣式,需修改彈出框樣式可在CSS中自定義要修改的樣式,例如:padding改為6px,背景顏色修改為黑色,字體顏色修改為白色 ...
  • 1、初始化element項目 1.1:vue init webpage '項目名稱' 1.2:npm i element-ui -S 1.3:在main.js添加 2、添加axios跨域請求 在main.js中添加 3、創建頁面 4、創建springboot項目 4.1添加一個controller類 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...