# <center>Consul+Ocelot的服務網關與註冊等功能的實現</center> 此文檔主要提供給開發人員使用, 暫時僅實現服務註冊、服務發現、負載均衡等功能, 更多功能需配合官方文檔或第三方文檔進行更細緻化開發。 ###`有興趣可以瞭解一下` * #### Consul相關: * [C ...
下麵的是markdown格式的文檔,懶得排版了,有興趣的話可以去github上看,有源碼
Github:https://github.com/yuchengao0721/Consul-Ocelot.git
# <center>Consul+Ocelot的服務網關與註冊等功能的實現</center>
此文檔主要提供給開發人員使用,
暫時僅實現服務註冊、服務發現、負載均衡等功能,
更多功能需配合官方文檔或第三方文檔進行更細緻化開發。
###`有興趣可以瞭解一下`
* #### Consul相關:
* [Consul官網](https://www.consul.io/)
* [Consul簡介](https://blog.51cto.com/firephoenix/2131616)
* [Consul使用手冊](https://blog.csdn.net/liuzhuchen/article/details/81913562)
* [Consul配置手冊](https://www.cnblogs.com/sunsky303/p/9209024.html)
* #### Ocelot相關:
* [Ocelot官網](https://ocelot.readthedocs.io/en/latest/)
* [Ocelot簡介](https://blog.csdn.net/qin_yu_2010/article/details/82323003)
## 1. Windows環境的搭建
在Windows環境下搭建consul進行服務註冊、服務網關等
此次環境配置:
Server
ip:192.168.199.203
Windows版本:WS 2012 R2 Standard
處理器:i5-4570
記憶體:8G
系統類型:X64
Client
ip:192.168.199.40
Windows版本:W10企業版
處理器:i7-3720QM
記憶體:8G
系統類型:X64
### 1.1 伺服器環境搭建
* #### 1.1.1 Consul_Server端
* ##### step1
前往Consul官網[下載](https://www.consul.io/downloads.html) windows版本的Consul安裝程式
* ##### step2
將下好的軟體複製到一個新建好的文件夾A,在文件夾A內部新建server.json文件,寫入內容
```javascript
{
"datacenter": "dc1",
"data_dir": "opt/consul/data",
"node_name": "consul-server01",//你的Consul服務的別名
"server": true,
"bootstrap_expect": 1,
"bind_addr": "192.168.199.203",//你伺服器的ip或者外網功能變數名稱
"client_addr": "0.0.0.1",//此處固定寫法,方便其他機器查看你的ConsulUI
"ui":true
}
```
* ##### step3
在文件夾A內部新建runconsul.bat文件,寫入內容
'''
consul agent -config-dir server.json
pause
'''
* ##### step4
運行runconsul.bat文件,出現下列內容即為開啟成功
![](WindowsServerStep4.jpg)
在伺服器上打開瀏覽器輸入127.0.0.1:8500,可以查看Consul運行情況,
* #### 1.1.2 Consul_Client端
* ##### step1
前往Consul官網[下載](https://www.consul.io/downloads.html) windows版本的Consul安裝程式
* ##### step2
將下好的軟體複製到一個新建好的文件夾A,在文件夾A內部新建server.json文件,寫入內容
```javascript
{
"datacenter": "dc1",
"data_dir": "opt/consul/data",
"node_name": "ych-Client",//你的Client的別名(僅支持全字母、數字、破折號)
"server": false,//是否是Server
"bind_addr": "192.168.199.40",//當前伺服器IP或者功能變數名稱
"client_addr": "192.168.199.40",//可以寫當前伺服器的ip,也可以寫0.0.0.0,主要區別是是否可以在本機查看UI
"ui":true,//是否開啟UI
"retry_join": ["192.168.199.203"],//重新加入的Server伺服器的IP,可為多個,直到成功
"retry_interval": "30s",//失敗重連間隔
"rejoin_after_leave": true,
"start_join":["192.168.199.203"]//第一次加入的Server伺服器的IP,可為多個,直到成功
}
```
* ##### step3
在文件夾A內部新建runconsul.bat文件,寫入內容
'''
consul agent -config-dir server.json
pause
'''
* ##### step4
運行runconsul.bat文件,出現下列內容即為開啟成功
![](WindowsClientStep4.jpg)
在server伺服器上打開瀏覽器輸入127.0.0.1:8500,可以查看Node加入新節點。
### 1.2 API註冊
* ##### step1
引入下列兩個Nuget包
```javascript
<PackageReference Include="Microsoft.AspNetCore.Http.Features" Version="2.2.0" />
<PackageReference Include="Microsoft.AspNetCore.Razor.Design" Version="2.2.0" PrivateAssets="All" />
```
* ##### step2
添加公司Nuget上的ConsulRegister引用
在Program添加下列代碼:
```javascript
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.UseKestrel()
.UseContentRoot(Directory.GetCurrentDirectory())
.UseIIS()
.UseStartup<Startup>();
```
在Startup添加下列代碼:
```javascript
public void ConfigureServices(IServiceCollection services)
{
services.AddConsul(Configuration);//註冊Consul中間件
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseHsts();
}
app.UseCors();
app.UseHttpsRedirection();
app.UseConsul();//使用Consul中間件
app.UseMvc();
}
```
* ##### step3
在appsettings.json內添加下列內容
```javascript
"Host": "http://192.168.199.40:8041",//當前API的ip或者功能變數名稱
"ServiceDiscovery": {
"ServiceName": "API_1",//註冊的API名稱,用以進行服務查找,以及負載均衡
"Consul": {
"HttpEndpoint": "http://192.168.199.40:8500"//API需要註冊的Client地址(埠未固定8500,或者可映射為8500的埠)
}
}
```
* ##### step4
運行程式然後打開server的ConsulUI即可查看註冊了該API
### 1.3 Ocelot進行服務網關搭建和服務發現
這個程式建議部署在Consul-Server伺服器上
* ##### step1
新建一個webAPI core項目
引入下列兩個Nuget包
```javascript
<PackageReference Include="Ocelot" Version="13.5.2" />
<PackageReference Include="Ocelot.Provider.Consul" Version="13.5.2" />
```
* ##### step2(重要)
此處為配置項,暫時需要手動實現
根目錄下新建ocelot.json文件,寫入內容
```javascript
{
"ReRoutes": [
{
"UseServiceDiscovery": true,
"DownstreamPathTemplate": "/{url}",//下游路由規則
"DownstreamScheme": "http",//請求協議
"ServiceName": "API_1",//對應的服務名稱
"LoadBalancerOptions": {
"Type": "RoundRobin"//負載均衡規則:輪詢
},
"UpstreamPathTemplate": "/Client1/{url}",//上游路由規則不可重覆,否則上游無法定址到正確的下游路由
"UpstreamHttpMethod": [ "Get", "Post" ],//允許的請求方法
"ReRoutesCaseSensitive": false
},
{
"UseServiceDiscovery": true,
"DownstreamPathTemplate": "/{url}",
"DownstreamScheme": "http",
"ServiceName": "API_2",
"LoadBalancerOptions": {
"Type": "RoundRobin"
},
"UpstreamPathTemplate": "/Client2/{url}",
"UpstreamHttpMethod": [ "Get", "Post" ],
"ReRoutesCaseSensitive": false
}
],
"GlobalConfiguration": {
// 使用Consul服務治理
"ServiceDiscoveryProvider": {
"Host": "192.168.199.203",//想要發現的Server服務IP
"Port": 8500,//固定埠或者可映射到該埠的映射埠
"PollingInterval": 100, //健康檢查時間間隔ms
"Type": "Consul",
"Token": null,
"ConfigurationKey": null
}
}
}
```
在Program添加下列代碼:
```javascript
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((hostingContext, config) =>
{
config
.SetBasePath(hostingContext.HostingEnvironment.ContentRootPath)
.AddJsonFile("appsettings.json", true, true)
.AddJsonFile($"appsettings.{hostingContext.HostingEnvironment.EnvironmentName}.json", true, true)
.AddJsonFile("ocelot.json")
.AddEnvironmentVariables();
})
.UseStartup<Startup>();
```
在Startup添加下列代碼:
```javascript
public void ConfigureServices(IServiceCollection services)
{
//添加Ocelot中間件
services.AddOcelot(
new ConfigurationBuilder()
.AddJsonFile("ocelot.json", optional: false, reloadOnChange: true).Build())
.AddConsul()
.AddConfigStoredInConsul();
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseHsts();
}
//添加程式健康啟動檢查
app.Map("/HealthCheck", s =>
{
s.Run(async context =>
{
await context.Response.WriteAsync("ok");
});
});
app.UseOcelot().Wait();//使用Ocelot中間件
}
```
* ##### step3
運行程式即可
### 1.3 小結
至此windows環境下的服務網關與服務發現雛形已經搭建好,
下麵是一些可能遇到的問題
####1.3.1 問題?S
#####Q:遇到伺服器積極拒絕怎麼解決?
A:檢查8500埠是否已經開放,[具體做法](https://jingyan.baidu.com/article/37bce2be40cf921002f3a229.html);如果埠以開放仍有問題,關閉防火牆。