.Net微服务实践（三）[网关]：Ocelot配置路由和请求聚合

最新推荐文章于 2024-08-26 09:14:37 发布
最新推荐文章于 2024-08-26 09:14:37 发布
阅读量1k 收藏 2
点赞数
分类专栏： C# 微服务
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qdwyj/article/details/119669214
版权
本文深入介绍了Ocelot的配置，包括路由的基本配置、占位符、万能模板、优先级和查询参数。此外，还详细讲解了请求聚合的默认聚合与自定义聚合，并通过示例演示了配置与功能验证。通过阅读，读者将掌握如何利用Ocelot实现服务路由与请求聚合。
摘要由CSDN通过智能技术生成

目录

在上篇.Net微服务实践（二）：Ocelot介绍和快速开始中我们介绍了Ocelot，创建了一个Ocelot Hello World程序，接下来，我们会介绍Oclot的主要特性路由和另外一个特性请求聚合。这些特性都是通过配置来实现的。

配置

{
    "ReRoutes": [],
    "GlobalConfiguration": {}
}

Ocelot的配置文件包含两个节点: ReRoutes和GlobalConfiguration

  • ReRoutes - 告诉Ocelot如何处理上游的请求
  • GlobalConfiguration - 全局配置，此节点的配置允许覆盖ReRoutes里面的配置，你可以在这里进行通用的一些配置信息

Ocelot的完整配置项如下

{
          "DownstreamPathTemplate": "/",
          "UpstreamPathTemplate": "/",
          "UpstreamHttpMethod": [
              "Get"
          ],
          "DownstreamHttpMethod": "",
          "DownstreamHttpVersion": "",
          "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,
              "MaxConnectionsPerServer": 100
          },
          "DangerousAcceptAnyServerCertificateValidator": false
      }

完整配置项中的每一项具体含义和作用接下来会一一介绍，大的配置项的主要含义如下:

  • Downstream - 下游服务配置
  • UpStream - 上游服务配置
  • Aggregates - 服务聚合配置
  • ServiceName, LoadBalancer, UseServiceDiscovery - 配置服务发现
  • AuthenticationOptions - 配置服务认证
  • RouteClaimsRequirement - 配置Claims鉴权
  • RateLimitOptions - 限流配置
  • FileCacheOptions - 缓存配置
  • QosOptions - 服务质量与熔断
  • DownstreamHeaderTransform - 头信息转发

路由

基本配置

在上一篇的hello world程序中使用的就是基本配置

{
  "ReRoutes": [
    {
      "DownstreamPathTemplate": "/api/orders",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 5001
        }
      ],
      "UpstreamPathTemplate": "/api/orders",
      "UpstreamHttpMethod": [ "Get" ]
    }
  ],
  "GlobalConfiguration": {
    "BaseUrl": "http://localhost:5000"
  }
}
  • BaseUrl - Ocelot的服务运行地址，要特别注意一下BaseUrl是我们外部暴露的Url，比如我们的Ocelot运行在http://localhost:5000，但是前面有一个 nginx绑定了域名http://api.demo.com，那这里我们的BaseUrl就是 http://api.demo.com
  • UpstreamPathTemplate、UpstreamHttpMethod - 配置上游服务器请求URL
  • DownstreamPathTemplate、DownstreamScheme、DownstreamHostAndPorts - 配置下游服务器请求URL

在基本配置的示例中：要实现的功能就是将 http://localhost:5000/api/orders GET 请求路由到 http://localhost:5001/api/orders GET

占位符

在Ocelot中，可以以{something}的形式将变量的占位符添加到模板中。占位符变量需要同时出现在DownstreamPathTemplate和UpstreamPathTemplate属性中。请求时Ocelot将尝试请求时进行替换

{
      "DownstreamPathTemplate": "/api/{everything}",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 5002
        }
      ],
      "UpstreamPathTemplate": "/api/{everything}",
      "UpstreamHttpMethod": [ "Get" ]
}

示例说明：所有http://localhost:5000/api/XXXXXX的请求都会路由到http://localhost:5002/api/XXXXXX

例如http://localhost:5000/api/products 路由到 http://localhost:5002/api/products

例如http://localhost:5000/api/products/1 路由到 http://localhost:5002/api/products/1

验证

修改配置，运行示例程序， 访问http://localhost:5000/api/products，返回了产品数据

注意：在添加Ocelot.json文件时 .AddJsonFile("Ocelot.json",false,true)， 第三个参数是指定文件发生变化时，是否重新加载，示例程序中是true. 所以我们只要修改运行目录下的配置文件，不用重新运行示例程序。

万能模板

既然占位符可以做通用匹配，自然而然就有一种配置可以匹配所有请求

{
      "DownstreamPathTemplate": "/{url}",
      "DownstreamScheme": "http",
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 5002
        }
      ],
      "UpstreamPathTemplate": "/{url}",
      "UpstreamHttpMethod": [ "Get" ]
}

示例说明： 转发所有的请求到http://localhost:5002

验证

修改配置，运行示例程序， 访问http://localhost:5000/api/products，返回了产品数据

优先级

如果一个上游请求有多个路由配置都能匹配，到底该使用哪个路由呢？ 路由可以配置优先级(Priority)， 0最小，路由会使用优先级高的（说明：如果多个匹配路由优先级一样，则按顺序使用第一个）

  • 在product-api中添加一个category api
[ApiController]
public class CategoryController : ControllerBase
{
    // GET: api/Product
    [Route("api/categories")]
    [HttpGet]
    public IEnumerable<string> Get()
    {
        return new string[] { "电子产品", "医护用品" };
    }
}
  • 修改Ocelot.json配置文件如下
{
  "DownstreamPathTemplate": "/api/products",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "localhost",
      "Port": 5002
    }
  ],
  "UpstreamPathTemplate": "/api/products",
  "UpstreamHttpMethod": [ "Get" ],
  "Priority": 0
},
{
  "DownstreamPathTemplate": "/api/categories",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "localhost",
      "Port": 5002
    }
  ],
  "UpstreamPathTemplate": "/api/{everything}",
  "UpstreamHttpMethod": [ "Get" ],
  "Priority": 1
}

如果这时访问http://localhost:5000/api/products, 大家猜一下，是返回产品数据还是类别数据？

验证

修改配置，运行示例程序， 访问http://localhost:5000/api/products，返回了类别数据, 因为类别路由的优先级是1， 优先级更高

查询参数

  • 在order-api中添加一个订单明细的api\
[Route("api/orders/{id}")]
[HttpGet]
public string Get(int id)
{
    string order = string.Empty;
    switch(id)
    {
        case 1:
            order = "刘明的订单";
            break;
        case 2:
            order = "王天的订单";
            break;
        default:
            order = "没有找到订单";
            break;
    }
    return order;

}
  • 修改Ocelot.json配置如下
{
  "DownstreamPathTemplate": "/api/orders/{id}",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "localhost",
      "Port": 5001
    }
  ],
  "UpstreamPathTemplate": "/api/orders?id={id}",
  "UpstreamHttpMethod": [ "Get" ]
}

我们期望的结果是，当访问http://localhost:5000/api/orders?id=1 (下游服务实际没这个接口)时 路由到http://localhost:5001/api/orders/1返回订单明细

验证

修改配置，运行示例程序， 访问http://localhost:5000/api/orders?id=1，返回了订单明细数据

请求聚合

有一种场景，前端一个页面，调用了多个API，要同时开多个连接几次调用才能全部所需要的数据，为了减少不必要的请求和开销，Ocelot也支持请求聚合

默认聚合

  • 修改配置文件，在ReRoutes 添加如下配置
{
  "DownstreamPathTemplate": "/api/orders",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "localhost",
      "Port": 5001
    }
  ],
  "UpstreamPathTemplate": "/api/orders",
  "UpstreamHttpMethod": [ "Get" ],
  "Key": "Orders"
},
{
  "DownstreamPathTemplate": "/api/products",
  "DownstreamScheme": "http",
  "DownstreamHostAndPorts": [
    {
      "Host": "localhost",
      "Port": 5002
    }
  ],
  "UpstreamPathTemplate": "/api/products",
  "UpstreamHttpMethod": [ "Get" ],
  "Priority": 0,
  "Key": "Products"
}

大家注意一下，这和之前的配置有什么区别？ 区别就是再每一个路由配置下多了一个 Key, Key的值可以任意定义（但建议还是按业务含义定义）

  • 在Ocelot.json中添加如下配置
"Aggregates": [
    {
      "ReRouteKeys": [
        "Orders",
        "Products"
      ],
      "UpstreamPathTemplate": "/api/aggregates"
    }
  ]

注意Aggregates配置是和在ReRoutes配置平级的

{
    "ReRoutes": [],
    "Aggregates": [],
    "GlobalConfiguration": {}
}

示例说明： 当访问http://localhost:5000/api/aggregates， 会同时返回订单数据和产品数据

运行示例进行验证

既然是多个请求聚合，那么问题来了：

  • 如果其中一个服务宕机，会怎么样？

    我们停止订单服务，再次当访问http://localhost:5000/api/aggregates, 结果返回500
  • 如果其中一个服务不是宕机，而是返回500，会怎么样？

    我们修改order-api代码，在其中抛出异常
// GET: api/Product
[Route("api/orders")]
[HttpGet]
public  IEnumerable<string> Get()
{
    throw new Exception("获取所有订单出错");
}

再次运行示例，访问http://localhost:5000/api/aggregates，Response是200, 但是body中Products节点是正常的产品数据，Orders节点里面的数据是异常信息

自定义聚合

如果默认的聚合返回的结果数据结构不是我们想要的，想要修改怎么办？答案是使用自定义聚合

  • 在ocelot-gateway中, 添加一个自动以聚合器FakeDefinedAggregator, 必须实现IDefinedAggregator接口。这个聚合器的功能很简单，就是将两个聚合请求的结果，用逗号拼接起来返回
public class FakeDefinedAggregator : IDefinedAggregator
{
    public FakeDefinedAggregator(FakeDepdendency dep)
    {
    }

    public async Task<DownstreamResponse> Aggregate(List<DownstreamContext> responses)
    {
        var one = await responses[0].DownstreamResponse.Content.ReadAsStringAsync();
        var two = await responses[1].DownstreamResponse.Content.ReadAsStringAsync();

        var merge = $"{one}, {two}";
        var headers = responses.SelectMany(x => x.DownstreamResponse.Headers).ToList();
        return new DownstreamResponse(new StringContent(merge), HttpStatusCode.OK, headers, "some reason");
    }
}
  • 注入自定义聚合器
services.AddOcelot()
        .AddSingletonDefinedAggregator<FakeDefinedAggregator>();
  • 在Ocelot.json中修改配置，指定自定义聚合器
"Aggregates": [
    {
      "ReRouteKeys": [
        "Orders",
        "Products"
      ],
      "UpstreamPathTemplate": "/api/aggregates",
      "Aggregator": "FakeDefinedAggregator"
    }
  ],

与之前的配置相比，多了如下的配置，就是指定自定义聚合器的

"Aggregator": "FakeDefinedAggregator"

验证

修改配置，运行示例程序， 访问http://localhost:5000/api/aggregate, 验证返回结果

最后

本篇我们介绍了Ocelot配置，只要特性路由，以及请求聚合。接下里我们会介绍Ocelot的其他特性：限流熔断、负载均衡 .Net微服务实践（四）[网关]：Ocelot限流熔断、缓存以及负载均衡

示例代码下载地址： https://github.com/lcyhjx/ocelot-demo/tree/master

使用Swagger.NET配置Ocelot微服务
python_git301的博客
09-13 155
本文介绍了如何使用Swagger.NET配置Ocelot微服务，并生成API文档。通过结合Swagger.NET和Ocelot，我们可以轻松地为我们的微服务架构生成详细的API文档，并使用Swagger UI来浏览和测试这些API。在本文中，我们将探讨如何使用Swagger.NET来配置Ocelot微服务并生成API文档。在Ocelot微服务中使用Swagger.NET，我们需要配置Swagger生成器。一旦我们配置好了Swagger和Ocelot，我们可以生成API文档。启动Ocelot微服务后，访问。
【愚公系列】2022年07月 .NET架构班 085-微服务专题 Abp vNext微服务网关
时光隧道
07-31 8720
API网关方式的核心要点是，所有的客户端和消费端都通过统一的网关接入微服务，在网关层处理所有的非业务功能，通常网关也是提供REST/HTTP的访问API。要特别注意一下BaseUrl是我们外部暴露的Url，比如我们的Ocelot运行在http//150.150.1.1的一个地址上，但是前面有一个nginx绑定了域名http//api.like.cn，那这里我们的BaseUrl就是http//api.like.cn。这个功能是用的Pollly来实现的，我们只需要为路由做一些简单配置即可。......
Ocelot中文文档-请求聚合
weixin_30491641的博客
01-09 335
Ocelot中文文档-请求聚合 原文:Ocelot中文文档-请求聚合Ocelot允许您指定聚合多个普通ReRoutes的Aggregate ReRoutes（聚合路由），并将其响应映射到一个对象中。一般用于当您有一个客户端向服务器发出多个请求，而这些请求可以合并成一个的时候。此功能允许您通过Ocelot实现前端类型结构的后端。 此功能是问题 ...
探索Ocelot：.NET的强大API网关解决方案
最新发布
gitblog_01004的博客
08-26 367
探索Ocelot：.NET的强大API网关解决方案 项目地址:https://gitcode.com/gh_mirrors/oce/Ocelot 项目介绍 Ocelot是一个专为使用.NET运行微服务或服务导向架构（SOA）的开发者设计的API网关。它提供了一个统一的入口点，不仅适用于.NET环境，还能与任何支持HTTP(S)的平台兼容。Ocelot的核心目标是简化与IdentityServer和...
Asp.Net Core + Ocelot 网关搭建：路由简单配置
weixin_30235225的博客
10-19 239
前言   Ocelot是一个基于中间件的网关实现，功能有很多。从浅入深简单学习并记录一下吧。本篇就是一个简单的路由配置实现。 DEMO 搭建   首先建立三个项目。Api.User,Api.Article,Api.GateWay.ApiGateWay项目中引入Ocelot Nuget包.添加配置文件Ocelot.json. { "ReRoutes": [ { "Downst...
ocelot-配置AllowAutoRedirect
码农的专栏
03-07 372
通过网关访问地址：http://somedomain.com:81/Home/Re（跳转到百度） AllowAutoRedirect=True 运行效果：浏览器地址不会跳转到百度 AllowAutoRedirect=False 运行效果：浏览器地址跳转到百度
基于.NET平台的Ocelot网关框架教程汇总
weixin_33913377的博客
08-17 175
Ocelot 框架是基于.NET 开发的 API 网关，API网关是系统内部服务暴露在外部的一个访问入口，类似于代理服务器，就像一个公司的门卫承担着寻址、限制进入、安全检查、位置引导等工作，我们可以形象的用下图来表示： 外部设备需要访问内部系统服务时必须要通过我们的 PI Gateway，目的是为了隔离内部服务和外部访问来做统一的认证授权，限流熔断，请求聚合，负载均衡，日志记录，监控预警等 通用功...
.NET CORE微服务之Ocelot(连接Nacos)
m0_59178355的博客
03-05 2037
Ocelot是一个基于.NET Core的API网关，可以用于连接Nacos作为服务发现和配置中心。通过使用Ocelot，可以实现微服务的路由、负载均衡、认证等功能，并且可以轻松地与Nacos集成，实现动态的服务发现和配置管理。
.Net 微服务实现Demo代码
04-18
在.NET框架中，微服务是一种架构风格，它提倡将单体应用分解为一组小型、独立的服务，每个服务都运行在其自己的进程中，...通过学习和实践，开发者可以更好地掌握如何在.NET环境中构建可扩展、可维护的微服务应用程序。
ocelot和nginx比较_Ocelot一个优秀的.NET API网关框架
weixin_34910465的博客
01-17 1809
1 什么是Ocelot？Ocelot是一个用.NET Core实现并且开源的API网关，它功能强大，包括了：路由、请求聚合、服务发现、认证、鉴权、限流熔断、并内置了负载均衡器与Service Fabric、Butterfly Tracing集成。2 如何使用Ocelot？首先，创建2个WebApi项目，WebApi01和WebApi02，地址分别https://localhost:44313和ht...
深入解析.NET Core微服务架构与服务治理
网关是微服务架构中的另一个关键组件，它作为服务请求的入口点，提供了请求路由、负载均衡、协议转换、权限验证和限流等重要功能。API网关是微服务架构中常用的网关类型，负责聚合后端多个微服务提供的接口，并对外...
ocelot配置
dibeichan3033的博客
03-19 243
动态配置 { "ReRoutes": [], "Aggregates": [], "GlobalConfiguration": { "ServiceDiscoveryProvider": { "Host": "198.13.32.202", "Port": 8500 }, "DownstreamScheme...
.net 配置网关（使用Ocelot）
m0_47659279的博客
12-21 3446
本文演示一个最简单的demo，来模拟如何通过网关来访问服务，而不是直接访问服务 创建三个asp.net core web api项目，一个作为网关，两个作为服务 分别配置项目的访问路径 网关的项目使用https://localhost:5001 第一个服务的项目我这里使用 https://localhost:6001 第二个服务的项目我这里使用 https://localhost:7001 至此，服务端就已经完成了（没错，只要改个路径就好了，其他的代码全靠自动生成，因为懒得改） OK，现在来配置网关，网关
Ocelot（二）- 请求聚合与负载均衡
weixin_34150503的博客
05-15 274
Ocelot（二）- 请求聚合与负载均衡 作者：markjiang7m2 原文地址：https://www.cnblogs.com/markjiang7m2/p/10865511.html 源码地址：https://gitee.com/Sevenm2/OcelotDemo 在上一篇Ocelot的文章中，我已经给大家介绍了何为Ocelot以及如何简单使用它的路由功能，如果你还没有不了解Ocelo...
Ocelot 网关搭建（一）
努力努力再努力Joanna
04-24 973
一：环境配置 依赖项目：.Net Core 2.0 空项目 下载NuGet包：Install-PackageOcelot 二：相关代码与其他配置 添加应用设置文件：Ocelot.json { "ReRoutes": [ { "DownstreamPathTemplate": "/api/{url}", "DownstreamScheme": "ht...
Ocelot简易教程（四）之请求聚合以及服务发现
weixin_57218581的博客
04-14 255
上篇文章给大家讲解了Ocelot的一些特性并对路由进行了详细的介绍，今天呢就大家一起来学习下Ocelot的请求聚合以及服务发现功能。希望能对大家有所帮助。请求聚合 Ocelot允许你声明聚合路由，这样你可以把多个正常的ReRoutes打包并映射到一个对象来对客户端的请求进行响应。比如，你请求订单信息，订单中又包含商品信息，这里就设计到两个微服务，一个是商品服务，一个是订单服务。如果不运用聚合路由的话，对于一个订单信息，客户端可能需要请求两次服务端。实际上这会造成服务端额外的开销。这时候有了聚合路由后，你只需
ocelot 配置文件 意思
weixin_33897722的博客
05-22 279
{ "ReRoutes": [ { // /*官方文档ReRoutes全节点示例*/ // Upstream表示上游请求，即客户端请求到API Gateway的请求 "UpstreamPathTemplate": "/", //请求路径模板 "UpstreamHttpMethod": [ //请求方法数组 "Get" ], ...
Ocelot 配置学习笔记
weixin_30436891的博客
06-15 200
Ocelot是一个用.NET Core实现并且开源的API网关，它功能强大，包括了：路由、请求聚合、服务发现、认证、鉴权、限流熔断、并内置了负载均衡器与Service Fabric、Butterfly Tracing集成。这些功能只都只需要简单的配置即可完成，下面我们会对这些功能的配置一一进行说明。 在asp.net core 2.0里通过nuget即可完成集成，或者命令行d...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值