Ocelot

Ocelot学习
什么是网关
Ocelot简介
Ocelot工作流程
搭建Ocelot项目
- 搭建网关层
  - 1.安装 NuGet 包
  - 2.配置
- 搭建服务层
配置参数介绍
原文链接

Ocelot学习

什么是网关

网关(Gateway)又称网间连接器、协议转换器。网关在网络层以上实现网络互连，是复杂的网络互连设备，仅用于两个高层协议不同的网络互连。网关既可以用于广域网互连，也可以用于局域网互连。网关是一种充当转换重任的计算机系统或设备。使用在不同的通信协议、数据格式或语言，甚至体系结构完全不同的两种系统之间，网关是一个翻译器。与网桥只是简单地传达信息不同，网关对收到的信息要重新打包，以适应目的系统的需求。同层--应用层。

大家都知道，从一个房间走到另一个房间，必然要经过一扇门。同样，从一个网络向另一个网络发送信息，也必须经过一道“关口”，这道关口就是网关。顾名思义，网关（Gateway） [1] 就是一个网络连接到另一个网络的“关口”。也就是网络关卡。

网关(Gateway)在微服务架构中至关重要，可以将其理解为是外部客户端(前端、MVC后台等调用方)与后台服务的连接点，通过这层可以做统一的处理，比如路由、身份认证和授权、服务治理等；

网关的好处：

统一入口，调用方(客户端)不在为调哪个服务而头大，统一入口即可，由网关路由到对应后台服务；

统一处理公共逻辑，比如认证和授权，避免相同逻辑多处实现，易于维护；

对后台服务可以做负载均衡，根据指定的负载算法找到合适的后台服务调用，而这些细节调用方都不用理会，只管调就行啦；

初步过滤非法请求，可以根据配置的请求规则过滤掉非法请求；

屏蔽各服务真实地址，间接保证各服务的安全；

网关带来的问题：

在请求过程中，多增加了一层（网关）对请求进行处理，会消耗一些性能；

高并发场景，对网关性能要求高，需要开发人员要有足够的能力处理；

整体来看，在微服务架构中，网关带来的便捷和好处肯定大于自身带来的问题，所以不必纠结于此。

目前常用的网关有Kong、Tyk、Zuul、Ambassador、Ocelot等，而在.Net中比较火的是Ocelot和Kong，接下来就以Ocelot为主展开来聊聊。

Ocelot简介

Ocelot是一个基于 .net core的开源WebAPI服务网关项目，它的功能非常强大，包括了路由、请求聚合、服务发现、认证鉴权、限流、负载均衡等功能。而这些功能都可以直接通过修改json配置文件即可使用，非常方便。Ocelot是系统中对外暴露的一个请求入口，所有外部接口都必须通过这个网关才能向下游API发出请求，就如地铁中的安检系统，所有人都必须经过安检才能乘坐地铁。

Ocelot官网：http://threemammals.com/ocelot
说明文档：https://ocelot.readthedocs.io/en/latest/
Github：https://github.com/ThreeMammals/Ocelot

Ocelot工作流程

实际上Ocelot就是一系列按特定顺序排列的中间件。
Ocelot首先通过配置将HttpRequest对象保存到一个指定的状态直到它到达用来创建HttpRequestMessage对象并将创建的HttpRequestMessage对象发送到下游服务中的请求构造中间件。通过中间件来发出请求是Ocelot管道中做的最后一件事。它不会再调用下一个中间件。下游服务的响应会存储在每个请求 scoped repository中，并作为一个请求返回到Ocelot管道中。有一个中间件将HttpResponseMessage映射到HttpResponse对象并返回给客户端。
接下来是你使用Ocelot是可能会使用的配置。

基本集成

640?wx_fmt=jpeg

用一台web service来host Ocelot，在这里有一个json配置文件，里面设置了所有对当前这个网关的配置。它会接收所有的客户端请求，并路由到对应的下游服务器进行处理，再将请求结果返回。而这个上下游请求的对应关系也被称之为路由。

集成 IdentityServer

640?wx_fmt=jpeg

当我们涉及到认证和鉴权的时候，我们可以跟Identity Server进行结合。当网关需要请求认证信息的时候会与Identity Server服务器进行交互来完成。

网关集群配置

640?wx_fmt=jpeg

只有一个网关是很危险的，也就是我们通常所讲的单点，只要它挂了，所有的服务全挂。这显然无法达到高可用，所以我们也可以部署多台Ocelot网关。当然这个时候在多台网关前，你还需要一台负载均衡器。

结合Consul服务发现

640?wx_fmt=jpeg

在Ocelot已经支持简单的负载功能，也就是当下游服务存在多个结点的时候，Ocelot能够承担起负载均衡的作用。但是它不提供健康检查，服务的注册也只能通过手动在配置文件里面添加完成。这不够灵活并且在一定程度下会有风险。这个时候我们就可以用Consul来做服务发现，它能与Ocelot完美结合。

结合Service Fabric

640?wx_fmt=jpeg

搭建Ocelot项目

其API 网关实现是一个非常简单的 ASP.NET Core WebHost 项目

搭建网关层

1.安装 NuGet 包

使用 nuget 安装 Ocelot 及其依赖项。您将需要创建一个 netcoreapp3.1 项目并将包放入其中。然后按照下面的启动和配置部分启动和运行。

复制Install-Package Ocelot

2.配置

添加配置文件

在项目的根目录添加一个 .json配置文件，文件名自定义，此案例为OcelotConfiguration.json.添加配置如下：

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

可以看到在我们的配置文件中包含两个配置项

ReRoutes是一个数组，将会包含服务器的路由配置，是指示 Ocelot 如何处理上游请求的对象.
GlobalConfiguration则是一个全局配置项, 全局配置允许替代 ReRoute 特定设置。如果不想管理大量的 ReRoute 特定设置，可采用此方法。

这个配置里面最重要的是BaseUrl。Ocelot需要知道它正在运行的URL，以便执行Header查找和替换以及某些管理配置。设置此URL时，它应该是客户端将看到Ocelot运行的外部URL，例如，如果您正在运行容器，则Ocelot可能会在URL上运行http://123.12.1.1:6543但在其前面有类似nginx的响应在https：//api.yilezhu.cn。在这种情况下，Ocelot基本网址应为https://api.yilezhu.cn。

如果由于某种原因你正在使用容器并且希望Ocelot在http://123.12.1.1:6543上响应客户端的请求，那么你可以这样做但是如果要部署多个Ocelot，你可能希望在命令行中传递它某种脚本。希望您使用的任何调度程序都可以传递IP。

特别需要注意的是，这里的Ocelot.json配置文件需要在VS中右键修改为“始终复制”属性。

指定配置文件位置

将该配置文件添加到 .net core configuration中 Program.cs中：

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureAppConfiguration(ConfigurationBuilder =>
        {
            ConfigurationBuilder.AddJsonFile("OcelotConfiguration.json");
        })
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>();
        });

因为 .net core支持当配置文件被修改后会重新加载，所以如果我们需要支持重新加载，可修改为：

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

将Ocelot作为中间件注册，并注入相关服务

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    
    services.AddOcelot();//注入Ocelot服务
    
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "OcelotCodeDemo", Version = "v1" });
    });
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseDeveloperExceptionPage();
    app.UseSwagger();
    app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "OcelotCodeDemo v1"));

    app.UseOcelot(); //注册中间件

    app.UseHttpsRedirection();

    app.UseRouting();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

这里网关层基本就完工了。

搭建服务层

两个后台服务接口基本上没动，只是将ServiceAPI1的端口改为8000，ServiceAPI2的端口改为8001；为了后续配置演示，分别新增了控制器，如下图：

添加了两个

配置参数介绍

我们先来认识一下到底包含哪些参数，以及这些参数的含义。前面我们有介绍到，配置文件中包含两个配置项：ReRoutes和GlobalConfiguration。我们先来看GlobalConfiguration，它是一个全局配置项，通常我们都要在这个配置项中添加一个属性 BaseUrl，BaseUrl就是Ocelot服务对外暴露的Url。

"GlobalConfiguration": {
    "BaseUrl": "http://localhost:4727"
}

ReRoutes是一个数组，其中的每一个元素代表了一个路由，而一个路由所包含的所有可配置参数如下：

{
    "DownstreamPathTemplate": "/",
    "UpstreamPathTemplate": "/",
    "UpstreamHttpMethod": [
        "Get"
    ],
    "AddHeadersToRequest": {},
    "AddClaimsToRequest": {},
    "RouteClaimsRequirement": {},
    "AddQueriesToRequest": {},
    "RequestIdKey": "",
    "FileCacheOptions": {
        "TtlSeconds": 0,
        "Region": ""
    },
    "ReRouteIsCaseSensitive": false,
    "ServiceName": "",
    "DownstreamScheme": "http",
    "DownstreamHostAndPorts": [
        {
            "Host": "localhost",
            "Port": 8001,
        }
    ],
    "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
}