Ocelot是什么
Ocelot是一款基于开源.NET核心的API网关,特别针对需要统一进入系统的微服务架构。它轻巧,快速,可扩展,并提供许多其他功能之间的路由和身份验证。
Ocelot是一个用.NET Core实现并且开源的API网关,它功能强大,包括了:路由、请求聚合、服务发现、认证、鉴权、限流熔断、并内置了负载均衡器与Service Fabric、Butterfly Tracing集成。
API网关
- API网关是一个服务器,是系统的唯一入口。从面向对象设计的角度看,它与外观模式类似。API网关封装了系统内部架构,为每个客户端提供一个定制的API。它可能还具有其它职责,如身份验证、监控、负载均衡、缓存、请求分片与管理、静态响应处理。
- API网关方式的核心要点是,所有的客户端和消费端都通过统一的网关接入微服务,在网关层处理所有的非业务功能。通常,网关也是提供REST/HTTP的访问API。服务端通过API-GW注册和管理服务。
- API 网关一般放到微服务的最前端,并且要让API网关变成由应用所发起的每个请求的入口。这样就可以明显的简化客户端实现和微服务应用程序之间的沟通方式。以前的话,客户端不得不去请求微服务A(假设为Customers),然后再到微服务B(假设为Orders),然后是微服务C(假设为Invoices)。客户端需要去知道怎么去一起来消费这三个不同的service。使用API网关,我们可以抽象所有这些复杂性,并创建客户端们可以使用的优化后的端点,并向那些模块们发出请求。API网关的核心要点是:所有的客户端和消费端都通过统一的网关接入微服务,在网关层处理所有的非业务功能(比如验证、鉴权、监控等等)。
创建Ocelot项目
- 创建.net core 3.1 api项目
- 添加配置文件ocelot.json
{
// 转发路由,数组中的每个元素都是某个服务的一组路由转发规则
"ReRoutes": [
{
"ServiceName": "MicrServiceDemo",
// Uri方案,http、https
"DownstreamScheme": "http",
// 下游(服务提供方)服务路由模板
"DownstreamPathTemplate": "/{path}",
// 上游(客户端,服务消费方)请求路由模板
"UpstreamPathTemplate": "/api/{path}",
"UpstreamHttpMethod": [ "Get", "Post" ],
"LoadBalancerOptions": {
"Type": "RoundRobin" //轮询
},
"UseServiceDiscovery": true
}
],
// 全局配置,此节点的配置会覆盖ReRoutes,可以在这里设置一些通用的配置
"GlobalConfiguration": {
"ReRouteIsCaseSensitive": false,
"ServiceDiscoveryProvider": {
"Host": "localhost",
"Port": 8500,
"Type": "Consul" //由Consul提供服务发现
}
}
}
- Nuget添加Ocelot和Ocelot.Provider.Consul的引用
- 配置服务ConfigureServices添加Ocelot配置
public void ConfigureServices(IServiceCollection services)
{
var config = new ConfigurationBuilder().AddJsonFile("Ocelot.json").Build();
services.AddOcelot(config).AddConsul();
}
- 配置添加Ocelot
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseOcelot().Wait();
}
- 启动项目,根据规则,访问/api/weather,则会轮询访问的注册服务中,如下图所示
想了解更多Ocelot及配置,可前往以下博客了解
.NET Core开源API网关 – Ocelot中文文档