今天深入聊一聊攜程開源的一款分布式配置中心Apollo,在功能上和Nacos不相上下。
由于 Apollo 概念比較多,剛開始使用比較復雜,最好先過一遍概念再動手實踐嘗試使用。
隨著程序功能的日益復雜,程序的配置日益增多,各種功能的開關、參數的配置、服務器的地址……對程序配置的期望值也越來越高,配置修改后實時生效,灰度發布,分環境、分集群管理配置,完善的權限、審核機制…… 在這樣的大環境下,傳統的通過配置文件、數據庫等方式已經越來越無法滿足開發人員對配置管理的需求。因此 Apollo 配置中心應運而生!
Apollo(阿波羅)是攜程框架部門研發的開源配置管理中心,能夠集中化管理應用不同環境、不同集群的配置,配置修改后能夠實時推送到應用端,并且具備規范的權限、流程治理等特性。
如下即是 Apollo 的基礎模型:
圖片
Apollo支持4個維度管理Key-Value格式的配置:
(1)、application
(2)、environment
在實際開發中,我們的應用經常要部署在不同的環境中,一般情況下分為開發、測試、生產等等不同環境,不同環境中的配置也是不同的,在 Apollo 中默認提供了四種環境:
在程序中如果想指定使用哪個環境,可以配置變量 env 的值為對應環境名稱即可。
(3)、cluster
(4)、namespace
一個應用中不同配置的分組,可以簡單地把 namespace 類比為不同的配置文件,不同類型的配置存放在不同的文件中,如數據庫配置文件,RPC 配置文件,應用自身的配置文件等。
熟悉 SpringBoot 的都知道,SpringBoot 項目都有一個默認配置文件 application.yml,如果還想用多個配置,可以創建多個配置文件來存放不同的配置信息,通過指定 spring.profiles.active 參數指定應用不同的配置文件。這里的 namespace 概念與其類似,將不同的配置放到不同的配置 namespace 中。
Namespace 分為兩種權限,分別為:
Namespace 分為三種類型,分別為:
Apollo客戶端會把從服務端獲取到的配置在本地文件系統緩存一份,用于在遇到服務不可用,或網絡不通的時候,依然能從本地恢復配置,不影響應用正常運行。
本地緩存路徑默認位于以下路徑,所以請確保/opt/data或C:/opt/data/目錄存在,且應用有讀寫權限。
本地配置文件會以下面的文件名格式放置于本地緩存路徑下:
{appId}+{cluster}+{namespace}.properties
圖片
上圖簡要描述了Apollo客戶端的實現原理
這是一個 fallback 機制,為了防止推送機制失效導致配置不更新
客戶端定時拉取會上報本地版本,所以一般情況下,對于定時拉取的操作,服務端都會返回 304 - Not Modified
定時頻率默認為每 5 分鐘拉取一次,客戶端也可以通過在運行時指定 apollo.refreshInterval 來覆蓋,單位為分鐘。
配置更新推送實現
前面提到了 Apollo 客戶端和服務端保持了一個長連接,從而能第一時間獲得配置更新的推送。長連接實際上我們是通過 Http Long Polling 實現的,具體而言:
如果在 60 秒內有客戶端關心的配置變化,被保持住的客戶端請求會立即返回,并告知客戶端有配置變化的 namespace 信息,客戶端會據此拉取對應 namespace 的最新配置
如果在 60 秒內沒有客戶端關心的配置變化,那么會返回 Http 狀態碼 304 給客戶端
圖片
上圖簡要描述了Apollo的總體設計,我們可以從下往上看:
配置中心作為基礎服務,可用性要求非常高,下面的表格描述了不同場景下Apollo的可用性:
場景 | 影響 | 降級 | 原因 |
某臺 config service 下線 | 無影響 | Config service無狀態,客戶端重連其它config service | |
所有 config service 下線 | 客戶端無法讀取最新配置,Portal無影響 | 客戶端重啟時,可以讀取本地緩存配置文件 | |
某臺 admin service 下線 | 無影響 | Admin service無狀態,Portal重連其它 admin service | |
所有 admin service 下線 | 客戶端無影響,portal無法更新配置 | ||
某臺 portal 下線 | 無影響 | Portal域名通過slb綁定多臺服務器,重試后指向可用的服務器 | |
全部 portal 下線 | 客戶端無影響,portal無法更新配置 | ||
某個數據中心下線 | 無影響 | 多數據中心部署,數據完全同步,Meta Server/Portal 域名通過 slb 自動切換到其它存活的數據中心 |
接下來我們將創建一個 Apollo 的客戶端項目,引用 Apollo 來實現配置動態更新,不過在此之前我們需要提前進入 Apollo Portal 界面,在里面提前創建一個項目并在其配置一個參數,方便后續客戶端引入該配置參數,測試是否能動態變化。
我這里是部署到 Kubernetes 中,通過 NodePort 方式暴露出一個端口,打開這個地址登錄 Apollo:
圖片
在登錄后創建項目時,選擇部門默認只能選擇 Apollo 自帶的 測試部門1與測試部門2兩個選項。
圖片
開始這真讓人迷糊,原來 Apoloo 沒有修改或新增部門信息的管理節目,只能通過修改數據庫,來新增或者修改數據,這里打開 Portal 對月的數據庫中的表 ApolloPortalDB 修改 key 為 organizations 的 value 的 json 數據,改成自己對于的部門信息。
圖片
修改完數據庫部門信息后,重新登錄 Apollo Portal,然后創建項目,這時候選擇部門可以看到已經變成我們自己修改后的部門信息了,選擇我們自定義部門,然后設置應用 ID 為 apollo-test,應用名為 apollo-demo 。
圖片
創建完成后進入配置管理界面
圖片
創建一個配置參數,方便后續 Apollo 客戶端項目引入該參數,進行動態配置測試。
圖片
設置 key 為 test value 為 123456 然后設置一個備注,保存。
圖片
創建完成后可以看到配置管理節目新增了一條配置。
圖片
接下來我們將此配置通過發布按鈕,進行發布。
圖片
這里創建一個 SpringBoot 項目,引入 Apollo 客戶端來來實現與 Apollo 配置中心服務端交互。
<?xml versinotallow="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.8.RELEASE</version> </parent> <groupId>club.mydlq</groupId> <artifactId>apollo-demo</artifactId> <version>0.0.1</version> <name>apollo-demo</name> <description>Apollo Demo</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>com.ctrip.framework.apollo</groupId> <artifactId>apollo-client</artifactId> <version>1.4.0</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build></project>
在 application.yml 配置文件中添加下面參數,這里簡單介紹下 Apollo 參數作用:
#應用配置server: port: 8080spring: application: name: apollo-demo#Apollo 配置app: id: apollo-test #應用IDapollo: cacheDir: /opt/data/ #配置本地配置緩存目錄 cluster: default #指定使用哪個集群的配置 meta: http://192.168.2.11:30002 #DEV環境配置中心地址 autoUpdateInjectedSpringProperties: true #是否開啟 Spring 參數自動更新 bootstrap: enabled: true #是否開啟 Apollo namespaces: application #設置 Namespace eagerLoad: enabled: false #將 Apollo 加載提到初始化日志系統之前
寫一個 Controller 類來輸出 test 變量的值,使用了 Spring 的 @Value 注解,用于讀取配置文件中的變量的值,這里來測試該值,項目啟動后讀取到的變量的值是設置在 application 配置文件中的默認值,還是遠程 Apollo 中的值,如果是 Apollo 中配置的值,那么再測試在 Apollo 配置中心中改變該變量的值后,這里是否會產生變化。
import org.springframework.beans.factory.annotation.Value;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class TestController { @Value("${test:默認值}") private String test; @GetMapping("/test") public String test(){ return "test的值為:" + test; }}
SpringBoot 項目啟動類。
import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }}
由于本人的 Apollo 是部署在 Kubernetes 環境中的,JVM 參數中必須添加兩個變量:
如果是在 Idea 中啟動,可以配置啟動參數,加上:
-Dapollo.cnotallow=http://192.168.2.11:30002 -Denv=DEV
如果是 java 命令啟動程序,需要 JVM 加上:
$ java -Dapollo.cnotallow=http://192.168.2.11:30002 -Denv=DEV -jar apollo-demo.jar
“
注意:上面 env 指定的環境,要和 apollo.meta 指定 Config 地址的環境一致,例如 -Denv=DEV 即使用開發環境,那么 apollo.meta=http://xxx.xxx.xxx:8080 這個url 的 Config 也是開發環境下的配置中心服務,而不能是 PRO 或者其它環境下的配置中心。
”
啟動上面的測試用例,然后輸入地址 http://localhost:8080/test 查看:
test的值為:123456
可以看到使用的是 Apollo 中配置的 test 參數的值 123456,而不是默認的值。
修改 Apollo 配置中心參數 test 值為 666666 ,然后再次發布。
圖片
發布完成后再次輸入地址 http://localhost:8080/test 查看:
test的值為:666666
可以看到示例應用中的值已經改變為最新的值。
圖片
回滾完成后狀態將變為未發布狀態,則時候輸入地址 http://localhost:8080/test 查看:
test的值為:123456
可以看到已經回滾到之前的 test 配置的值了。
這里我們將 JVM 參數中 Apollo 配置中心地址故意改錯:
-Dapollo.cnotallow=http://192.168.2.100:30002 -Denv=DEV
然后輸入地址 http://localhost:8080/test 可以看到值為:
test的值為:123456
可以看到顯示的值并不是我們定義的默認值,而還是 Apollo 配置中心配置的 test 參數的值。考慮到由于 Apollo 會在本地將配置緩存一份,出現上面原因,估計是緩存生效。當客戶端不能連接到 Apollo 配置中心時候,默認使用本地緩存文件中的配置。
上面我們配置了本地緩存配置文件存放地址為 "/opt/data/" ,接下來進入緩存目錄,找到對應的緩存配置文件,刪除緩存配置文件后,重啟應用,再次輸入地址查看:
test的值為:默認值
刪除緩存配置文件后,可以看到輸出的值為自己定義的默認值。
這里我們進入 Apollo 配置中心,刪除之前創建的 test 參數,然后發布。
圖片
然后再次打開地址 http://localhost:8080/test 查看:
test的值為:默認值
可以看到顯示的是應用程序中設置的默認值。
在 Apollo 中,配置可以根據不同的環境劃分為 Dev(開發)、Prod(生產) 等環境,又能根據區域劃分為不同的 Cluster(集群),還能根據配置參數作用功能的不同劃分為不同的 Namespace(命名空間),這里探究下,如何使用上述能力。
(1)、Apollo 配置中心 PRO 環境添加參數
打開 Apollo 配置中心,環境列表點擊 PRO 環境,然后新增一條配置,和之前例子中參數保持一致,都為 test 參數,創建完成后發布。
圖片
然后修改上面的示例項目,將配置參數指定為 PRO 環境:
(2)、示例項目修改 application.yml 配置文件
把 apollo.meta 參數改成 RPO 的配置中心地址
......apollo: meta: http://192.168.2.11:30005 #RPO環境配置中心地址 ......
(3)、示例項目修改 JVM 參數
把 apollo.configService 參數改成 PRO 配置中心地址,env 參數的值改為 PRO。
-Dapollo.cnotallow=http://192.168.2.11:30005 -Denv=PRO
(4)、啟動示例項目觀察結果
啟動示例項目,然后接著輸入地址 http://localhost:8080/test 查看信息:
test的值為:abcdefg
可以看到已經改成生成環境配置,所以在實際項目中,如果要更換環境,需要修改 JVM 參數 env(如果 Apollo 部署在 Kubernetes 環境中,還需要修改 apollo.configService 參數),和修改 application.yml 配置文件的參數 apollo.meta 值。
(1)、創建兩個集群
例如在開發過程中,經常要將應用部署到不同的機房,這里分別創建 beijing、shanghai 兩個集群。
圖片
圖片
圖片
(2)、兩個集群都配置同樣的參數不同的值
在兩個集群 beijing 與 shanghai 中,都統一配置參數 test,并且設置不同的值。
圖片
圖片
(3)、示例項目 application.yml 修改集群配置參數,并啟動項目觀察結果
指定集群為 beijing:
......apollo: cluster: beijing #指定使用 beijing 集群......
啟動示例項目,然后接著輸入地址 http://localhost:8080/test 查看信息:
test的值為:Cluster-BeiJing
可以看到用的是 beijing 集群的配置
指定集群為 shanghai:
......apollo: cluster: shanghai #指定使用 shanghai 集群......
啟動示例項目,然后接著輸入地址 http://localhost:8080/test 查看信息:
test的值為:Cluster-ShangHai
可以看到用的是 shanghai 集群的配置
(1)、創建兩個命名空間
命名空間有兩種,一種是 public(公開),一種是 private 私有,公開命名空間所有項目都能讀取配置信息,而私有的只能 app.id 值屬于該應用的才能讀取配置。
這里創建 dev-1 與 dev-2 兩個私有的命名空間,用于測試。
圖片
圖片
圖片
(2)、兩個集群都配置同樣的參數不同的值
在兩個命名空間中,都統一配置參數 test,并且設置不同的值,設置完后發布。
圖片
(3)、示例項目 application.yml 修改命名空間配置參數,并啟動項目觀察結果
指定命名空間為 dev-1:
......apollo: bootstrap: namespaces: dev-1 #設置 dev-1 命名空間......
啟動示例項目,然后接著輸入地址 http://localhost:8080/test 查看信息:
test的值為:dev-1 Namespace
可以看到用的是 dev-1 命名空間的配置
指定命名空間為 dev-2:
......apollo: bootstrap: namespaces: dev-2 #設置 dev-1 命名空間......
YAML
啟動示例項目,然后接著輸入地址 http://localhost:8080/test 查看信息:
test的值為:dev-2 Namespace
HTML
可以看到用的是 dev-2 命名空間的配置
本人的 Apollo 和 SpringBoot 應用一般都是基于 Kubernetes 部署的,所以這里簡單介紹下,如何在 Kubernetes 環境下部署 SpringBoot 應用且使用 Apollo 作為配置中心。
這里項目依舊使用上面的示例,不過首先要將其編譯成 Docker 鏡像,方便后續部署到 Kubernetes 環境下。
(1)、執行 Maven 編譯
首先執行 Maven 命令,將項目編譯成一個可執行 JAR。
$ mvn clean install
BASH
(2)、準備 Dockerfile
創建構建 Docker 鏡像需要的 Dockerfile 文件,將 Maven 編譯的 JAR 復制到鏡像內部,然后設置兩個變量,分別是:
Dockerfile:
FROM openjdk:8u222-jre-slimVOLUME /tmpADD target/*.jar app.jarRUN sh -c 'touch /app.jar'ENV JAVA_OPTS="-XX:MaxRAMPercentage=80.0 -Duser.timeznotallow=Asia/Shanghai"ENV APP_OPTS=""ENTRYPOINT [ "sh", "-c", "java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -jar /app.jar $APP_OPTS" ]
(3)、構建 Docker 鏡像
執行 Docker Build 命令構建 Docker 鏡像。
$ docker build -t mydlqclub/springboot-apollo:0.0.1 .
BASH
(1)、創建 SpringBoot 且使用 Apollo 配置中心的 Kubernetes 部署文件
這里創建 Kubernetes 下的 SpringBoot 部署文件 apollo-demo-example.yaml。在之前 Dockerfile 中設置了兩個環境變量,JAVA_OPTS 與 APP_OPTS。其中 JAVA_OPTS 變量的值將會作為 JVM 啟動參數,APP_OPTS 變量的值將會作為應用的配置參數。所以,這里我們將 Apollo 配置參數放置到變量中,這樣一來就可以方便修改與維護 Apollo 的配置信息。
“
在下面配置的環境變量參數中,設置的配置中心地址為 http://service-apollo-config-server-dev.mydlqclub:8080,這是因為 Apollo 部署在 K8S 環境中,且可以使用域名方式訪問,service-apollo-config-server-dev 是應用的 Service 名稱,mydlqcloud 是 K8S 下的 Namespace 名稱。
”
springboot-apollo.yaml
apiVersion: v1kind: Servicemetadata: name: springboot-apollospec: type: NodePort ports: - name: server nodePort: 31080 port: 8080 targetPort: 8080 - name: management nodePort: 31081 port: 8081 targetPort: 8081 selector: app: springboot-apollo---apiVersion: apps/v1kind: Deploymentmetadata: name: springboot-apollo labels: app: springboot-apollospec: replicas: 1 selector: matchLabels: app: springboot-apollo template: metadata: name: springboot-apollo labels: app: springboot-apollo spec: restartPolicy: Always containers: - name: springboot-apollo image: mydlqclub/springboot-apollo:0.0.1 imagePullPolicy: Always ports: - containerPort: 8080 name: server env: - name: JAVA_OPTS value: "-Denv=DEV" ##注意修改此處的 mydlqcloud 為你自己的 Namespace 名稱 - name: APP_OPTS value: " --app.id=apollo-demo --apollo.bootstrap.enabled=true --apollo.bootstrap.eagerLoad.enabled=false --apollo.cacheDir=/opt/data/ --apollo.cluster=default --apollo.bootstrap.namespaces=application --apollo.autoUpdateInjectedSpringProperties=true --apollo.meta=http://service-apollo-config-server-dev.mydlqcloud:8080 " resources: limits: memory: 1000Mi cpu: 1000m requests: memory: 500Mi cpu: 500m
(2)、部署 SpringBoot 應用到 Kubernetes
-n:創建應用到指定的 Namespace 中。
$ kubectl apply -f springboot-apollo.yaml -n mydlqcloud
BASH
上面的應用配置了 NodePort 端口,可以通過此端口訪問 Kubernetes 集群內的應用接口,本人 Kubernetes 集群地址為 192.168.2.11 且 NodePort 端口為 31081,所以瀏覽器訪問地址 http://192.168.2.11:31081/test 來測試接口,顯示:
test的值為:123456
可以看到能通過 Apollo 獲取參數值,此文章到此結束。
本文鏈接:http://www.www897cc.com/showinfo-26-58931-0.htmlApollo,真香!
聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯系,我們將在第一時間刪除處理。郵件:2376512515@qq.com
上一篇: 歐洲的編程語言三巨頭,只剩下一位了!