如何利用apollo實(shí)現(xiàn)配置文件的灰度發(fā)布？

前言

在上一篇，通過dubbo的版本號控制，我們實(shí)現(xiàn)了一個服務(wù)的簡單的灰度發(fā)布過程，在真實(shí)的項(xiàng)目環(huán)境中，灰度發(fā)布的應(yīng)用場景是很多的，服務(wù)接口存在灰度的需求，本篇再介紹另一種比較常見的灰度需求場景，即配置文件的灰度發(fā)布

配置文件簡介

如今，微服務(wù)架構(gòu)盛行下，不管是互聯(lián)網(wǎng)大廠，還是規(guī)模較小的團(tuán)隊(duì)，都有一套自己的中央配置文件管理中心，各個微服務(wù)模塊都能接入中央配置文件，進(jìn)行統(tǒng)一的使用，現(xiàn)如今，配置中心的技術(shù)選擇也是非常豐富的，比如springcloud技術(shù)棧下的springcloud-config，springcloud-alibaba下自研的nacos，傳統(tǒng)的配置中心disconf，攜程出品的apollo等，都是不錯的選擇

不管外觀如何變化，他們的作用都是相同的，那就是統(tǒng)一管理微服務(wù)的配置，起到統(tǒng)一管理，統(tǒng)一維護(hù)，統(tǒng)一調(diào)度的作用

在這種形勢下，實(shí)際的業(yè)務(wù)中就出現(xiàn)了這么一種情況，配置管理中心可能存在針對不同環(huán)境，比如 dev,test，prod等環(huán)境各自的一套配置文件，但實(shí)際上，這還是無法滿足某些場景下的要求的

舉例來說，像上一篇介紹的，服務(wù)接口需要做到灰度使用，利用不同的版本號進(jìn)行控制，從而達(dá)到新功能和之前穩(wěn)定版本功能做到動態(tài)切換的效果，而配置文件是控制程序中某些業(yè)務(wù)的關(guān)鍵信息，同樣需要做到類似的功能，這種情況下該如何實(shí)現(xiàn)呢？

在一些開源的配置管理技術(shù)框架中，它們?yōu)榱藵M足這樣的需求就實(shí)現(xiàn)了類似的灰度發(fā)布的功能，本篇將介紹如何利用apollo實(shí)現(xiàn)配置文件的灰度發(fā)布

apollo簡介與快速搭建

關(guān)于apollo的介紹，網(wǎng)上有大量的參考和學(xué)習(xí)資料，主要想說的是，apollo是一款非常好用的配置管理工具，應(yīng)用于各個大中小型互聯(lián)網(wǎng)公司，可以無縫整合到很多java框架下，代碼侵入性低，而配置文件修改后實(shí)時生效是它的一大亮點(diǎn)

快速搭建過程

本篇基于centos7或者阿里云

1、安裝java環(huán)境

安裝JDK1.8及以上（省略）

2、安裝mysql

安裝mysql5.7及以上（省略）

3、github下載源碼包

下載Release版本

其主要的目錄文件如上圖所示，首先，在mysql中執(zhí)行下sql目錄下的兩個sql腳本，apollo的運(yùn)行依賴數(shù)據(jù)庫

4、將解壓后的文件上傳至服務(wù)器

修改demo.sh，主要修改連接數(shù)據(jù)庫信息

修改內(nèi)容如下，主要將數(shù)據(jù)庫連接信息配置成自己的數(shù)據(jù)庫IP即可

修改完畢后，啟動apollo，只需要執(zhí)行命令: sh demo.sh start 即可，等待服務(wù)啟動完畢之后，瀏覽器訪問：http://IP:8070，然后輸入默認(rèn)登錄用戶名和密碼 apollo/admin 即可進(jìn)入apollo主頁面

關(guān)于apollo的具體使用本文不做過多贅述，有興趣的同學(xué)可以深入學(xué)習(xí)

5、apollo創(chuàng)建一個項(xiàng)目

為了后文使用演示，這里快速創(chuàng)建一個app，和一個namespace，創(chuàng)建也非常簡單，只需要點(diǎn)擊 "創(chuàng)建應(yīng)用"即可

默認(rèn)是application應(yīng)用，當(dāng)然可以通過創(chuàng)建新的namespace的方式新建一個新的namespace，這個是為了各自的項(xiàng)目管理自身的配置文件進(jìn)行使用，為了方便測試，這里我們在application應(yīng)用下，創(chuàng)建了一個叫做dubbo的namespace，隨機(jī)添加幾個配置文件，即key/value的數(shù)據(jù)

友情提醒：注意appId，工程中后面有使用

以上的準(zhǔn)備工作到此結(jié)束

演示工程步驟

提前準(zhǔn)備一個springboot工程

1、添加核心依賴

主要包括springboot和apollo客戶端連接依賴

org.springframework.boot
spring-boot-starter-web
2.2.1.RELEASE



com.ctrip.framework.apollo
apollo-client
1.5.1

2、配置文件

server:
port:8001

#連接apollo的配置
app:
id:provider
apollo:
meta:http://IP:8080
bootstrap:
enabled:true
namespaces:dubbo

3、apollo連接測試

在工程中寫一個接口，測試一下是否能從apollo上面讀取到配置，測試讀取一下下面這個配置

@Value("${uyun:default}")
privateStringuyunname;

@GetMapping("/getUyunName")
publicStringgetUyunName(){
returnuyunname;
}

啟動項(xiàng)目，瀏覽器訪問一下該接口，可以看到能成功訪問到apollo，說明與apollo的整合完畢

如何解決本文開篇談到的使用apollo實(shí)現(xiàn)配置文件的灰度發(fā)布呢？回到apollo，我們注意到這里有個“灰度”按鈕

這是什么意思呢？簡單理解就是，使用這個灰度按鈕的功能，可以對當(dāng)前的配置文件進(jìn)行一份拷貝，類似備份，同時我們可以對灰度的配置進(jìn)行添加，修改，刪除等操作，而灰度文件的修改不會影響到主配置文件，下面我們對 "dubbo"這個配置文件做一下灰度的配置吧

點(diǎn)擊“灰度”

可以看到，灰度創(chuàng)建的內(nèi)容是對主配置文件的全量拷貝，當(dāng)然灰度配置也需要像主配置文件那樣進(jìn)行發(fā)布之后才能使用的，點(diǎn)擊發(fā)布，彈出一個需要我們設(shè)置灰度規(guī)則的框

簡單解釋下，既然是灰度發(fā)布的配置文件，自然不能讓所有的客戶端訪問到，這里apollo提供了幾種配置規(guī)則方式，這里我選擇了直接配置IP的方式，將本機(jī)的IP填進(jìn)去，然后保存，再次發(fā)布即可

這個規(guī)則的含義就是，當(dāng)前dubbo的這個灰度配置文件，只能允許我的本機(jī)IP進(jìn)行訪問，接下來就讓我們做一下驗(yàn)證吧

4、灰度配置測試

在工程中新增一個接口，同時給灰度配置文件中新增2個配置

@Value("${name:default}")
privateStringuname;

@Value("${age:default}")
privateStringage;

@GetMapping("/getUyunName")
publicStringgetUyunName(){
returnuyunname;
}

將本機(jī)的其中一個項(xiàng)目啟動，訪問新增的這個接口，可以發(fā)現(xiàn)，能夠成功訪問到灰度文件中的配置信息

為了驗(yàn)證灰度的功能，我們將項(xiàng)目打成jar包，部署到服務(wù)器上，服務(wù)器的IP不在灰度配置列表中，理論上是無法訪問到 age 這個新增的配置的

成功啟動后，瀏覽器直接訪問云服務(wù)器上面的這個接口，這時，可以發(fā)現(xiàn)，同樣的接口，由于IP未配置在灰度規(guī)則中，將無法讀取到age這個配置的值

踩坑提醒

如果使用的是阿里云或者其他云服務(wù)器部署apollo的時候，本地項(xiàng)目連接apollo的時候會一直報(bào)apollo的連接超時問題，這個問題的解決辦法是，在啟動的配置vm中，添加如下參數(shù)即可

-Dapollo.configService=http://apollo部署的主機(jī)IP:8080

審核編輯：劉清