windows环境下如何搭建Consul+Ocelot

时间：2024-01-01 22:35:45

下面的是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)；如果端口以开放仍有问题，关闭防火墙。

相关文章