Ocelot .NET（开发人员如何使用）

Ocelot API 网关 是一个.NET 库，用于实现 API 网关中常用的 API 网关模式，以处理跨多个微服务的请求。它充当轻量级 API 网关，将请求从客户端路由到下游服务。本文将深入探讨 Ocelot API 网关是如何位于客户端和下游服务之间的，包括其安装、配置、主要功能以及演示其功能的实际示例。我们还将探讨 IronPDF 和 Ocelot API 相结合。

什么是 Ocelot .NET？

Ocelot 是面向 .NET 应用程序的开源 API 网关解决方案，旨在促进多个微服务之间的请求路由。它充当反向代理，管理来自客户端的 HTTP 请求，并将其路由到 ASP.NET Core 环境中的相应服务。Ocelot 基于 ASP.NET Core 开发，可与 .NET 生态系统无缝集成，提供对现代应用程序至关重要的一系列强大功能。

Ocelot 的主要功能

路由

路由功能是 Ocelot 功能的核心。它能根据开发人员指定的配置，将传入请求匹配到适当的服务路由，并能与服务发现机制集成。其中包括对通配符路由的支持，这在处理不同的应用程序接口版本或众多服务端点时特别有用。

中间件/委托处理程序

Ocelot 允许开发人员注入自定义的中间件或处理程序，以便在请求和响应到达客户端或服务之前对其进行处理。这对于添加标头、记录请求，甚至根据需要修改响应结构都非常有用。

负载平衡

Ocelot 支持各种开箱即用的负载平衡策略，如循环负载平衡、最小连接负载平衡，以及在预定义策略均不符合要求时支持自定义提供商。该功能可确保负载在可用服务之间均匀分布，从而提高应用程序的整体弹性和效率。

验证和授权

确保应用程序接口端点的安全至关重要，Ocelot支持与现有的身份验证提供商（如身份服务器）集成。它支持流行的认证方案，包括 JWT 和 OAuth2，并允许对用户访问服务进行细粒度控制。

速率限制和服务质量

速率限制是防止滥用和确保公平使用服务的关键，它限制用户在一定时间内可提出的请求数量。服务质量 (服务质量) 设置超时和重试等选项可确保服务在各种网络条件和负载下保持可用和响应。

在 .NET 项目中设置 Ocelot

要将 Ocelot 集成到项目中，您需要通过 NuGet 安装 Ocelot 软件包，并在程序类中对其进行配置：

Install-Package IronPdf

在 Startup.cs 或 Program 类中配置服务，包括请求生成器中间件，以设置服务容器：

public void ConfigureServices(IServiceCollection services)
{
    services.AddOcelot();
}
public async void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Optionally handle ASP.NET Core environment settings
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    // Start Ocelot
    await app.UseOcelot();
}

public void ConfigureServices(IServiceCollection services)
{
    services.AddOcelot();
}
public async void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Optionally handle ASP.NET Core environment settings
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    // Start Ocelot
    await app.UseOcelot();
}

Public Sub ConfigureServices(ByVal services As IServiceCollection)
	services.AddOcelot()
End Sub
Public Async Sub Configure(ByVal app As IApplicationBuilder, ByVal env As IWebHostEnvironment)
	' Optionally handle ASP.NET Core environment settings
	If env.IsDevelopment() Then
		app.UseDeveloperExceptionPage()
	End If
	' Start Ocelot
	Await app.UseOcelot()
End Sub

在 Ocelot 中配置路由

Ocelot 使用配置文件（通常为 ocelot.json）来定义路由规则。下面是一个更复杂的示例，演示了多种路由配置：

{
    "ReRoutes": [
        {
            "DownstreamPathTemplate": "/api/users/{id}",
            "DownstreamScheme": "https",
            "DownstreamHostAndPorts": [
                {
                    "Host": "userapi.com",
                    "Port": 443
                }
            ],
            "UpstreamPathTemplate": "/users/{id}",
            "UpstreamHttpMethod": ["Get"]
        },
        {
            "DownstreamPathTemplate": "/api/products/{id}",
            "DownstreamScheme": "https",
            "DownstreamHostAndPorts": [
                {
                    "Host": "productapi.com",
                    "Port": 443
                }
            ],
            "UpstreamPathTemplate": "/products/{id}",
            "UpstreamHttpMethod": ["Get"]
        }
    ],
    "GlobalConfiguration": {
        "BaseUrl": "http://yourgateway.com"
    }
}

该配置使用 JSON 文件进行设置，指定如何根据路径和 HTTP 方法将对 API 网关的请求路由到不同的下游服务。

将 IronPDF 与 Ocelot .NET 结合使用

将 Ocelot 与 IronPDF 在 .NET 应用程序中，IronPDF 提供了一个强大的解决方案，您可以将 PDF 生成请求路由到特定服务或在内部处理它们。在这里，我将指导您设置一个基本的 .NET Core 应用程序，该应用程序使用 Ocelot 作为 API 网关，并使用 IronPDF 来生成 PDF。 从HTML生成PDF.

第 1 步：设置 .NET Core Web 应用程序

首先，创建一个新的 .NET Core Web API 项目。您可以使用 .NET CLI 或 Visual Studio 进行创建。

使用 .NET CLI

dotnet new webapi -n OcelotWithIronPDF
cd OcelotWithIronPDF

第 2 步：添加必要的软件包

您需要安装 Ocelot 和 IronPDF。您可以通过 NuGet 添加这些软件包。

dotnet add package Ocelot
dotnet add package IronPdf

第 3 步：配置 Ocelot

在项目根目录下添加一个ocelot.json文件，配置Ocelot的路由。该设置假定您希望 Ocelot 将 PDF 生成请求路由至特定路径，而该路径将由同一应用程序中的 IronPDF 处理。

{
    "ReRoutes": [
        {
            "DownstreamPathTemplate": "/api/pdf",
            "DownstreamScheme": "https",
            "DownstreamHostAndPorts": [
                {
                    "Host": "localhost",
                    "Port": 5001
                }
            ],
            "UpstreamPathTemplate": "/generatepdf",
            "UpstreamHttpMethod": ["Post"]
        }
    ],
    "GlobalConfiguration": {
        "BaseUrl": "http://localhost:5000"
    }
}

第 4 步：配置 Startup.cs

更新 Startup.cs 以包含 Ocelot 的中间件。确保将应用程序配置为使用静态文件，因为 IronPDF 可能需要从本地文件系统加载资产。

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services.AddOcelot();
    }
    public async void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        app.UseRouting();
        app.UseAuthorization();
        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
        await app.UseOcelot();
    }
}

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services.AddOcelot();
    }
    public async void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        app.UseRouting();
        app.UseAuthorization();
        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
        await app.UseOcelot();
    }
}

Public Class Startup
	Public Sub ConfigureServices(ByVal services As IServiceCollection)
		services.AddControllers()
		services.AddOcelot()
	End Sub
	Public Async Sub Configure(ByVal app As IApplicationBuilder, ByVal env As IWebHostEnvironment)
		If env.IsDevelopment() Then
			app.UseDeveloperExceptionPage()
		End If
		app.UseRouting()
		app.UseAuthorization()
		app.UseEndpoints(Sub(endpoints)
			endpoints.MapControllers()
		End Sub)
		Await app.UseOcelot()
	End Sub
End Class

第 5 步：使用 IronPDF 生成 PDF

在控制器文件夹中创建一个新控制器 PdfController.cs 。该控制器将处理 PDF 生成请求。

using Microsoft.AspNetCore.Mvc;
using IronPdf;
namespace OcelotWithIronPDF.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    public class PdfController : ControllerBase
    {
        [HttpPost]
        public IActionResult CreatePdfFromHtml([FromBody] string htmlContent)
        {
            var renderer = new ChromePdfRenderer();
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);
            var output = pdf.BinaryData;
            return File(output, "application/pdf", "generated.pdf");
        }
    }
}

using Microsoft.AspNetCore.Mvc;
using IronPdf;
namespace OcelotWithIronPDF.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    public class PdfController : ControllerBase
    {
        [HttpPost]
        public IActionResult CreatePdfFromHtml([FromBody] string htmlContent)
        {
            var renderer = new ChromePdfRenderer();
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);
            var output = pdf.BinaryData;
            return File(output, "application/pdf", "generated.pdf");
        }
    }
}

Imports Microsoft.AspNetCore.Mvc
Imports IronPdf
Namespace OcelotWithIronPDF.Controllers
	<ApiController>
	<Route("api/[controller]")>
	Public Class PdfController
		Inherits ControllerBase

		<HttpPost>
		Public Function CreatePdfFromHtml(<FromBody> ByVal htmlContent As String) As IActionResult
			Dim renderer = New ChromePdfRenderer()
			Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)
			Dim output = pdf.BinaryData
			Return File(output, "application/pdf", "generated.pdf")
		End Function
	End Class
End Namespace

第 6 步：运行应用程序

确保应用程序已正确配置为监听 ocelot.json中指定的端口。您可以在 Properties/launchSettings.json 中进行设置。

{
  "profiles": {
    "OcelotWithIronPDF": {
      "commandName": "Project",
      "launchBrowser": false,
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

现在，运行您的应用程序，就可以将 HTML 内容发布到 http://localhost:5000/generatepdf 并收到 PDF 格式的回复。

本示例展示了在同一应用程序中将 Ocelot 与 IronPDF 结合使用的基本实施方法。对于生产场景，请考虑确保端点安全、处理错误场景，并根据具体要求优化 PDF 生成流程。

结论

总之，Ocelot 是在微服务架构中管理和路由请求的绝佳选择。路由、负载均衡、中间件支持和身份验证等强大功能使其成为任何 .NET 开发人员的强大工具。按照提供的详细步骤，您可以有效地将 Ocelot 集成到您的 .NET 项目中，以简化您的 API 网关需求。

此外，如果您需要PDF生成功能，将IronPDF与Ocelot集成也很简单，而且还能增强您应用程序的功能。IronPDF 提供 免费试用许可证起价为 $749，为您的 PDF 需求提供了经济高效的解决方案。

通过同时利用 Ocelot 和 IronPDF，您可以构建一个全面、高效的微服务基础设施，满足路由和文档生成的要求。