Ocelot .NET (How It Works For Developers)

路由

Ocelot 功能的核心是其路由功能。 它可根據開發人員指定的組態，將傳入的請求配對至適當的服務路徑，並可與服務發現機制整合。 這包括支援通配符路由，這在處理不同 API 版本或眾多服務端點時特別有用。

中介軟體/委託處理程式

Ocelot 可讓開發人員注入自訂的中介軟體或處理程式，這些中介軟體或處理程式可在請求與回應抵達用戶端或服務之前進行處理。這對於新增標頭、記錄請求，甚至根據需要修改回應結構都很有用。

負載平衡

Ocelot 支援多種開箱即用的負載平衡策略，例如 Round Robin、Least Connection，如果預定義的策略都不符合需求，還可使用自訂的提供者。 此功能可確保負載在可用的服務間平均分配，提升應用程式的整體彈性與效率。

驗證與授權

確保 API 端點的安全至關重要，Ocelot 提供與現有驗證供應商 (例如 Identity Server) 整合的支援。 它支援流行的驗證方案，包括 JWT 和 OAuth2，並允許對使用者存取服務進行精細控制。

速率限制和 QoS

費率限制對於防止濫用和確保公平使用服務是非常重要的，它可以限制使用者在指定時間內的請求數量。 服務品質 (QoS) 選項，例如設定逾時和重試，可確保服務在各種網路條件和負載下都能保持可用且反應迅速。

步驟 1：設定 .NET Core Web 應用程式

首先，建立一個新的 .NET Core Web API 專案。 您可以使用 .NET CLI 或 Visual Studio 來完成這項工作。

使用 .NET CLI：

dotnet new webapi -n OcelotWithIronPDF
cd OcelotWithIronPDF

dotnet new webapi -n OcelotWithIronPDF
cd OcelotWithIronPDF

步驟 2：新增必要的套件

您需要安裝 Ocelot 和 IronPdf。 您可以透過 NuGet 加入這些套件。

dotnet add package Ocelot
dotnet add package IronPdf

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();
    }
}

步驟 5：使用 IronPDF 實現 PDF 生成

在您的 Controllers 資料夾中建立一個新的控制器 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 the PDF as a file result
            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 the PDF as a file result
            return File(output, "application/pdf", "generated.pdf");
        }
    }
}

步驟 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 生成流程。