廬山真面目之四微服務架構Consul集群和Nginx版本實現
廬山真面目之四微服務架構Consul集群和Nginx版本實現
一、簡介
在上一篇文章《廬山真面目之三微服務架構Consul版本實現》中,我們已經探討了如何搭建基於單節點Consul的微服務架構。沒錯,那個版本也有它自己的問題,每篇文章都會解決一個問題,這樣大家就會更能理解每篇文章的技術點。如果我們把所有的東西都放在一篇文章里,太多了,不利於學習和查看。我們看完上一篇文章後,知道了基於單節點Consul服務組件實現的微服務架構是有缺點的,而且這個缺點也是很致命的,如果這個Consul節點死掉,整個系統就會癱瘓掉,系統的高可用性就無從談起了。有了問題,我們就解決問題,想解決這個問題不難,要想高可用,那就要集群。集群如何被發現、訪問呢?我們就使用Nginx服務。
1、說明
我先說明一下,這個實現的版本只過是測試版本,以後會把相關的技術點都增加上去,我們一步一步的演化而來,如果是大牛,就可以直接跳過,因為這些東西相對於您來說,這個太簡單了。特別說明,這裡的所有程式碼都經過測試,所以大家可以放心使用。
2、開發環境
以下就是開發環境,不用多說,都很簡單,一看就知道。
(1)、開發工具:Visual
Studio 2019
(2)、開發語言:C#
(3)、開發平台:Net
Core3.1,跨平台。
(4)、服務註冊:Consul集群,服務註冊、發現中心
(5)、網關服務:Nginx 服務組件。
(6)、作業系統:Windows
10。
3、我們的目標
今天我們的目標是,在Windows系統上實現基於Consul服務集群和Nginx負載均衡的微服務架構,當然這個肯定不是最終版本,我們還會繼續演化下去。
二、Consul集群服務組件的簡介。
在互聯網的環境下,任何服務組件都很難通過單打獨頭,獨立撐起一片天。隨著分散式技術的發展和日益成熟,互聯網的項目也開始進行分散式部署,或者是微服務架構部署。基於我們上一篇文章所介紹的,基於單點Consul搭建的微服務架構是有很大問題的。這種情況只是測試環境,不是真正的產品環境,如果我們想更接近產品環境,或者說,我們更接近真實環境,我們必須保證每個節點的高可用。
Consul 用 Golang 實現,因此具有天然可移植性(支援 Linux、windows 和 Mac OS X ),它的安裝包僅包含一個可執行文件,方便部署,與 Docker 等輕量級容器可無縫配合。
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 不一樣的一點是,它需要負責同步註冊的資訊給其它的 Server ,同時也要負責各個節點的健康監測。
D、Raft:Server 節點之間的數據一致性保證協議使用的是 raft,而 zookeeper 用的
PAXOS,ETCD採用的也是Raft服務發現協議,Consul 採用 http 和 DNS 協議,ETCD 只支援 http 。
E、服務註冊:Consul 支援兩種方式實現服務註冊,一種是通過 Consul 的服務註冊 Http API,由服務自己調用 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工作目錄,執行命令:consul.exe,其實不用安裝,可以在環境變數里設置 Consul 文件的地址,就可以全局訪問了。
安裝完成後,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配置:
{ "ports": { "server": 8300, "serf_lan": 8301, "serf_wan": 8302, "http": 8500, "dns": 8600 } }
效果:
(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配置:
{ "ports": { "server": 9300, "serf_lan": 9301, "serf_wan": 9302, "http": 9500, "dns": 9600 } }
效果:
成功加入第一個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配置:
{ "ports": { "server": 10300, "serf_lan": 10301, "serf_wan": 10302, "http": 10500, "dns": 10600 } }
效果:
(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配置:
{ "ports": { "server": 11300, "serf_lan": 11301, "serf_wan": 11302, "http": 11500, "dns": 11600 } }
效果:
4、驗證3個伺服器端和一個客戶端是否安裝成功。
執行這些命令,都要切換到Consul所在的目錄。切記。
(1)、consul
members 查看Consul成員列表。
3個server,1個client,狀態是:alive,說明集群創建成功。
(2)、我們在看看伺服器角色的分配是否合適?
執行命令:consul operator raft list-peers
(3)、我們也可以通過瀏覽器訪問以下地址,驗證Consul服務是否安裝成功。
這些地址要記住,下一步,配置 Nginx 使用的到。
第一主伺服器:
//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 文件,配置很簡單,不多說了。
1 worker_processes 1; 2 3 4 events { 5 worker_connections 1024; 6 } 7 8 9 http { 10 include mime.types; 11 default_type application/octet-stream; 12 13 sendfile on; 14 keepalive_timeout 65; 15 16 #gzip on; 17 upstream MicroService{ 18 server localhost:8500; 19 server localhost:9500; 20 server localhost:10500; 21 server localhost:11500; 22 } 23 24 server { 25 listen 8080; 26 server_name localhost; 27 28 location / { 29 proxy_pass http://MicroService; 30 } 31 } 32 }
4、啟動Nginx 服務。
執行命令:start
nginx
如果修改文件後可以執行:nginx
–s reload
如果想停止獲或退出,可以執行:nginx –s
stop|quit
5、檢查Nginx服務是否啟動成功。
我們可以通過訪問以下地址,來驗證Nginx配置是否正確。
//localhost:8080,打開地址,我們看到了Consul服務介面,說明配置和啟動成功。
四、微服務架構Consul集群版本實現
在這一篇文章里,前兩步驟已經完成了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 { 62 //發現服務 63 string url = "//PatrickLiuService/api/users/all"; 64 65 ConsulClient client = new ConsulClient(config => 66 { 67 config.Address = new Uri("//localhost:8080/");//nginx網關地址 68 config.Datacenter = "dc1"; 69 }); 70 var response = client.Agent.Services().Result.Response; 71 foreach (var item in response) 72 { 73 Console.WriteLine("*************************************************************"); 74 Console.WriteLine(item.Key); 75 var service = item.Value; 76 Console.WriteLine($"{service.Address}--{service.Port}--{service.Service}"); 77 Console.WriteLine("*************************************************************"); 78 } 79 Uri uri = new Uri(url); 80 string groupName = uri.Host; 81 AgentService agentService = null; 82 83 var serviceDirectory = response.Where(s => s.Value.Service.Equals(groupName, StringComparison.OrdinalIgnoreCase)).ToArray(); 84 //{1、 寫死的 85 // agentService = serviceDirectory[0].Value; 86 //} 87 { 88 //2、輪詢 89 if (index >= 10000) 90 { 91 index = 0; 92 } 93 agentService = serviceDirectory[index++ % serviceDirectory.Length].Value; 94 } 95 //{//3、隨機 96 // var indexResult = new Random(index++).Next(0, serviceDirectory.Length); 97 // agentService = serviceDirectory[indexResult].Value; 98 //} 99 url = $"{uri.Scheme}://{agentService.Address}:{agentService.Port}{uri.PathAndQuery}"; 100 114 115 return View(); 116 } 117 122 123 /// <summary> 124 /// 封裝 HttpClient 實例,提供 Http 調用。 125 /// </summary> 126 /// <param name="url">http url 的地址。</param> 127 /// <returns>返回結束數據,格式:JSON。</returns> 128 public static string InvokeAPI(string url) 129 { 130 using (HttpClient client = new HttpClient()) 131 { 132 HttpRequestMessage message = new HttpRequestMessage(); 133 message.Method = HttpMethod.Get; 134 message.RequestUri = new Uri(url); 135 var result = client.SendAsync(message).Result; 136 string conent = result.Content.ReadAsStringAsync().Result; 137 return conent; 138 } 139 } 140 } 141 }
在 Startup.cs 類型的 ConfigureServices 方法增加的語句。
1 /// <summary> 2 /// 註冊服務到容器中。 3 /// </summary> 4 /// <param name="services"></param> 5 public void ConfigureServices(IServiceCollection services) 6 { 7 services.AddControllersWithViews(); 8 9 services.AddSingleton<IUserService, UserService>(); 10 }
(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),介面服務。
健康檢查調用的類型 HealthController.cs
1 using System; 2 using Microsoft.AspNetCore.Mvc; 3 using Microsoft.Extensions.Configuration; 4 5 namespace PatrickLiu.MicroService.ServiceInstance.Controllers 6 { 7 /// <summary> 8 /// 健康檢查的控制器。 9 /// </summary> 10 [ApiController] 11 [Route("api/[controller]")] 12 public class HealthController : ControllerBase 13 { 14 private IConfiguration _configuration; 15 16 /// <summary> 17 /// 初始化該類型的新實例。 18 /// </summary> 19 /// <param name="configuration">配置介面。</param> 20 public HealthController(IConfiguration configuration) 21 { 22 _configuration = configuration; 23 } 24 25 /// <summary> 26 /// 要調用的介面。 27 /// </summary> 28 [HttpGet] 29 [Route("Index")] 30 public IActionResult Index() 31 { 32 Console.WriteLine($"This is HealhController {_configuration["port"]} Invoke"); 33 return Ok(); 34 } 35 } 36 }
提供業務功能的服務類型 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 }
1)、我們要在這個項目裡面使用Consul 服務,所以,我們通過Nuget安裝。也可以執行命令安裝:Install-Package
Consul。
Install-Package Consul
2)、我們在Startup類裡面增加以下程式碼,紅色標註:
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 services.AddControllers(); 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 #region Consul 註冊 53 54 string serviceID = $"Service:{Configuration["ip"]}:{Configuration["port"]}---{Guid.NewGuid()}"; 55 string consuleServiceName = "PatrickLiuService"; 56 57 //註冊服務。 58 Configuration.ConsulRegist(consuleServiceName,serviceID); 59 60 //註銷服務 61 applicationLifetime.ConsulDown(serviceID); 62 63 #endregion 64 65 } 66 } 67 }
2、編寫註冊Consul 的核心程式碼。
我們增加了一個擴展類,類的名稱: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 }
3、編譯項目,發布4個服務實例,獨立進程承載。
再次提醒大家,在開始啟動這4個服務實例之前,必須啟動Consul服務中心。
(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 網關地址://localhost:8080,可以查看 Consul服務和註冊情況。
4、客戶端訪問 Consul服務,最終訪問我們服務實例。
客戶端我們自己實現的輪訓策略,每次刷新,埠號都變,效果如圖:
5726埠的數據:
5727埠的數據:
5728埠的數據:
5729埠的數據:
5、我們的結論。
雖然我們現在增加了Consul集群,保證了服務實例高可用,也保證了Consul服務組件的高可用,這樣就完成了嗎?當然不是,還有另外一個問題等著我們去解決。另外一個問題就是,難道客戶端直接訪問為Consul集群創建的Nginx服務,但是這樣也不是很好。我們需要控制客戶端訪問,例如:限流、快取、斷流、熔斷等操作,如要完成這樣的操作,我們必須引入網關的概念,網關要想高可用,當然也要集群。我們如何管理這些網關實例呢?通過相同做法來實現,增加Nginx服務組件。這樣我們通過網關就實現服務治理的繁瑣工作。網關的引入,我們也要引入另外一個概念,它就是Ocelot這個組件。
五、
結束語
好了,今天就寫到這裡了。內容挺多了,整理起來也挺麻煩的,但是每天這樣堅持,每天都有進步,生活過的也很充實。通過今天的學習,我們還需要繼續改進我們的項目,Consul服務集群解決了consul服務的高可用。針對服務實例,我們還有很多其他工作要做,例如:熔斷、降級、限流、快取等,所以我們需要引入網關,網關要想高可用,當然也要集群,在集群之上再包一層Nginx服務,統一對網關的訪問。努力吧,每天進步一點點。