Ocelot-基于.NET Core的开源网关实现

最新推荐文章于 2024-03-05 14:20:39 发布
最新推荐文章于 2024-03-05 14:20:39 发布
阅读量1.3k 收藏 2
点赞数

写在前面

   API网关是系统内部服务暴露在外部的一个访问入口，类似于代理服务器，就像一个公司的门卫承担着寻址、限制进入、安全检查、位置引导等工作，我们可以形象的用下图来表示： 外部设备需要访问内部系统服务时必须要通过我们的API Gateway，目的是为了隔离内部服务和外部访问来做统一的认证授权，限流熔断，请求聚合，负载均衡，日志记录，监控预警等 通用功能，就像是我们系统的防火墙一样，在任何外部请求访问系统时都必须经过防火墙的验证。

640?wx_fmt=png

更多关于网关的信息请参考前面的一篇文章《API网关模式》


Ocelot是什么？

     Ocelot是基于.NET Core实现的轻量级API网关，它包括的主要功能有：路由、请求聚合、服务发现、认证、授权、限流熔断、并内置了LoadBanalce以及集成了Service Fabric、 Consul、Eureka等功能，这些功能只都只需要简单的配置即可使用。目前腾讯财付通的API Gateway就是基于此做的实现（参考善友兄的这篇文章），下面是详细信息以及Ocelot如何在微软官方示例代码库 eShopContainers中的使用。

Ocelot在腾讯的使用：https://customers.microsoft.com/en-us/story/tencent-telecommunications-dotnetcore
微软官方示例：https://github.com/dotnet-architecture/eShopOnContainers

640?wx_fmt=png


Ocelot的实现机制

    简单的来说它是一堆的asp.net core middleware组成的pipeline，当它拿到请求之后会用一个request builder来构造一个HttpRequestMessage发到下游的真实服务器，等下游的服务 返回response之后再由一个middleware将它返回的HttpResponseMessage映射到HttpResponse上。

640?wx_fmt=gif


代码示例

我在Github上创建了示例代码库仅供参考，我们可以使用下面的步骤来创建示例代码：（示例代码）

1.创建BookingApi： dotnet new -n BookingApi
2.创建PassengerApi： dotnet new -n PassengerApi
3.创建ApiGateway： dotnet new -n ApiGateway
4.添加BookingApi和PassengerApi的实现代码
5.在ApiGateway项目中用Nuget安装Ocelot依赖包
6.添加configuration.json的配置文件
7.配置路由响应规则
8.启动服务并通过Api网关访问服务

启动BookingApi PassengerApi这两个服务，我们可以看到他们分别提供了两个接口

640?wx_fmt=png

640?wx_fmt=png

此时再启动我们的Api Gateway项目，通过Gateway来访问我们这两个API

640?wx_fmt=png

我们可以看到原本我们可以直接访问的两个API现在都可以通过Gateway来访问了，那这一切是怎么做到的呢？

当我们通过Nuget安装Ocelot的依赖之后，我们需要在项目中添加.json的配置文件，在此项目中我们配置文件命名为configuration.json，内容如下：
{
   "ReRoutes" : [
     {
       "DownstreamPathTemplate" : "/api/booking" ,
       "UpstreamPathTemplate" : "/api/getbooking" ,
       "UpstreamHttpMethod" : [ "Get"  ],
       "ReRouteIsCaseSensitive" : false ,
       "DownstreamScheme" : "http" ,
       "DownstreamHostAndPorts" : [
         {
           "Host" : "localhost" ,
           "Port" : 8001
         }
       ],
       "Key" : "booking" ,
       "RateLimitOptions" : {
         "ClientWhitelist" : [],
         "EnableRateLimiting" : true ,
         "Period" : "1s" ,
         "PeriodTimespan" : 15,
         "Limit" : 1
       }
     },
     {
       "DownstreamPathTemplate" : "/api/booking/{pnr}" ,
       "UpstreamPathTemplate" : "/api/getbooking/{pnr}" ,
       "UpstreamHttpMethod" : [ "Get"  ],
       "ReRouteIsCaseSensitive" : false ,
       "DownstreamScheme" : "http" ,
       "DownstreamHostAndPorts" : [
         {
           "Host" : "localhost" ,
           "Port" : 8001
         }
       ]
     },
     {
       "DownstreamPathTemplate" : "/api/passenger" ,
       "UpstreamPathTemplate" : "/api/getpassenger" ,
       "UpstreamHttpMethod" : [ "Get"  ],
       "ReRouteIsCaseSensitive" : false ,
       "DownstreamScheme" : "http" ,
       "DownstreamHostAndPorts" : [
         {
           "Host" : "localhost" ,
           "Port" : 8002
         }
       ],
       "Key" : "passenger"
     },
     {
       "DownstreamPathTemplate" : "/api/passenger/{id}" ,
       "UpstreamPathTemplate" : "/api/getpassenger/{id}" ,
       "UpstreamHttpMethod" : [ "Get"  ],
       "ReRouteIsCaseSensitive" : false ,
       "DownstreamScheme" : "http" ,
       "DownstreamHostAndPorts" : [
         {
           "Host" : "localhost" ,
           "Port" : 8002
         }
       ]
     }
   ],
   "GlobalConfiguration" : {
     "BaseUrl" : "https://localhost:5000"
   },
   "Aggregates" : [
     {
       "ReRouteKeys" : [
         "booking" ,
         "passenger"
       ],
       "UpstreamPathTemplate" : "/api/getbookingpassengerinfo"
     }
   ]
}

   API Gateway帮助我们做的事情是当有请求访问网关的时候，我们经过认证授权等一系列操作确保此次访问是被允许的之后便会转发到它实际需要请求服务上去，请求结束之后再由Gateway统一将结果返回给客户端，从模板中我们可以看到UpStreamPathTemplate实际上就是我们上游请求的地址，即网关公开给外部调用的地址（此服务名称和地址我们可以根据需要随便设置更多的是为了对外界隐藏我们真实的服务地址），而实际的调用地址便是DownStreamPathTemplate中给定的实际地址。为了方便大家理解此配置的含义，我查阅了官方资料，将我们上面用到的配置文件做了注解：（更齐全的参数请参考官方文档）
{
   "ReRoutes" : [ //路由是API网关最基本也是最核心的功能、ReRoutes下就是由多个路由节点组成。
     {
       "DownstreamPathTemplate" : "" , //下游服务模板
       "UpstreamPathTemplate" : "" , //上游服务模板
       "UpstreamHttpMethod" : [ "Get"  ], //上游方法类型Get,Post,Put
       "AddHeadersToRequest" : {}, //需要在转发过程中添加到Header的内容
       "FileCacheOptions" : { //可以对下游请求结果进行缓存，主要依赖于CacheManager实现
         "TtlSeconds" : 10,
         "Region" : ""
       },
       "ReRouteIsCaseSensitive" : false , //重写路由是否区分大小写
       "ServiceName" : "" , //服务名称
       "DownstreamScheme" : "http" , //下游服务schema：http, https
       "DownstreamHostAndPorts" : [ //下游服务端口号和地址
         {
           "Host" : "localhost" ,
           "Port" : 8001
         }
       ],
       "RateLimitOptions" : { //限流设置
         "ClientWhitelist" : [], //客户端白名单
         "EnableRateLimiting" : true , //是否启用限流设置
         "Period" : "1s" , //每次请求时间间隔
         "PeriodTimespan" : 15, //恢复的时间间隔
         "Limit" : 1 //请求数量
       }，
       "QoSOptions" : { //服务质量与熔断,熔断的意思是停止将请求转发到下游服务。当下游服务已经出现故障的时候再请求也是无功而返，
       并且增加下游服务器和API网关的负担，这个功能是用的Polly来实现的，我们只需要为路由做一些简单配置即可
         "ExceptionsAllowedBeforeBreaking" : 0, //允许多少个异常请求
         "DurationOfBreak" : 0, //熔断的时间，单位为秒
         "TimeoutValue" : 0 //如果下游请求的处理时间超过多少则自如将请求设置为超时
       }
     }
   ],
   "UseServiceDiscovery" : false , //是否启用服务发现
   "Aggregates" : [ //请求聚合
     {
       "ReRouteKeys" : [ //设置需要聚合的路由key
         "booking" ,
         "passenger"
       ],
       "UpstreamPathTemplate" : "/api/getbookingpassengerinfo"  //暴露给外部的聚合请求路径
     },
   "GlobalConfiguration" : { //全局配置节点
     "BaseUrl" : "https://localhost:5000"  //网关基地址
   }
}

  示例代码中我们在Aggregates节点下配置了路由聚合，它将两个请求的结果combine到一起再返回给客户端，当我们请求/api/getbookingpassengerinfo 时就会返回下面结果：

640?wx_fmt=png

需要注意的是：

  1. 聚合服务目前只支持返回json

  2. 目前只支持Get方式请求下游服务

  3. 任何下游的response header并会被丢弃

  4. 如果下游服务返回404，聚合服务只是这个key的value为空，它不会返回404

有木有觉得这里的聚合很类似于GraphQL的功能，但实际上在Ocelot中并不打算实现GraphQL的功能，因为毕竟Ocelot的主要职责是实现网关的功能，聚合只是其中的一个feature，GraphQL提供了一个库 graphql-dotnet ，我们可以用它来完成需要的功能，而在Ocelot中实现类似认证，授权等这样它擅长的事情： 
{
     "ReRoutes" : [
         {
             "DownstreamPathTemplate" : "/graphql" ,
             "DownstreamScheme" : "http" ,
             "DownstreamHostAndPorts" : [
               {
                 "Host" : "yourgraphqlhost.com" ,
                 "Port" : 80
               }
             ],
             "UpstreamPathTemplate" : "/graphql" ,
             "DelegatingHandlers" : [
                 "GraphQlDelegatingHandler"
             ]
         }
     ]
   }

官方也给出了示例：https://github.com/ThreeMammals/Ocelot/tree/develop/samples/OcelotGraphQL

此框架包含的内容比较多，在此并不一一解释，下面将谈谈其他的几个功能：

请求限流

大家注意到我们在上面例子中通过RateLimitOptions节点配置了限流的相关设置，目前我们配置的是1s钟之内只允许对booking api访问一次，否则的话便停止继续转发至下游服务，我们通过测试就会发现当在1s内多次访问的时候，网关便会返回下面的信息：

640?wx_fmt=png

负载均衡

当我们路由到的下游服务有多个结点的时候，我们可以在DownstreamHostAndPorts中进行配置负载
{
     "DownstreamPathTemplate" : "/api/posts/{postId}" ,
     "DownstreamScheme" : "https" ,
     "DownstreamHostAndPorts" : [
             {
                 "Host" : "10.127.1.10" ,
                 "Port" : 5001,
             },
             {
                 "Host" : "10.127.1.11" ,
                 "Port" : 5002,
             }
         ],
     "UpstreamPathTemplate" : "/posts/{postId}" ,
     "LoadBalancer" : "LeastConnection" ,
     "UpstreamHttpMethod" : [ "Put" , "Delete"  ]
}

LoadBalancer将决定负载均衡的算法，目前支持下面三种方式

  1. LeastConnection – 将请求发往最空闲的那个服务器

  2. RoundRobin – 轮流发送

  3. NoLoadBalance – 总是发往第一个请求或者是服务发现

Prioirty优先级

当我们配置多个请求产生冲突的时候，通过路由设置访问优化级  
{
     "UpstreamPathTemplate" : "/goods/{catchAll}"
     "Priority" : 0
}
{
     "UpstreamPathTemplate" : "/goods/delete"
     "Priority" : 1
}　　

 万能模板

如果不希望对请求做任何的处理，则可以使用下面的万能模板：(万能模板的优先级最低，只要有其它的路由模板，其它的路由模板则会优先生效)
{
     "DownstreamPathTemplate" : "/{url}" ,
     "DownstreamScheme" : "https" ,
     "DownstreamHostAndPorts" : [
             {
                 "Host" : "localhost" ,
                 "Port" : 80,
             }
         ],
     "UpstreamPathTemplate" : "/{url}" ,
     "UpstreamHttpMethod" : [ "Get"  ]
}

  本篇内容就先介绍到这里，后面将会继续探究Ocelot的内部实现。个人感觉现在.NET Core的生态越来越好，越来越多的开发人员开始尝试.NET Core并创建了很多优秀的开源项目，从微软这几年的开源策略我们更多的感受到了微软对于拥抱开源的决心，这也更加的让我们有信心在Core平台上去构建越来越多的优秀项目。如果你对技术有热情可以扫码加入我们的微信群一起探讨。

参考资料：

http://ocelot.readthedocs.io/en/latest/index.html
https://www.cnblogs.com/shanyou/p/7787183.html

Polly:
https://github.com/App-vNext/Polly

Consul:
https://github.com/hashicorp/consul

https://github.com/dotnet/home

Microsoft Blog:
https://blogs.msdn.microsoft.com/cesardelatorre/2018/05/15/designing-and-implementing-api-gateways-with-ocelot-in-a-microservices-and-container-based-architecture/

原文地址：https://www.cnblogs.com/xiandnc/p/9374533.html

 
 
.NET社区新闻，深度好文，欢迎访问公众号文章汇总 http://www.csharpkit.com 
 
 
640?wx_fmt=jpeg
 


                

        

        

    

  


    

      

        

            

              
                
                  dotNET跨平台
                
              
            

            

                关注
              
            

        

        

          
      

      









                



	

		

			

				
					
.Net Core 基于Ocelot开发企业级API网关。来自腾讯张善友分享。

				
			

			

				

					09-12
				

			

		

		

			
				
.Net Core 基于Ocelot开发企业级API网关。来自腾讯张善友分享。

			
		

	



                

              
                



	

		

			

				
					
Ocelot 开源项目使用教程

					
最新发布

				
			

			

				

					gitblog_00614的博客
				

				

					08-10
					
					281
					
				

			

		

		

			
				
Ocelot 开源项目使用教程
 Ocelot.NET API Gateway项目地址:https://gitcode.com/gh_mirrors/oc/Ocelot 1. 项目的目录结构及介绍
Ocelot 是一个基于 ASP.NET Core 的 API 网关项目，其目录结构清晰，便于理解和使用。以下是主要的目录结构及其介绍：
Ocelot/
├── src/
│   ├── Ocelot/...

			
		

	



                


  
              

                


	

		

			

				
					
.net core小网关

				
			

			

				

					chuishiyan0638的博客
				

				

					08-19
					
					279
					
				

			

		

		

			
				
最近在做一个项目, .net core C#已经开发了大部分功能 接着的功能需要让JAVA来完成 
所以需要处理URL透传,对URL地址拦截并请求JAVA编码的API 
实现方式如下: 
1、首页我们创建一个中间件对路由进行处理 
public class GateWayMiddleware
...

			
		

	





	

		

			

				
					
.NET Core API网关Ocelot(一)【概览，开始】

				
			

			

				

					极客神殿
				

				

					03-02
					
					1545
					
				

			

		

		

			
				
概览
Ocelot的目标是使用.NET运行面向微服务/面向服务的架构，需要统一的入口点进入他们的系统。
特别是与IdentityServer引用和承载令牌轻松集成。
Ocelot是一组按特定顺序排列的中间件。
Ocelot将HttpRequest对象操作到其配置指定的状态，直到它到达请求构建器中间件，在该中间件中，它创建一个HttpRequestMessage对象，该对象用于向下游服务发出请求。发...

			
		

	



		

			
		



	

		

			

				
					
(精华)2020年8月22日 微服务 Ocelot的简单使用(.net core版)

					
热门推荐

				
			

			

				

					时光隧道
				

				

					08-21
					
					49万+
					
				

			

		

		

			
				
public static void Proccess()
{
    int port = 2018;
    string host = "127.0.0.1";

    IPAddress ip = IPAddress.Parse(host);
    IPEndPoint ipe = new IPEndPoint(ip, port);

    Socket sSocket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, Pr

			
		

	





	

		

			

				
					
dotnet-NETCoreOcelotIdentityServer4Consul基础架构实现

				
			

			

				

					08-15
				

			

		

		

			
				
标题中的"dotnet-NETCoreOcelotIdentityServer4Consul基础架构实现"指的是一个基于.NET Core技术栈的微服务架构实现，其中包含了Ocelot作为API网关、IdentityServer4用于身份验证与授权，以及Consul作为服务发现和...

			
		

	





	

		

			

				
					
ocelot网关+jwt身份认证

				
			

			

				

					06-09
				

			

		

		

			
				
Ocelot是一个用C#编写的API Gateway，它是为.NET Core设计的。API网关是系统架构中的一个重要组件，它作为外部世界与内部微服务之间的单一入口点。Ocelot的主要功能包括路由、负载均衡、限流、熔断等，它可以帮助...

			
		

	





	

		

			

				
					
ASP.NET Core3.1 Ocelot路由的实现

				
			

			

				

					12-16
				

			

		

		

			
				
1.路由 前一个章节我们已经介绍过Ocelot，相信大家也了解到，Ocelot的主要功能是接收...现在我们根据GitHub贡献者开源项目来学习Ocelot，根据下载下来Ocelot基础项目结构来看，我们能看到有一个网关项目（APIGatew

			
		

	





	

		

			

				
					
.net core 使用网关Ocelot

				
			

			

				

					码农的专栏
				

				

					09-24
					
					584
					
				

			

		

		

			
				
一、新建项目OcelotDemo


Nuget: Ocelot 

修改：Program.cs


using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Micros.

			
		

	





	

		

			

				
					
Net Core Ocelot+Consul实现网关、服务注册、服务发现

				
			

			

				

					xdpcxq1029的博客
				

				

					01-17
					
					2702
					
				

			

		

		

			
				
Ocelot是一个开源的ASP.NET Core微服务网关，它提供了API网关所需的所有功能，如路由、认证、限流、监控等。Ocelot是一个简单、灵活且功能强大的API网关，它可以与现有的服务集成，并帮助您保护、监控和扩展您的微服务。路由管理：Ocelot允许您定义路由规则，将请求路由到正确的微服务。认证和授权：Ocelot支持多种认证机制，如JWT、OAuth等，并允许您定义访问控制策略，确保只有授权的用户才能访问特定的API。

			
		

	





	

		

			

				
					
.net core微服务入门之Ocelot

				
			

			

				

					弑十四的博客
				

				

					02-19
					
					502
					
				

			

		

		

			
				
继上一篇中，启动三个服务
Ocelot是什么
Ocelot是一款基于开源.NET核心的API网关，特别针对需要统一进入系统的微服务架构。它轻巧，快速，可扩展，并提供许多其他功能之间的路由和身份验证。
Ocelot是一个用.NET Core实现并且开源的API网关，它功能强大，包括了：路由、请求聚合、服务发现、认证、鉴权、限流熔断、并内置了负载均衡器与Service Fabric、Butterfly...

			
		

	





	

		

			

				
					
【.Net Core】微服务——Ocelot（1）：基础介绍及集成

				
			

			

				

					在这里你大概率会有所收获，欢迎指错||纠正||建议||水评+点赞&&评论&&关注&&转发
				

				

					05-09
					
					935
					
				

			

		

		

			
				
网关是什么
简单来说，网关就是暴露给外部的请求入口。就和门卫一样，外面的人想要进来，必须要经过门卫。当然，网关并不一定是必须的，后端服务通过http也可以很好的向客户端提供服务。但是对于业务复杂、规模庞大的项目来说，使用网关有很多无法舍弃的好处，比如可以进行统一的请求聚合来节省流量、降低耦合度，可以赋予项目熔断限流的能力提高可用性等等。
ocelot是什么
ocelot是.net core实现的开源的api网关项目，开源地址：https://github.com/ThreeMammals/Ocelot
oc

			
		

	





	

		

			

				
					
.Net Core使用Ocelot网关(一) -负载,限流,熔断,Header转换

				
			

			

				

					zhanglong_longlong的专栏
				

				

					08-31
					
					956
					
				

			

		

		

			
				
1.什么是API网关

API网关是微服务架构中的唯一入口，它提供一个单独且统一的API入口用于访问内部一个或多个API。它可以具有身份验证，监控，负载均衡，缓存，请求分片与管理，静态响应处理等。API网关方式的核心要点是，所有的客户端和消费端都通过统一的网关接入微服务，在网关层处理所有的非业务功能。通常，网关也是提供REST/HTTP的访问API。服务端通过API-GW注册和管理服务。

Ocelot介绍

Ocelot是用.net Core实现的一款开源的网关,Ocelot其实就是一组按照顺序排列的.n

			
		

	





	

		

			

				
					
.NET CORE 微服务架构--网关篇(Ocelot)

				
			

			

				

					落花流水
				

				

					12-03
					
					6242
					
				

			

		

		

			
				
Ocelot是一个用.NET Core实现并且开源的API网关，它功能强大，包括了：路由、请求聚合、服务发现、认证、鉴权、限流熔断、并内置了负载均衡器与Service Fabric、Butterfly Tracing集成。这些功能只都只需要简单的配置即可完成，下面我们会对这些功能的配置一一进行说明。

介绍

简单的来说Ocelot是一堆的asp.net coremiddleware组成的一个管道。当它拿到请求之后会用一个request builder来构造一个HttpRequestMessage发到下游.

			
		

	





	

		

			

				
					
.NET CORE微服务之Ocelot(连接Nacos)

				
			

			

				

					m0_59178355的博客
				

				

					03-05
					
					1955
					
				

			

		

		

			
				
Ocelot是一个基于.NET Core的API网关，可以用于连接Nacos作为服务发现和配置中心。通过使用Ocelot，可以实现微服务的路由、负载均衡、认证等功能，并且可以轻松地与Nacos集成，实现动态的服务发现和配置管理。

			
		

	





	

		

			

				
					
.net core学习微服务之ocelot网关

				
			

			

				

					qq_44994764的博客
				

				

					04-24
					
					569
					
				

			

		

		

			
				
一、上章使用了consul的服务发现,将我们的服务注册进consul，笔者理解此处consul就是存储服务状态的服务，当然现在是单机的consul，如果consul挂了岂不是注册进来的服务都没人管了,这里就可以用consul的集群,总之真的上一个服务实例肯定是不够的,后面都可以做集群。3.2 到此,最简单的ocelot基本使用就是这些,可以自己演示下超时、缓存、限流、熔断怎么用,这里不在赘述,基本是通过配置项来配置的。ServiceName：使用服务发现的时候,注册到consul的服务名。

			
		

	





	

		

			

				
					
ASP.NET Core OceLot 微服务实践

				
			

			

				

					weixin_30628801的博客
				

				

					08-25
					
					461
					
				

			

		

		

			
				
1、OceLot中间件介绍
　　在传统的BS应用中，随着业务需求的快速发展变化，需求不断增长，迫切需要一种更加快速高效的软件交付方式。微服务可以弥补单体应用不足，是一种更加快速高效软件架构风格。单体应用被分解成多个更小的服务，每个服务有自己的独立模块，单独部署，然后共同组成一个应用程序。把范围限定到单个独立业务模块功能。分布式部署在各台服务器上。
　　而Ocelot开发的目标就...

			
		

	





	

		

			

				
					

				
			

			

				

					
				

			

		

		

			
				

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

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

              

            

          

      

      余额充值