Ocelot API网关入门指南：从零开始构建.NET微服务网关

舒璇辛Bertina

于 2025-06-05 09:02:03 发布

阅读量390

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00230/article/details/148440342

Ocelot API网关入门指南：从零开始构建.NET微服务网关

Ocelot .NET API Gateway 项目地址: https://gitcode.com/gh_mirrors/oc/Ocelot

什么是Ocelot

Ocelot是一个基于.NET平台的开源API网关，专为微服务架构设计。它充当客户端与后端服务之间的中间层，可以处理请求路由、负载均衡、认证授权等常见网关功能。Ocelot与ASP.NET Core深度集成，支持.NET 8 LTS和.NET 9 STS版本。

环境准备

在开始使用Ocelot前，你需要确保开发环境满足以下要求：

安装.NET 8或.NET 9 SDK
准备一个ASP.NET Core空项目（使用"ASP.NET Core Empty"模板）
推荐使用Visual Studio 2022或VS Code作为开发工具

安装Ocelot

在项目中安装Ocelot非常简单，只需通过NuGet包管理器执行以下命令：

Install-Package Ocelot

这个命令会自动安装Ocelot及其所有依赖项。安装完成后，你就可以开始配置Ocelot了。

基础配置

Ocelot的核心配置通过一个名为ocelot.json的文件完成。下面是一个最基本的配置示例：

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

这个配置虽然不会实际路由任何请求，但能让Ocelot正常启动。其中：

Routes：定义请求路由规则（必需）
GlobalConfiguration：全局配置（必需）
BaseUrl：指定Ocelot运行的外部URL

实际路由配置示例

下面是一个实际可用的路由配置示例：

{
  "Routes": [
    {
      "UpstreamHttpMethod": ["Get"],
      "UpstreamPathTemplate": "/ocelot/posts/{id}",
      "DownstreamPathTemplate": "/todos/{id}",
      "DownstreamScheme": "https",
      "DownstreamHostAndPorts": [
        { "Host": "jsonplaceholder.typicode.com", "Port": 443 }
      ]
    }
  ],
  "GlobalConfiguration": {
    "BaseUrl": "https://api.mybusiness.com"
  }
}

这个配置会将所有发送到/ocelot/posts/{id}的GET请求转发到https://jsonplaceholder.typicode.com/todos/{id}。

程序配置

在ASP.NET Core项目中，你需要在Program.cs文件中添加Ocelot的配置：

using Ocelot.DependencyInjection;
using Ocelot.Middleware;

var builder = WebApplication.CreateBuilder(args);

// Ocelot基础配置
builder.Configuration
    .SetBasePath(builder.Environment.ContentRootPath)
    .AddOcelot(); // 加载ocelot.json配置文件
builder.Services
    .AddOcelot(builder.Configuration); // 添加Ocelot服务

// 添加其他功能（如开发环境日志）
if (builder.Environment.IsDevelopment())
{
    builder.Logging.AddConsole();
}

// 构建应用并添加中间件
var app = builder.Build();
await app.UseOcelot(); // 使用Ocelot中间件
await app.RunAsync();

关键点说明：