微服务-网关GateWay，使用Ocelot服务治理(2)

在微服务中网关必不可缺。网关包含了路由，认证，服务发现，日志记录等等。

本文通过使用Ocelot创建微服务网关。Ocelot是一个开源的API网关，功能强大，包括路由，负载均衡，请求聚合，认证，鉴权，限流熔断等等，通过配置即可完成。

在上文微服务-基于Consul的服务注册与发现(1) 中通过Consul实现了服务注册与发现，健康检查，负载均衡功能。

Ocelot能够集成Consul，组合搭配使用使得项目更加健全。

 

Ocelot官网：https://ocelot.readthedocs.io/en/latest/introduction/gettingstarted.html

 

大致操作如下：

(1)创建空的WebAPI项目MicService.GateWayDemo

引入Nuget包Ocelot和Ocelot.Provider.Consul

 

(2)配置

需要添加一个json文件来添加Ocelot配置，我们新建文件Configuration.json

最简单的配置如下：

BaseUrl是我们外部暴露的Url

{
    "ReRoutes": [],
    "GlobalConfiguration": {
        "BaseUrl": "https://api.mybusiness.com"
    }
}

其中必不可少的是这两个根节点：ReRoutes和GlobalConfiguration。ReRoutes是一个数组，每个元素代表一个路由，下面是完整的路由配置和说明：

{
  "DownstreamPathTemplate": "/",
  "UpstreamPathTemplate": "/",
  "UpstreamHttpMethod": [
      "Get"
  ],
  "AddHeadersToRequest": {},
  "AddClaimsToRequest": {},
  "RouteClaimsRequirement": {},
  "AddQueriesToRequest": {},
  "RequestIdKey": "",
  "FileCacheOptions": {
      "TtlSeconds": 0,
      "Region": ""
  },
  "ReRouteIsCaseSensitive": false,
  "ServiceName": "",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
      {
          "Host": "localhost",
          "Port": 51876,
      }
  ],
  "QoSOptions": {
      "ExceptionsAllowedBeforeBreaking": 0,
      "DurationOfBreak": 0,
      "TimeoutValue": 0
  },
  "LoadBalancer": "",
  "RateLimitOptions": {
      "ClientWhitelist": [],
      "EnableRateLimiting": false,
      "Period": "",
      "PeriodTimespan": 0,
      "Limit": 0
  },
  "AuthenticationOptions": {
      "AuthenticationProviderKey": "",
      "AllowedScopes": []
  },
  "HttpHandlerOptions": {
      "AllowAutoRedirect": true,
      "UseCookieContainer": true,
      "UseTracing": true
  },
  "UseServiceDiscovery": false
}

Downstream是下游服务配置

UpStream是上游服务配置

Aggregates 服务聚合配置

ServiceName, LoadBalancer, UseServiceDiscovery 配置服务发现

AuthenticationOptions 配置服务认证

RouteClaimsRequirement 配置Claims鉴权

RateLimitOptions为限流配置

FileCacheOptions 缓存配置

QosOptions 服务质量与熔断

DownstreamHeaderTransform头信息转发

 

Configuration.json文件

{
  "ReRoutes": [
    { 
      "DownstreamPathTemplate": "/{url}", //下游请求地址模板
      "DownstreamScheme": "http", //请求协议 
      "UpstreamPathTemplate": "/{url}",
      "UpstreamHttpMethod": [ "Get", "Post" ],
      //负载均衡 最少连接数
      "LoadBalancerOptions": {
        "Type": "LeastConnection"
      },
      "ServiceName": "MicServiceName", //Consul配置中服务的name名字
      "UseServiceDiscovery": true //是否启用服务发现
    }
  ],
  "GlobalConfiguration": {
    //Consul服务发现的地址和端口
    "ServiceDiscoveryProvider": {
      "Host": "localhost",
      "Port": 8500
    },
    "BaseUrl": "http://192.168.1.1:5000"
  }
}

(3)修改Program.cs

public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
 .ConfigureAppConfiguration(conf =>
 4  {
 5      conf.AddJsonFile("configuration.json", optional: false, reloadOnChange: true);
 6  })
.ConfigureWebHostDefaults(webBuilder =>
{
    webBuilder.UseStartup<Startup>();
});

(4)修改Startup.cs

 public void ConfigureServices(IServiceCollection services)
{
    services.AddOcelot().AddConsul();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseOcelot();//整个进程的管道换成Ocelot
}

(5).运行测试

在上期基础上运行和测试，可以详见：微服务-基于Consul的服务注册与发现(1)

开启Consul,在安装包文件夹下，输入命令行 consul.exe agent -dev

 

在项目MicService文件夹下的bin/Debug/netcoreapp3.1中输入命令行如下所示，运行微服务：

dotnet MicService.dll --urls="http://*:7003" --ip="127.0.0.1" --port=7003 --weight=1 --text="7003"

dotnet MicService.dll --urls="http://*:7002" --ip="127.0.0.1" --port=7002 --weight=1 --text="7002"

 

运行MicService.GateWayDemo，其中端口号可在LaunchSettings.json中设置

通过Postman访问58961端口，会自动映射到7002或7003端口下的接口

http://localhost:58961/WeatherForecast

 

结果如下：

模板规则和配置具体可见官网：

https://ocelot.readthedocs.io/en/latest/features/servicediscovery.html

 

参考文档：

https://www.cnblogs.com/jesse2013/p/net-core-apigateway-ocelot-docs.html

https://www.cnblogs.com/bob-zb/p/11635893.html

 

以上，仅用于学习和总结！