廬山真面目之六微服務架構Consul集群、Ocelot網關集群和Nginx版本實現
廬山真面目之六微服務架構Consul集群、Ocelot網關集群和Nginx版本實現
一、簡介
在上一篇文章《廬山真面目之五微服務架構Consul集群、Ocelot網關和Nginx版本實現》中,我們已經探討了如何搭建基於Consul服務集群的微服務架構。沒錯,那個版本也有它自己的問題,每篇文章都會解決一個問題,這樣大家就會更能理解每篇文章的技術點。如果我們把所有的東西都放在一篇文章里,太多了,不利於學習和查看。看完上一篇文章後,我們知道如何解決單節點Consul服務不穩定的問題,這樣問題就結束了嗎?當然沒有,否則就不會有今天這篇文章了。今天我們同樣要解決單節點Ocelot網關的高可用的問題,這個問題和單節點Consul服務有點類似,如果我們當前這個Ocelot網關服務掛掉,系統的整個鏈路就會垮掉,系統的高可用性就無從談起了。有了問題,我們就解決問題,要想高可用,那就要實現集群。Ocelot網關集群實例如何管理和發現呢?這個任務我們就交給Nginx服務。
1、說明
我先說明一下,這個實現的版本只過是測試版本,以後會把相關的技術點都增加上去,我們一步一步的演化而來,如果是大牛,就可以直接跳過,因為這些東西相對於您來說,這個太簡單了。特別說明,這裡的所有程式碼都經過測試,所以大家可以放心使用。
2、開發環境
以下就是開發環境,不用多說,都很簡單,一看就知道。
(1)、開發工具:Visual
Studio 2019
(2)、開發語言:C#
(3)、開發平台:Net
Core3.1,跨平台。
(4)、服務註冊:Consul集群,服務註冊、發現中心
(5)、服務治理:Ocelot集群,負載均衡、服務治理
(6)、網關服務:Nginx 服務組件,一個負載Consul服務,一個負載Ocelot網關。
(7)、作業系統:Windows
10,64bit。
3、我們的目標
今天我們的目標是,在Windows系統上實現基於Consul集群、Ocelot集群和Nginx網關服務的微服務架構,這樣既可以解決單節點Ocelot網關服務的不可靠性,也可以實現針對Ocelot網關集群的負載均衡。當然這個肯定不是最終版本,我們還會繼續演化下去。
目標框架如圖:
二、搭建Consul服務的集群。
在互聯網的環境下,任何服務組件都很難通過單打獨頭,獨立撐起一片天。隨著分散式技術的發展和日益成熟,互聯網的項目也開始進行分散式部署,或者是微服務架構部署。基於我們上一篇文章所介紹的,基於單點Consul搭建的微服務架構是有很大問題的。這種情況只是測試環境,不是真正的產品環境,如果我們想更接近產品環境,或者說,我們更接近真實環境,我們必須保證每個節點的高可用。
Consul 用 Golang 實現,因此具有天然可移植性(支援 Linux、windows 和 Mac OS X ),它的安裝包僅包含一個可執行文件,方便部署,與 Docker 等輕量級容器可無縫配合。
在這裡我們僅僅對Consul集群做簡單的介紹,具體的詳情可以自己去網上學習。Consul服務在Cluster集群上的每一個節點都運行一個Agent代理,這個Agent代理可以使用Server伺服器或者Client客戶端模式。Client客戶端負責到Server伺服器端的高效通訊,相對為無狀態的。 Server伺服器端負責:包括選舉領導節點,維護Cluster集群的狀態,對所有的查詢做出響應,跨數據中心的通訊等等。
Agent代理可以運行在Server伺服器模式或者Client客戶模式,每個數據中心至少有一個Agent代理運行在server伺服器模式,一般建議是3或者5個Server。部署單個Server是非常不好的,因為在失敗場景中出現數據丟失是不可避免的。我們今天要3個伺服器端和1個客戶端來完成我們今天的架構任務。
名詞解釋:
A、Client :Consul 的 Client模式,就是客戶端模式。是
Consul 節點的一種模式,這種模式下,所有註冊到當前節點的服務會被轉發到 Server,本身不具有持久化數據的功能。
B、Server :Consul 的 Server 模式,表明這個
Consul 是個 Server ,這種模式下,功能和 Client 都一樣,唯一不同的是,它會把所有的數據持久化的本地,這樣遇到故障,資訊是可以被保留的。
C、Server-Leader:是所有伺服器們的老大,它和其它
Server 不一樣的一點是,它需要負責同步註冊的資訊給其它的 Server ,同時也要負責各個節點的健康監測。
D、Raft:Server 節點之間的數據一致性保證協議使用的是 raft,而
Zookeeper 用的
PAXOS,ETCD採用的也是Raft服務發現協議,Consul 採用 http 和 DNS 協議,ETCD 只支援 http 。
E、服務註冊:Consul 支援兩種方式實現服務註冊,一種是通過 Consul 的服務註冊API(Http協議),由服務自己調用 API 實現註冊;另一種方式是通過
JSON 格式的配置文件實現註冊,將需要註冊的服務以
JSON 格式的配置文件給出。Consul 官方建議使用第二種方式。
Consul文檔://www.consul.io/docs
Consul官網://www.consul.io
我們開始在此搭建我們的Consul服務集群,以便改善單節點Consul的情況。
1、我們開始現在Consul服務組件,存放在沒有包含中文的目錄里。
下載地址://www.consul.io/downloads
2、解壓文件,並存放在你指定的工作目錄。
工作目錄:D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows
在這個目錄下邊,只有一個文件,consul.exe
3、開始啟動服務實例,3個伺服器端,一個客戶端。
Consul其實不需要安裝,這裡所說的安裝,指的是配置Consul地址到環境變數中,這樣就可以在cmd命令框中直接執行命令了,避免切換目錄。如果自己不嫌麻煩,就不用配置環境變數,我就沒有配置(主要執行次數少),每次執行就直接進入目錄執行Consul文件,執行命令:consul.exe,也就是Consul的文件名。
參數解釋:
consul agent:命令頭,必須要有。
-server:表示要啟動伺服器代理(agent)模式。Consul
Agent節點的運行模式有兩種,Server模式和Client模式。其區別就是Server模式數據可以持久化到本地,而Client模式不可以。
-ui:consul運行後,會提供一個//127.0.0.1:8500/ui/的網站,裡面存儲了Consul
Agent各個節點以及註冊的服務等相關資訊,即數據中心的網頁形式體現。這個參數代表是否創建這個網站,這個參數與這個數據中心網站有關。
-bind:本機的IP地址,集群內其他代理伺服器可以通過這個IP來訪問這台電腦的consul代理伺服器。
-bootstrap-expect:是集群啟動條件,指當伺服器端模式(Server模式)的代理達到這個數目後,才開始運行。
-data-dir:是存放數據中心數據的目錄,該目錄必須是穩定的,系統重啟後也繼續存在的。
-config-dir:是存放數據中心日誌的目錄,該目錄必須是穩定的,系統重啟後也繼續存在的。
-datacenter:當前Consul的中心數據的名稱,默認是dc1。
-node:節點在集群中的名稱,在一個集群中必須是唯一的,默認是該節點的主機名(代表一個機器)。
-client:本地IP地址,這裡使用
0.0.0.0 ,就表示這個伺服器所有IP都可以,即當這台電腦有倆IP,192.168.1.100和192.168.1.111,那麼通過這倆IP都可以訪問到這台機器的consul代理伺服器。
-join:表示當前的伺服器節點或者是客戶端節點要加入集群的伺服器,後面跟要加入的伺服器的具體IP地址。
安裝完成後,Agent就可以啟動了,我們開始搭建我們Consul集群了。
(1)、創建Server-Leader,Consul集群中的領導者。
命令:consul
agent –server -ui -bootstrap-expect=3 -data-dir D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData
-node=consul-Server1 –client=0.0.0.0 -bind=127.0.0.1 –datacenter=dc1 -config-dir
D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData\config
配置:
當前路徑:D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData\config
JSON配置:
效果:
(2)、創建Server-
Follower,Consul集群中的第一個追隨者
命令:consul agent
–server -ui -bootstrap-expect=3 -data-dir D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData2
-node=consul-Server2 –client=0.0.0.0 -bind=127.0.0.1 -config-dir D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData2\config
–datacenter=dc1 –join 127.0.0.1:8301
配置:
當前路徑:D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData2\config
JSON配置:
效果:
成功加入第一個Consul服務所創建的集群
(3)、創建Server-
Follower,Consul集群中的第二個追隨者
命令:consul
agent –server -ui -bootstrap-expect=3 -data-dir D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData3
-node=consul-Server3 –client=0.0.0.0 -bind=127.0.0.1 -config-dir D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData3\config
–datacenter=dc1 –join 127.0.0.1:8301
配置:
當前路徑:D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulData3\config
JSON配置:
效果:
(4)、創建Consul-Client ,Consul集群中的客戶端。
命令:consul
agent -ui –client=0.0.0.0 –bind=127.0.0.1 -data-dir=D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulClient
-node=consul-Client -config-dir=D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulClient\config
–datacenter=dc1 -join 127.0.0.1:8301
配置:
當前路徑:D:\Programs\MicroServices\ConsulCluster\consul_1.8.4_windows\ConsulClient\config
JSON配置:
效果:
4、驗證3個伺服器端和一個客戶端是否安裝成功。
執行這些命令,都要切換到Consul所在的目錄。切記。
(1)、consul
members 查看Consul成員列表。
3個server,1個client,狀態是:alive,說明集群創建成功。
(2)、我們在看看伺服器角色的分配是否合適?
執行命令:consul operator raft list-peers
(3)、我們也可以通過瀏覽器訪問以下地址,驗證Consul服務是否安裝成功。
第一主伺服器:
//localhost:8500
第二從伺服器: //localhost:9500
第三從伺服器: //localhost:10500
Consul客戶端: //localhost:11500
能看到如下截圖,也可以說明成功。我只截一個圖了,其他都類似。
三、配置Nginx服務組件
在這裡我並不想對Nginx做更多的介紹,網上的資料太多了,我在這裡只是簡單說明一下,如果大家想去學習有關Nginx的知識,請去網上自行惡補了。還要說明一下,在進行這項工作之前,請確保上一步的工作配置完成,就是Consul集群的配置工作,因為在這一步里我們要配置Nginx,使用的地址資訊就是Consul集群地址列表。
Nginx (engine x) 是一個高性能的HTTP和反向代理web伺服器,同時也提供了IMAP/POP3/SMTP服務。Nginx是由伊戈爾·賽索耶夫為俄羅斯訪問量第二的Rambler.ru站點開發的,第一個公開版本0.1.0發佈於2004年10月4日。其將源程式碼以類BSD許可證的形式發布,因它的穩定性、豐富的功能集、示例配置文件和低系統資源的消耗而聞名。2011年6月1日,Nginx 1.0.4發布。
其特點是佔有記憶體少,並發能力強,事實上Nginx的並發能力在同類型的網頁伺服器中表現較好,中國大陸使用Nginx網站用戶有:百度、京東、新浪、網易、騰訊、淘寶等。
1、下載Nginx服務組件。
網關下載://nginx.org/en/download.html
我下載的版本號是:1.18.0,隨著時間推移,你們下的版本可能不一樣,但是只要是穩定版本就可以了。
2、解壓到沒有包含中文字元的目錄里。
Nginx 根目錄:D:\Programs\MicroServices\ConsulNginx
Nginx.Conf文件目錄:D:\Programs\MicroServices\ConsulNginx\conf
3、開始配置nginx.conf 文件,配置很簡單,不多說了。
4、啟動Nginx 服務。
執行命令:start
nginx
如果修改文件後可以執行:nginx
–s reload
如果想停止獲或退出,可以執行:nginx –s
stop|quit
5、檢查Nginx服務是否啟動成功。
我們可以通過訪問以下地址,來驗證Nginx配置是否正確。
//localhost:8080,打開地址,我們看到了Consul服務介面,說明配置和啟動成功。
四、Ocelot服務治理組件簡介
今天要給大家介紹的Ocelot是一個基於 .net
core的開源WebAPI服務網關項目,它的功能非常強大,包括了路由、請求聚合、服務發現、認證鑒權、限流、負載均衡等功能。而這些功能都可以直接通過修改json配置文件即可使用,非常方便。Ocelot是系統中對外暴露的一個請求入口,所有外部介面都必須通過這個網關才能向下游API發出請求,就如地鐵中的安檢系統,所有人都必須經過安檢才能乘坐地鐵。
當然了,我今天肯定也不會對Ocelot服務組件進行詳細的討論,它有官網和詳細的文檔,如果想看它的源碼也是沒有問題的,因為它是開源的。如果大家想去學習的話,可以直接點擊我貼出的連接。
文檔://ocelot.readthedocs.io/en/latest
GIT://github.com/ThreeMammals/Ocelot
五、搭建Ocelot網關集群
在這一篇文章里,前兩步驟已經完成了Consul服務集群和Nginx的配置、安裝和啟動的工作。要想進行這一步,當然上面的兩個步驟也要成功,否則後面的程式碼無法測試,這個道理我想大家也很容易明白。這一步主要是涉及項目程式碼了,基本就沒有什麼開源項目的配置工作了。廢話少說,我們開始吧。
1、建立項目,並為項目引入 Consul包。
(1)、PatrickLiu.MicroService.Client(ASPNETCORE
MVC),客戶端項目,客戶端程式碼,訪問服務。
樣例程式碼:
1 using System; 2 using System.Collections.Generic; 3 using System.Linq; 4 using System.Net.Http; 5 using Consul; 6 using Microsoft.AspNetCore.Mvc; 7 using Microsoft.Extensions.Logging; 8 using PatrickLiu.MicroService.Interfaces; 9 using PatrickLiu.MicroService.Models; 10 11 namespace PatrickLiu.MicroService.Client.Controllers 12 { 13 public class HomeController : Controller 14 { 15 private readonly ILogger<HomeController> _logger; 16 private readonly IUserService _userService; 17 private static int index; 18 19 /// <summary> 20 /// 初始化該類型的新實例。 21 /// </summary> 22 /// <param name="logger">注入日誌對象。</param> 23 /// <param name="userService">注入用戶服務對象。</param> 24 public HomeController(ILogger<HomeController> logger, IUserService userService) 25 { 26 _logger = logger; 27 _userService = userService; 28 } 29 30 /// <summary> 31 /// 首頁。 32 /// </summary> 33 /// <returns></returns> 34 public IActionResult Index() 35 { 36 37 #region 通過 Ocelot 網關訪問服務實例。 38 39 string url = "//localhost:8080/gate/users/all";//Ocelot 集群的Nginx反向代理地址 40 41 #endregion 42 43 string content = InvokeAPI(url); 44 this.ViewBag.Users = Newtonsoft.Json.JsonConvert.DeserializeObject<IEnumerable<User>>(content); 45 Console.WriteLine($"This is {url} Invoke."); 46 47 #endregion 48 49 return View(); 50 } 51 52 53 /// <summary> 54 /// 封裝 HttpClient 實例,提供 Http 調用。 55 /// </summary> 56 /// <param name="url">http url 的地址。</param> 57 /// <returns>返回結束數據,格式:JSON。</returns> 58 public static string InvokeAPI(string url) 59 { 60 using (HttpClient client = new HttpClient()) 61 { 62 HttpRequestMessage message = new HttpRequestMessage(); 63 message.Method = HttpMethod.Get; 64 message.RequestUri = new Uri(url); 65 var result = client.SendAsync(message).Result; 66 string conent = result.Content.ReadAsStringAsync().Result; 67 return conent; 68 } 69 } 70 } 71 }
Startup.cs 的程式碼:
(2)、PatrickLiu.MicroService.Interfaces(NETCORE 類庫),定義介面。
樣例程式碼:
1 using PatrickLiu.MicroService.Models; 2 using System.Collections.Generic; 3 4 namespace PatrickLiu.MicroService.Interfaces 5 { 6 /// <summary> 7 /// 用戶服務的介面定義。 8 /// </summary> 9 public interface IUserService 10 { 11 /// <summary> 12 /// 查找指定主鍵的用戶實例對象。 13 /// </summary> 14 /// <param name="id">用戶的主鍵。</param> 15 /// <returns>返回查找到的用戶實例對象。</returns> 16 User FindUser(int id); 17 18 /// <summary> 19 /// 獲取所有用戶的實例集合。 20 /// </summary> 21 /// <returns>返回所有的用戶實例。</returns> 22 IEnumerable<User> UserAll(); 23 } 24 }
(3)、PatrickLiu.MicroService.Models(NETCORE 類庫),定義實例類型。
樣例程式碼:
1 using System; 2 3 namespace PatrickLiu.MicroService.Models 4 { 5 /// <summary> 6 /// 用戶模型。 7 /// </summary> 8 public class User 9 { 10 /// <summary> 11 /// 獲取或者設置用戶主鍵。 12 /// </summary> 13 public int ID { get; set; } 14 15 /// <summary> 16 /// 獲取或者設置用戶姓名。 17 /// </summary> 18 public string Name { get; set; } 19 20 /// <summary> 21 /// 獲取或者設置用戶帳號名稱。 22 /// </summary> 23 public string Account { get; set; } 24 25 /// <summary> 26 /// 獲取或者設置用戶密碼。 27 /// </summary> 28 public string Password { get; set; } 29 30 /// <summary> 31 /// 獲取或者設置用戶的電子郵箱地址。 32 /// </summary> 33 public string Email { get; set; } 34 35 /// <summary> 36 /// 獲取或者設置用戶角色。 37 /// </summary> 38 public string Role { get; set; } 39 40 /// <summary> 41 /// 獲取或者設置用戶的登錄時間。 42 /// </summary> 43 public DateTime LoginTime { get; set; } 44 } 45 }
(4)、PatrickLiu.MicroService.Services(NETCORE 類庫),定義服務實現。
樣例程式碼:
1 using PatrickLiu.MicroService.Interfaces; 2 using PatrickLiu.MicroService.Models; 3 using System; 4 using System.Collections.Generic; 5 using System.Linq; 6 7 namespace PatrickLiu.MicroService.Services 8 { 9 /// <summary> 10 /// 實現用戶服務介面的實現類型。 11 /// </summary> 12 public class UserService : IUserService 13 { 14 private IList<User> dataList; 15 16 /// <summary> 17 /// 初始化類型的實例 18 /// </summary> 19 public UserService() 20 { 21 dataList = new List<User>() 22 { new User {ID=1,Name="黃飛鴻",Account="HuangFeiHong",Password="HuangFeiHong123456",Email="[email protected]", Role="Admin", LoginTime=DateTime.Now }, 23 new User {ID=2,Name="洪熙官",Account="HongXiGuan",Password="HongXiGuan54667",Email="[email protected]", Role="Admin", LoginTime=DateTime.Now.AddDays(-5) }, 24 new User {ID=3,Name="方世玉",Account="FangShiYu",Password="FangShiYu112233",Email="[email protected]", Role="Admin", LoginTime=DateTime.Now.AddDays(-30) }, 25 new User {ID=4,Name="苗翠花",Account="MiaoCuiHua",Password="MiaoCuiHua887766",Email="[email protected]", Role="Admin", LoginTime=DateTime.Now.AddDays(-90) }, 26 new User {ID=5,Name="嚴詠春",Account="YanYongChun",Password="YanYongChun09392",Email="[email protected]", Role="Admin", LoginTime=DateTime.Now.AddMinutes(-50) }}; 27 } 28 29 /// <summary> 30 /// 查找指定主鍵的用戶實例對象。 31 /// </summary> 32 /// <param name="id">用戶的主鍵。</param> 33 /// <returns>返回查找到的用戶實例對象。</returns> 34 public User FindUser(int id) 35 { 36 return dataList.FirstOrDefault(user => user.ID == id); 37 } 38 39 /// <summary> 40 /// 獲取所有用戶的實例集合。 41 /// </summary> 42 /// <returns>返回所有的用戶實例。</returns> 43 public IEnumerable<User> UserAll() 44 { 45 return dataList; 46 } 47 } 48 }
(5)、PatrickLiu.MicroService.ServiceInstance(ASPNETCORE
WEBAPI),介面服務,必須引入PatrickLiu.MicroService.Services、PatrickLiu.MicroService.Models和PatrickLiu.MicroService.Interfaces。
【1】、安裝Consul服務組件,以支援Consul服務。
命令:Install-Package Consul
可以在項目菜單【依賴項】菜單上點擊右鍵,選擇【管理 NuGet 程式包】來安裝Consul服務。
【2】、HealthController.cs,主要用於Consul服務的健康檢查。
【3】、UsersController.cs,主要是業務類型,內容很簡單。
1 using System; 2 using System.Collections.Generic; 3 using System.Linq; 4 using System.Threading; 5 using Microsoft.AspNetCore.Authorization; 6 using Microsoft.AspNetCore.Mvc; 7 using Microsoft.Extensions.Configuration; 8 using Microsoft.Extensions.Logging; 9 using PatrickLiu.MicroService.Interfaces; 10 using PatrickLiu.MicroService.Models; 11 12 namespace PatrickLiu.MicroService.ServiceInstance.Controllers 13 { 14 /// <summary> 15 /// 用戶的 API 類型。 16 /// </summary> 17 [Route("api/[controller]")] 18 [ApiController] 19 public class UsersController : ControllerBase 20 { 21 #region 私有欄位 22 23 private readonly ILogger<UsersController> _logger; 24 private readonly IUserService _userService; 25 private IConfiguration _configuration; 26 27 #endregion 28 29 #region 構造函數 30 31 /// <summary> 32 /// 初始化該類型的新實例。 33 /// </summary> 34 /// <param name="logger">日誌記錄器。</param> 35 /// <param name="userService">用戶服務介面。</param> 36 /// <param name="configuration">配置服務。</param> 37 public UsersController(ILogger<UsersController> logger, IUserService userService, IConfiguration configuration) 38 { 39 _logger = logger; 40 _userService = userService; 41 _configuration = configuration; 42 } 43 44 #endregion 45 46 #region 實例方法 47 48 /// <summary> 49 /// 獲取一條記錄 50 /// </summary> 51 /// <param name="id"></param> 52 /// <returns></returns> 53 [HttpGet] 54 [Route("Get")] 55 public User Get(int id) 56 { 57 return _userService.FindUser(id); 58 } 59 60 /// <summary> 61 /// 獲取所有記錄。 62 /// </summary> 63 /// <returns></returns> 64 [HttpGet] 65 [Route("All")] 66 //[Authorize] 67 public IEnumerable<User> Get() 68 { 69 Console.WriteLine($"This is UsersController {this._configuration["port"]} Invoke"); 70 71 return this._userService.UserAll().Select((user => new User 72 { 73 ID = user.ID, 74 Name = user.Name, 75 Account = user.Account, 76 Password = user.Password, 77 Email = user.Email, 78 Role = $"{this._configuration["ip"]}:{this._configuration["port"]}", 79 LoginTime = user.LoginTime 80 })); ; 81 } 82 83 /// <summary> 84 /// 超時處理 85 /// </summary> 86 /// <returns></returns> 87 [HttpGet] 88 [Route("Timeout")] 89 public IEnumerable<User> Timeout() 90 { 91 Console.WriteLine($"This is Timeout Start"); 92 //超時設置。 93 Thread.Sleep(3000); 94 95 Console.WriteLine($"This is Timeout End"); 96 97 return this._userService.UserAll().Select((user => new User 98 { 99 ID = user.ID, 100 Name = user.Name, 101 Account = user.Account, 102 Password = user.Password, 103 Email = user.Email, 104 Role = $"{this._configuration["ip"]}:{this._configuration["port"]}", 105 LoginTime = user.LoginTime 106 })); ; 107 } 108 109 #endregion 110 } 111 }
【4】、增加擴展類型:ConsulExtension.cs
1 using Consul; 2 using Microsoft.Extensions.Configuration; 3 using Microsoft.Extensions.Hosting; 4 using System; 5 6 namespace PatrickLiu.MicroService.ServiceInstance.Utilities 7 { 8 /// <summary> 9 /// Consul 靜態擴展類。 10 /// </summary> 11 public static class ConsulExtension 12 { 13 /// <summary> 14 ///類型初始化器,初始化 Consul 網址和數據中心。 15 /// </summary> 16 static ConsulExtension() 17 { 18 Uri = new Uri("//localhost:8500"); 19 DataCenter = "dc1"; 20 } 21 22 /// <summary> 23 /// 獲取或者設置 Consul 的網址。 24 /// </summary> 25 public static Uri Uri { get; set; } 26 27 /// <summary> 28 /// 獲取或者設置數據中心。 29 /// </summary> 30 public static string DataCenter { get; set; } 31 32 /// <summary> 33 /// 向 Consul 服務中心註冊服務實例。 34 /// </summary> 35 /// <param name="configuration">配置對象。</param> 36 /// <param name="consulServiceName">在 Consul 服務中心註冊的服務類別名稱,多個實例的 ID 可以屬於一個服務類別名稱。</param> 37 /// <param name="serviceID">服務實例的主鍵值,必須唯一。</param> 38 public static void ConsulRegist(this IConfiguration configuration,string consulServiceName, string serviceID) 39 { 40 if (string.IsNullOrEmpty(consulServiceName) || string.IsNullOrWhiteSpace(consulServiceName)) 41 { 42 throw new ArgumentNullException("consulServiceName is null"); 43 } 44 if (string.IsNullOrEmpty(serviceID) || string.IsNullOrWhiteSpace(serviceID)) 45 { 46 throw new ArgumentNullException("serviceID is null."); 47 } 48 49 using (ConsulClient client = new ConsulClient(config => 50 { 51 config.Address = Uri; 52 config.Datacenter = DataCenter; 53 })) 54 { 55 string ip = configuration["ip"]; 56 int port = int.Parse(configuration["port"]); 57 int weight = string.IsNullOrWhiteSpace(configuration["weight"]) ? 1 : int.Parse(configuration["weight"]); 58 59 client.Agent.ServiceRegister(new AgentServiceRegistration() 60 { 61 ID = serviceID, 62 Name = consulServiceName, 63 Address = ip, 64 Port = port, 65 Tags = new string[] { weight.ToString() }, 66 Check = new AgentServiceCheck() 67 { 68 Interval = TimeSpan.FromSeconds(12), 69 HTTP = $"//{ip}:{port}/API/Health/Index", 70 Timeout = TimeSpan.FromSeconds(5), 71 DeregisterCriticalServiceAfter = TimeSpan.FromSeconds(20) 72 } 73 }).Wait(); 74 Console.WriteLine($"註冊服務:{ip}:{port}--Weight:{weight}"); 75 }; 76 } 77 78 /// <summary> 79 /// 向 Consul 服務中心註銷服務實例。 80 /// </summary> 81 /// <param name="applicationLifetime">配置對象。</param> 82 /// <param name="serviceID">服務實例的主鍵值,必須唯一。</param> 83 public static void ConsulDown(this IHostApplicationLifetime applicationLifetime, string serviceID) 84 { 85 if (string.IsNullOrEmpty(serviceID) || string.IsNullOrWhiteSpace(serviceID)) 86 { 87 throw new ArgumentNullException("serviceID is null"); 88 } 89 applicationLifetime.ApplicationStopped.Register(() => 90 { 91 using (var consulClient = new ConsulClient(config => { config.Address = Uri; config.Datacenter = DataCenter; })) 92 { 93 Console.WriteLine("服務已經退出"); 94 consulClient.Agent.ServiceDeregister(serviceID); 95 } 96 }); 97 } 98 } 99 }
【5】、修改 Startup.cs 程式碼。
1 using Consul; 2 using Microsoft.AspNetCore.Builder; 3 using Microsoft.AspNetCore.Hosting; 4 using Microsoft.Extensions.Configuration; 5 using Microsoft.Extensions.DependencyInjection; 6 using Microsoft.Extensions.Hosting; 7 using PatrickLiu.MicroService.Interfaces; 8 using PatrickLiu.MicroService.ServiceInstance.Utilities; 9 using PatrickLiu.MicroService.Services; 10 using System; 11 using System.Security.Policy; 12 13 namespace PatrickLiu.MicroService.ServiceInstance 14 { 15 /// <summary> 16 /// 應用程式啟動配置 17 /// </summary> 18 public class Startup 19 { 20 /// <summary> 21 /// 構造函數注入配置對象 22 /// </summary> 23 /// <param name="configuration">配置實例</param> 24 public Startup(IConfiguration configuration) 25 { 26 Configuration = configuration; 27 } 28 29 /// <summary> 30 /// 獲取配置實例。 31 /// </summary> 32 public IConfiguration Configuration { get; } 33 34 /// <summary> 35 /// 配置注入對象。 36 /// </summary> 37 /// <param name="services"></param> 38 public void ConfigureServices(IServiceCollection services) 39 { 40 //其他程式碼省略 41 services.AddSingleton<IUserService, UserService>(); 42 } 43 44 /// <summary> 45 /// 配置 HTTP 處理管道。 46 /// </summary> 47 /// <param name="app">應用程式對象。</param> 48 /// <param name="env">環境對象。</param> 49 /// <param name="applicationLifetime">應用程式生命周期的對象。</param> 50 public void Configure(IApplicationBuilder app, IWebHostEnvironment env,IHostApplicationLifetime applicationLifetime) 51 { 52 //其他程式碼省略 53 #region Consul 註冊 54 55 string serviceID = $"Service:{Configuration["ip"]}:{Configuration["port"]}---{Guid.NewGuid()}"; 56 string consuleServiceName = "PatrickLiuService"; 57 58 //註冊服務。 59 Configuration.ConsulRegist(consuleServiceName,serviceID); 60 61 //註銷服務 62 applicationLifetime.ConsulDown(serviceID); 63 64 #endregion 65 } 66 } 67 }
【6】、修改 Program.cs 程式碼,紅色標註代表增加的程式碼。
(6)、PatrickLiu.MicroService.Gateway(ASPNETCORE
WEBAPI),這是Ocelot 網關項目。
【1】、安裝Ocelot組件包。
在【程式包管理器控制台】執行命令
命令:Install-Package
Ocelot
當然也可以在項目下的【依賴項】上點右鍵,點擊【管理NuGet程式包】菜單,在【瀏覽】項先安裝,輸入Ocelot,在右側安裝則可以。
【2】、安裝Ocelot.Provider.Consul組件包。
在【程式包管理器控制台】執行命令。
命令:Intall-Package
Ocelot.Provider.Consul
當然也可以在項目下的【依賴項】上點右鍵,點擊【管理NuGet程式包】菜單,在【瀏覽】項先安裝,輸入Ocelot.Provider.Consul,在右側安裝則可以。
【3】、配置Startup.cs文件。
【4】、增加JSON配置文件,文件名:configuration.json。
【5】、修改
Program.cs 文件,使用上面增加的JSON配置文件。
【6】、啟動第一個網關實例。
命令:dotnet PatrickLiu.MicroService.Gateway.dll
–urls=//*:6297 –port=6297
【7】、啟動第二個網關實例。
命令:dotnet PatrickLiu.MicroService.Gateway.dll
–urls=//*:6298 –port=6298
【8】、啟動第三個網關實例。
命令:dotnet PatrickLiu.MicroService.Gateway.dll
–urls=//*:6299 –port=6299
【9】、驗證網關實例是否啟動成功。
第一網關地址://localhost:6297/gate/users/all,能獲取到數據表示一切成功。
截圖如下:
刷新地址後:
第二網關地址://localhost:6298/gate/users/all,能獲取到數據表示一切成功。
截圖如下:
刷新地址後:
第三網關地址://localhost:6299/gate/users/all,能獲取到數據表示一切成功。
截圖如下:
地址刷新後:
【10】、配置Ocelot網關集群的Nginx服務。
具體的下載方法,參考上面或者上文
目錄地址:D:\Programs\MicroServices\CulsterOcelotNginx
配置資訊:
【11】、驗證Ocelot網關集群的Nginx服務地址。
Nginx地址://localhost:8089/gate/users/all,能獲取到數據表示一切成功。
刷新地址,
完美實現負載均衡,激動的很。注意:客戶端程式要訪問的地址,就是這個地址://localhost:8080/gate/users/all
2、編譯項目,發布4個服務實例,獨立進程承載。
再次提醒大家,在開始啟動這4個服務實例之前,必須啟動Consul服務中心,就是上面搭建的Consul服務集群,該Consul集群由一個Nginx代理管理。
(1)、dotnet
PatrickLiu.MicroService.ServiceInstance.dll –urls=”//*:5726″
–ip=”127.0.0.1″ –port=5726
健康檢查如圖:
(2)、dotnet
PatrickLiu.MicroService.ServiceInstance.dll –urls=”//*:5727″
–ip=”127.0.0.1″ –port=5727
健康檢查如圖:
(3)、dotnet
PatrickLiu.MicroService.ServiceInstance.dll –urls=”//*:5728″
–ip=”127.0.0.1″ –port=5728
健康檢查如圖:
(4)、dotnet
PatrickLiu.MicroService.ServiceInstance.dll –urls=”//*:5729″
–ip=”127.0.0.1″ –port=5729
健康檢查如圖:
以上是我們成功啟動了4個服務實例,並且在Consul
服務中心註冊成功,也可以執行健康檢查,功能基本完善了。讓我們看看4個服務實例在Consul中心的樣子吧。
Nginx代理管理著由4個Consul服務組成的集群,Nginx的地址://localhost:8080,這個地址要配置到Ocelot網關的JSON文件里。Consul集群又管理者四個WebAPI服務實例,實現負載均衡:四個服務實例埠號分別是:5726,5727,5728,5729,地址:localhost。
訪問效果如圖:
3、客戶端訪問 Consul服務,最終訪問我們服務實例。
客戶端我們自己實現的輪訓策略,每次刷新,埠號都變,效果如圖:
5726埠的數據:
5727埠的數據:
5728埠的數據:
5729埠的數據:
4、我們的結論。
雖然我們現在增加了Consul集群,也增加了Ocelot網關集群,每個集群也都有自己的Nginx服務實現負載均衡,系統從整體上來說,穩定性和高可用性得到了的保障,看似挺圓滿的,這樣就完成了嗎?當然不是,還有另外一個問題等著我們去解決。這個問題就是,當前,我們所有的服務是沒有任何認證的,任何人和機構都可以隨便訪問我們的服務,這樣肯定不行的,相當於我們服務系統在互聯網上裸奔啊,沒有一點安全的措施。接下來,我們就要解決這個問題,這也是我們下一篇文章要解決的問題,有挑戰啊。
六、結束語
好了,今天就寫到這裡了。俗話說,兵來將擋水來土掩,只要我們勇往直前,道路一定是光明的,再者說,老天不會餓死努力的小鳥的。努力吧,每天進步一點點。