1.介紹
Apollo(阿波羅)是攜程框架部研發並開源的一款生產級的配置中心產品,它能夠集中管理應用在不同環境、不同集群的配置,配置修改后能夠實時推送到應用端,並且具備規范的權限、流程治理等特性,適用於微服務配置管理場景。
2.架構和模塊
下面是Apollo架構模塊圖(來源自於波波微課):
上圖簡要描述了Apollo的總體設計,我們可以從下往上看:
●Config Service提供配置的讀取、推送等功能,服務對象是Apollo客戶端。
●Admin Service提供配置的修改、發布等功能,服務對象是Apollo Portal(管理界面)。
●Config Service和Admin Service都是多實例、無狀態部署,所以需要將自己注冊到Eureka中並保持心跳。
●在Eureka之上我們架了一層Meta Server用於封裝Eureka的服務發現接口。
●Client通過域名訪問Meta Server獲取Config Service服務列表(IP+Port),而后直接通過IP+Port訪問服務,同時在Client側會做load balance、錯誤重試。
●Portal通過域名訪問Meta Server獲取Admin Service服務列表(IP+Port),而后直接通過IP+Port訪問服務,同時在Portal側會做load balance、錯誤重試。
●為了簡化部署,我們實際上會把Config Service、Eureka和Meta Server三個邏輯角色部署在同一個JVM進程中。
2.1用戶在配置發布后的實時推送設計
在配置中心中,一個重要的功能就是配置發布后實時推送到客戶端。下面我們簡要看一下這塊是怎么設計實現的:
●用戶在Portal操作配置發布。
●Portal調用Admin Service的接口操作發布。
●Admin Service發布配置后,發送ReleaseMessage給各個Config Service。
●Config Service收到ReleaseMessage后,通知對應的客戶端。
2.2Apollo客戶端的實現原理
●客戶端和服務端保持了一個長連接,從而能第一時間獲得配置更新的推送(通過Http Long Polling實現)。
●客戶端還會定時從Apollo配置中心服務端拉取應用的最新配置。
○這是一個fallback機制,為了防止推送機制失效導致配置不更新。
○客戶端定時拉取會上報本地版本,所以一般情況下,對於定時拉取的操作,服務端都會返回304 - Not Modified。
○定時頻率默認為每5分鍾拉取一次,客戶端也可以通過在運行時指定System Property: apollo.refreshInterval來覆蓋,單位為分鍾。
●客戶端從Apollo配置中心服務端獲取到應用的最新配置后,會保存在內存中。
●客戶端會把從服務端獲取到的配置在本地文件系統緩存一份。
○在遇到服務不可用,或網絡不通的時候,依然能從本地恢復配置,不影響應用正常運行。本地緩存路徑位於C:\opt\data\{appId}\config-cache,所以請確保C:\opt\data\目錄存在,且應用有讀寫權限。
●應用程序可以從Apollo客戶端獲取最新的配置、訂閱配置更新通知。
2.3環境配置(Environment)
Apollo支持應用在不同的環境有不同的配置,所以Environment是另一個從服務器獲取配置的重要信息。Environment通過配置文件來指定,文件位置為C:\opt\settings\server.properties,文件內容形如:
env=DEV
目前,env支持以下幾個值(大小寫不敏感):
●DEV:Development environment
●FAT:Feature Acceptance Test environment
●UAT:User Acceptance Test environment
●PRO:Production environment
3.Apollo在Windows上快速啟動
3.1准備工作
3.1.1 Java jdk
●Apollo服務端:1.8+
●Apollo客戶端:1.7+
Java jdk1.8下載地址:https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html,這里提醒一下,安裝目錄名稱千萬別有空格,不然會Apollo啟動時候會報錯的。
在配置好后,可以通過如下命令檢查:
java -version
配置下環境變量:
3.1.2MySQL
●版本要求:5.6.5+(MySQL服務端安裝我就不說了,自行百度)
Apollo的表結構對timestamp使用了多個default聲明,所以需要5.6.5以上版本。
連接上MySQL后,可以通過如下命令檢查:
SHOW VARIABLES WHERE Variable_name = 'version';
3.1.3下載快速啟動安裝包
下載Apollo安裝包,大家只需要下載到本地,就可以直接使用,免去了編譯、打包過程。
●Github下載:https://github.com/nobodyiam/apollo-build-scripts
●百度網盤下載:https://pan.baidu.com/share/init?surl=Ieelw6y3adECgktO0ea0Gg,提取碼: 9wwe
安裝包要58M這么大,是因為這是一個可以自啟動的jar包,里面包含了所有依賴jar包以及一個內置的tomcat容器。解壓Apollo安裝包后會看到如下文件:
3.2安裝步驟
3.2.1創建數據庫
Apollo服務端共需要兩個數據庫:ApolloPortalDB和ApolloConfigDB,我們把數據庫、表的創建和樣例數據都分別准備了sql文件,只需要導入數據庫即可。
● 創建ApolloPortalDB:通過各種MySQL客戶端導入sql/apolloportaldb.sql即可。
下面以MySQL原生客戶端為例:
source /your_local_path/sql/apolloportaldb.sql
● 創建ApolloConfigDB:通過各種MySQL客戶端導入sql/apolloconfigdb.sql即可。
下面以MySQL原生客戶端為例:
source /your_local_path/sql/apolloconfigdb.sql
3.2.2配置數據庫連接信息
Apollo服務端需要知道如何連接到你前面創建的數據庫,所以需要編輯Apollo目錄中的demo.sh,修改ApolloPortalDB和ApolloConfigDB相關的數據庫連接串信息:
# apollo config db info apollo_config_db_url=jdbc:mysql://172.168.16.xxx:5621/ApolloConfigDB?characterEncoding=utf8 apollo_config_db_username=用戶名 apollo_config_db_password=密碼 # apollo portal db info apollo_portal_db_url=jdbc:mysql://172.168.16.xxx:5621/ApolloPortalDB?characterEncoding=utf8 apollo_portal_db_username=用戶名 apollo_portal_db_password=密碼
3.3啟動Apollo配置中心
快速啟動腳本會在本地啟動3個服務,分別使用8070, 8080, 8090端口,請確保這3個端口當前沒有被使用。
●在Linux/Mac下,可以通過如下命令檢查:
lsof -i:8080
●在Window下,可以通過如下命令檢查:
netstat -aon|findstr 8080
先切換到Apollo目錄:
cd D:\StudyDocuments\technology\Apollo\apollo-build-scripts-master
然后執行啟動腳本:
./demo.sh start
因為我是在本機部署Apollo服務端的,所以直接打開http://localhost:8070即可:
默認管理員用戶名:apollo,密碼:admin,輸入即可登錄成功!而Eureka默認端口是8080,即打開http://localhost:8080/即可:
阿波羅如何創建修改用戶密碼、創建用戶、部門,分配權限等等操作,我就不說了,大伙可以自行百度或者去官網了解,這不在本文范疇之內。
4.ASP.NET Core集成Apollo快速開發
4.1Apollo環境配置
Apollo默認有兩個組織部門,可以通過登錄后管理員工具-系統參數,輸入key值organizations添加修改。返回主界面點擊創建項目后,根據自身項目輸入相關項目信息,我這邊demo項目信息如下:
創建項目后,點擊進去可能會報如下錯誤提示:
這種錯誤一般是數據庫Eureka服務配置參數不正確導致的!因為我是本地部署Apollo服務端的,IIS已經存在一個站點占用了Eureka服務默認端口8080,所以停掉站點后,輸入demo.sh stop-demo.sh start重新啟動下Apollo即可。重新啟動Apollo后可能還會提示如下信息:
因為項目缺少環境namespaces配置,點擊左側“添加Namespace”選項添加一個dev開發環境namespaces:
namespaces創建后新增AspNetCore.Apollo.Test.WebApi項目開發環境配置:
上述配置相當於Core項目appsettings.json中以下配置:
然后點擊發布即可。
4.2ASP.NET Core集成Apollo
通過Github上https://github.com/ctripcorp/apollo.net源碼可以了解到,示例AspNetCore.Apollo.Test.WebApi應用可以通過appsettings.json文件可以添加Apollo環境配置信息:
{ "apollo": { "AppId": "AspNetCore.Apollo.Test.WebApi", //"Cluster": "test",////沒有集群,暫時隱藏 "MetaServer": "http://localhost:8080/", //"Secret": "ffd9d01130ee4329875ac3441c0bedda",////沒有ids4接入,暫時隱藏 //"Namespaces": [ "application.xml", "application.json", "application.yml", "application.yaml", "application" ],////沒有Namespace數組,暫時隱藏 "Namespace": "dev", "Env": "Dev", "Meta": { "DEV": "http://localhost:8080/" //"FAT": "http://106.54.227.205:8080/", //"UAT": "http://106.54.227.205:8080/", //"PRO": "http://106.54.227.205:8080/" ////示例暫時只有開發環境 } } }
然后在Program主程序入口引用Com.Ctrip.Framework.Apollo.Configuration Nuget包,添加Apollo環境配置信息,添加Namespace名稱,具體配置代碼如下:
.ConfigureAppConfiguration(builder => { var iConfigurationRoot = builder.Build(); var apolloInfo = iConfigurationRoot.GetSection("apollo"); var namespaceName = iConfigurationRoot.GetSection("apollo").GetSection("Namespace").Value; builder.AddApollo(apolloInfo).AddNamespace(namespaceName); })
然后運行示例AspNetCore.Apollo.Test.WebApi應用,會看到如下調試信息:
從上述調試信息可以看到Apollo在ASP.NET Core集成成功!
參考文獻:
Apollo
Apollo Quick-Start
Apollo配置中心設計
微服務架構~攜程Apollo配置中心架構剖析
.Net客戶端使用指南