來,Consul 服務發現入個門(一看就會的那種)
阿新 • • 發佈:2021-03-12
### 前言
在微服務架構中,對於一個系統,會劃分出多個微服務,而且都是獨立開發、獨立部署,最後聚合在一起形成一個系統提供服務。當服務數量增多時,這些小服務怎麼管理?呼叫方又怎麼能確定服務的IP和埠?服務掛掉了又怎麼辦?單靠人工處理已經不太現實,使用系統統一管理就是最好的選擇,常用的服務發現產品有:**Consul**、**Zookeeper**、**Etcd**、**Eureka**等,而對於**Consul**在.NetCore中是很火很火的,所以接下來肯定先聊它嘍。
### 正文
Consul是一個支援多資料中心、分散式、高可用的服務發現和配置共享的系統,開箱即用,主要功能如下:
- **服務發現:**可以通過Consul客戶端註冊服務,這裡服務可以是API站點、Redis伺服器、MySql伺服器等;當其他客戶端需要使用對應的服務時,Consu可以通過DNS或HTTP的形式將服務返回給所需客戶端;無需再手動指定IP和埠,由Consul統一管理。
- **健康檢查:**Consul提供對各服務進行檢查的功能,相關人員可以通過檢查資訊關注各服務的執行情況;而對於的服務的使用者,可以避免訪問不健康的服務,如當一個API站點掛掉了,呼叫方從Consul中獲取服務資訊時就獲取不到,而是返回健康的服務資訊,從而保證呼叫API正常。
- **鍵值對儲存:**可以儲存鍵值對資料,很適合當配置中心使用。比如有多個服務,每個服務都一些配置資訊,可以將其統一配置在Consul中,避免每一個服務重複配置,很大程度降低了配置錯誤導致的風險。
- **多資料中心:**Consul支援多個開箱即用的資料中心,每個資料中心獨立執行。
簡單瞭解Consul功能之後,接下來就先說說**服務發現**和**健康檢查**的應用,大概的一個流程如下圖:
![image-20210311100147756](https://i.loli.net/2021/03/11/R2Xxnm3Gjc6DQHl.png)
上圖簡單描述
- 各服務通過**配置檔案或程式碼**的形式進行註冊,即把資訊報給Consul;
- Consul根據註冊的資訊,對已經註冊服務進行健康檢查;**Grpc、TCP、HTTP**方式都可以;
- 客戶端如果需要使用服務資訊,如IP和埠,可以通過Consul進行獲取健康的服務(服務發現);**DNS和HTTP**兩種方式都可以;
接來從安裝開始,做一個Demo演示,包括服務註冊、服務檢視、健康檢查、服務失效之後發郵件通知功能,算是從開發到維護走了一個流程(不過只是演示的那種)。
#### 1. 安裝
Consul的安裝可以說超級簡單,進官網->下載->解壓就完成安裝啦,官網地址:https://www.consul.io/;
找到下載頁面,選擇適合自己系統的版本,直接下載就行,如下圖:
![image-20210310232033732](https://i.loli.net/2021/03/11/MiKGgR3uoBN1qyD.png)
下載完成之後,直接解壓,然後開啟命令列工具,執行一下是否正常,如下圖:
![image-20210310232359403](https://i.loli.net/2021/03/11/SDjQFXkiYhq6WJA.png)
#### 2. 註冊服務
- **配置檔案形式**
首先肯定需要準備一個配置檔案,這裡為了檢視Consul執行時監控的服務資料,也可以指定對應資料輸出的目錄,所以還需要一個數據目錄,如下:
![image-20210310233213277](https://i.loli.net/2021/03/11/93aUZ52XMQtf7du.png)
**config**:作為配置檔案的存放位置,Conusl啟動時可以指定配置檔案位置,然後可以自動載入該目錄下所有json檔案;
**data**:這個就是一個空資料夾,用於儲存Consul執行時產生的資料,這個不是必須的。
有了目錄結構之後,然後在config中建立一個services.json檔案,裡面內容如下:
![image-20210310233859963](https://i.loli.net/2021/03/11/3OUCW1muzXtrbIS.png)
配置資訊見上圖已經做了相關說明,而對於健康檢查,因為上圖配置的是以**HTTP**的形式檢查API服務是否正常,即能否正常訪問對應地址,當然可以根據場景需要配置檢測方式,比如Grpc、TCP、指令碼等。
配置檔案準備好了之後,可以直接執行Consul啦,這裡為了快速入門,先以**開發模式執行**,如下:
![image-20210310234650593](https://i.loli.net/2021/03/11/Ern7gJD8PjHtTwk.png)
命令解析:
**agent**:執行代理;
**-dev**:以開發模式執行,快速開啟一個Server,資訊如上圖;
**-confile-file**:指定Consul配置檔案所在的目錄,然後就自動載入該目錄下的所有json檔案;
**-data-dir** : 指定Consul執行時儲存資料的目錄,一般包含服務的狀態及相關資訊;
用配置檔案這種方式,程式碼無需更改,只需保證服務執行的時候對應的**IP地址、埠、健康檢查的路徑**正確即可。由於現在還沒有對應的服務,根據上面配置的的資訊,每個5s會檢查一次,當前檢查的服務肯定是不健康的,Consul控制檯會持續輸出如下資訊:
![image-20210310235356055](https://i.loli.net/2021/03/11/fO4zgwYh3qidp7s.png)
新建一個WebAPI專案,增加一個Health健康檢查的Controller,然後指定埠為5000執行,控制器程式碼如下:
![image-20210310235753712](https://i.loli.net/2021/03/11/P7UqBdMgF9WyJI1.png)
執行之後,Consul 代理就檢測到了,如下:
![image-20210311000140016](https://i.loli.net/2021/03/11/DqtuafN96PEm7RW.png)
- **嵌入程式碼形式**
程式碼註冊的形式需要引入**Consul包**,然後在程式碼中指定Consul地址和配置相關服務資訊即可,其他無需改變,註冊程式碼邏輯如下:
先在配置檔案中配置相關資訊:
![image-20210311001101114](https://i.loli.net/2021/03/11/w1B4ap6LG3TkWsC.png)
服務註冊程式碼如下:
![image-20210311001155425](https://i.loli.net/2021/03/11/D1BNMlyqWx8Ghuk.png)
註冊服務方法完成之後,直接在Startup檔案中Configure方法的最後呼叫即可。然後指定對應埠啟動服務即可,演示設定的埠為6688,這樣服務就註冊完啦,Consul也能檢測到。
#### 3. 檢視服務
服務完成註冊之後,肯定是要需要檢視或使用,主要有以下三種方式:
- **UI形式**
Consul提供對應的頁面檢視註冊服務的相關資訊,當然也可以配置相關資訊。當Consul啟動之後,就可以通過http://localhost:8500/(這裡演示是本地)這個地址訪問到對應的介面,如下:
![image-20210311002544870](https://i.loli.net/2021/03/11/k9I8TMhlKXVSsvo.png)
介面就不挨個截圖啦,小夥伴自己點點。這個視覺化介面還是很給力的。
- **DNS和HTTP形式**
同樣也可以通過用命令方式進行檢視,有兩種形式,DNS和HTTP。這裡先用HTTP的方式演示,DNS方式留給小夥伴吧,很簡單的。
HTTP形式,直接呼叫介面即可(當然可以進行許可權控制);
![image-20210311094202264](https://i.loli.net/2021/03/11/ylt8wes3Nqb4QIH.png)
查詢服務常用的介面地址如下:
查詢所有服務:
http://localhost:8500/v1/catalog/services
根據服務名稱查詢服務,服務名稱就是在註冊服務時指定的名稱:
http://localhost:8500/v1/catalog/service/服務名稱
當同名稱的服務有多個時,可以根據Tag過濾:
http://localhost:8500/v1/catalog/service/服務名稱?tag=test6688
查詢其他型別資訊也和上面類似,比如查詢節點資訊、查詢資料中心資訊;
- **程式碼形式**
需要依賴Consul包,程式碼如下:
![image-20210311104118140](https://i.loli.net/2021/03/11/kjd8nIugPy4QW5B.png)
執行結果如下:
![image-20210311104229960](https://i.loli.net/2021/03/11/4b3OUje1iPhQgJA.png)
當然這種形式也能獲取Consul其他資訊,小夥伴除錯一下就知道啦;
#### 4. 監視服務(異常通知相關人員)
對於服務本身,可能因為網路或軟硬體的問題,導致服務掛掉,如果沒有及時恢復,有些業務可能會導致後果比較嚴重,所以當服務掛掉時,及時通知是必須的;這裡演示使用的是郵件的方式,需要簡單設定一下發送郵箱;這裡使用的是QQ郵箱發出,需要開啟QQ郵箱相關服務,在QQ郵箱設定中開啟即可,如下圖:
![image-20210311105409275](https://i.loli.net/2021/03/11/pnRxYQ7fS8MJHvG.png)
開啟的時候需傳送簡訊進行驗證,然後會獲得一個**授權碼**,在後面傳送郵件時會用到。
為了演示方便,傳送郵件通知的邏輯是寫在業務服務中,其實可以單獨出來一個服務專門負責通知即可。程式碼邏輯如下:
![image-20210311111150932](https://i.loli.net/2021/03/11/jvdZEqWzRDlA3ax.png)
增加一個通知介面,供監聽呼叫,當監聽到服務故障時,就呼叫該介面傳送郵件即可:
![image-20210311111456473](https://i.loli.net/2021/03/11/xlyYhi3PUorV6Wg.png)
程式碼準備好了,現在需要配置監視,只需要在配置目錄下增加監視的配置檔案即可,這裡取名為watchs.json,內容如下:
![image-20210311112010121](https://i.loli.net/2021/03/11/OhVscMvly12geut.png)
配置檔案完成之後,重啟Consul即可,命令和剛開始啟動的一樣; 然後將服務啟動,為了測試方便,服務用命令的方式啟動,方便關閉,命令如下:
```bash
dotnet ConsulCodeDemo.dll --urls "http://*:6688" # 指定埠啟動
dotnet ConsulConfigDemo.dll # 預設就是5000,所以不用指定啦
```
注:執行以上命令需要進入對應編譯的檔案目錄;
服務正常執行時,在Consul介面中可以看到各服務都是健康狀態,然後將埠為5000的這個服務關掉(因為配置郵件傳送的介面在6688上),Consul檢測到就會自動呼叫介面,傳送相關郵件。
![image-20210311113152319](https://i.loli.net/2021/03/11/Chatjq7xQW1Bd2k.png)
相關人員收到資訊就可以及時進行處理。
原始碼地址:https://github.com/zyq025/IDS4Demo/tree/main/ConsulDemo
### 總結
好了,Consul初探先到這吧,入門還差點,畢竟還有很多沒講,關於常用命令、叢集搭建、ACL配置等都沒涉及,所以下一篇來聊聊叢集搭建和ACL配置,對於常用命令的使用,一邊搭建環境,一邊進行解釋說明。
一個被程式搞醜的帥小夥,關注"Code綜藝圈",跟我一