.NET 幫助

Hangfire .NET Core(開發人員如何使用)

發佈 2024年1月14日
分享:

現代應用程式開發經常需要處理後台任務來處理龐大的任務,在這種情況下,我們需要後台任務處理器來執行多個任務。有許多任務處理器,其中一個用於 C# .NET Core 應用程式的後台父任務處理器是 Hangfire。在這篇博客中,我們將學習 Hangfire 後台任務以及如何將其與其他套件結合使用。 IronPDF 生成 PDF 文件在背景中。

簡介

Hangfire 透過提供一個可靠且靈活的框架來管理和執行後臺作業,簡化了在ASP.NET Core 或 .NET Core 6 Web API 應用程式中實現後臺處理的過程。Hangfire 可作為一個 NuGet 封裝並可使用 .NET CLI 如下安裝。

dotnet add package Hangfire --version 1.8.6

在 .NET Core Web API 中的實現

要了解 Hangfire,讓我們創建一個簡單的 .NET Core API 應用程序並使用 CLI 安裝 Hangfire。

dotnet new webapi -n HangfireDemo
cd HangfireDemo
dotnet build
dotnet add package Hangfire --version 1.8.6
dotnet build

在這裡,我們正在使用 .NET CLI 創建一個簡單的天氣 REST API。第一行創建了一個名為 HangfireDemo 的 Core Web API 專案 (也可以建立 ASP.NET Core) 執行 API 端點。第二行是導航到我們新創建的資料夾 "HangfireDemo",然後建置專案。接下來,我們將 Hangfire NuGet 封裝添加到我們的專案中,然後再次建置。完成後,您可以在您選擇的任何編輯器中打開專案,例如 Visual Studio 2022 或 JetBrains Rider。現在如果您運行專案,就可以看到如下圖所示的 Swagger。

Hangfire .NET Core(開發人員工作原理):圖1 - Swagger

在這裡,我們可以看到返回日期、摘要和溫度的天氣 GET API。

Hangfire .NET Core(如何為開發者運作):圖2 - 天氣GET API

現在讓我們添加一個 Hangfire 背景工作處理器。在 Visual Studio 中打開專案。

添加 Hangfire 任務處理器

在您的應用程式中配置 Hangfire,通常是在 Startup.cs 檔案中進行。這涉及設置任務儲存並初始化 Hangfire 伺服器。

// Startup.cs
using Hangfire;
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // Add Hangfire services
        services.AddHangfire(config => config.UseSqlServerStorage("your_connection_string"));
    }
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        // Configure Hangfire
        app.UseHangfireServer();
        app.UseHangfireDashboard();
        // Your other configuration settings
    }
}
// Startup.cs
using Hangfire;
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // Add Hangfire services
        services.AddHangfire(config => config.UseSqlServerStorage("your_connection_string"));
    }
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        // Configure Hangfire
        app.UseHangfireServer();
        app.UseHangfireDashboard();
        // Your other configuration settings
    }
}
' Startup.cs
Imports Hangfire
Public Class Startup
	Public Sub ConfigureServices(ByVal services As IServiceCollection)
		' Add Hangfire services
		services.AddHangfire(Function(config) config.UseSqlServerStorage("your_connection_string"))
	End Sub
	Public Sub Configure(ByVal app As IApplicationBuilder, ByVal env As IHostingEnvironment)
		' Configure Hangfire
		app.UseHangfireServer()
		app.UseHangfireDashboard()
		' Your other configuration settings
	End Sub
End Class
VB   C#

ConfigureServices 用於添加儲存來保存 Hangfire 新創建的作業。這裡使用了 SQL Server 資料庫。SQL Server 連接字串應該替換為 "your_connection_string"。也可以使用 Hangfire.InMemory 進行記憶體內儲存。

dotnet add package Hangfire.InMemory --version 0.6.0

並替換為

services.AddHangfire(configuration => { configuration.UseInMemoryStorage(); });
services.AddHangfire(configuration => { configuration.UseInMemoryStorage(); });
services.AddHangfire(Sub(configuration)
	configuration.UseInMemoryStorage()
End Sub)
VB   C#

建立背景工作

定義您想要作為背景工作運行的方法。這些方法應該是具有無參數構造函數的類的靜態方法或實例方法。這些工作可以作為定期工作運行,或者可以運行許多工作。

public class MyBackgroundJob
{
    public void ProcessJob()
    {
        // Your background job logic, recurring job or multiple jobs
        Console.WriteLine("Background job is running...");
    }
}
public class MyBackgroundJob
{
    public void ProcessJob()
    {
        // Your background job logic, recurring job or multiple jobs
        Console.WriteLine("Background job is running...");
    }
}
Public Class MyBackgroundJob
	Public Sub ProcessJob()
		' Your background job logic, recurring job or multiple jobs
		Console.WriteLine("Background job is running...")
	End Sub
End Class
VB   C#

排隊作業

使用 Hangfire API 排隊背景作業。您可以排程背景作業在特定時間運行、延遲運行或定期運行。

// Enqueue a job to run immediately
BackgroundJob.Enqueue<MyBackgroundJob>(x => x.ProcessJob());
// Schedule a job to run after 5 min delay, delayed job
BackgroundJob.Schedule<MyBackgroundJob>(x => x.ProcessJob(), TimeSpan.FromMinutes(5));
// Schedule a recurring job / recurring jobs using job Id
RecurringJob.AddOrUpdate<MyBackgroundJob>("job Id", x => x.ProcessJob(), Cron.Daily);
// Enqueue a job to run immediately
BackgroundJob.Enqueue<MyBackgroundJob>(x => x.ProcessJob());
// Schedule a job to run after 5 min delay, delayed job
BackgroundJob.Schedule<MyBackgroundJob>(x => x.ProcessJob(), TimeSpan.FromMinutes(5));
// Schedule a recurring job / recurring jobs using job Id
RecurringJob.AddOrUpdate<MyBackgroundJob>("job Id", x => x.ProcessJob(), Cron.Daily);
' Enqueue a job to run immediately
BackgroundJob.Enqueue(Of MyBackgroundJob)(Function(x) x.ProcessJob())
' Schedule a job to run after 5 min delay, delayed job
BackgroundJob.Schedule(Of MyBackgroundJob)(Function(x) x.ProcessJob(), TimeSpan.FromMinutes(5))
' Schedule a recurring job / recurring jobs using job Id
RecurringJob.AddOrUpdate(Of MyBackgroundJob)("job Id", Function(x) x.ProcessJob(), Cron.Daily)
VB   C#

Hangfire 儀表板和伺服器

您可以在 Configure 方法中新增 Hangfire 儀表板和伺服器。

// Run Hangfire server
app.UseHangfireServer();
app.UseHangfireDashboard();
// Run Hangfire server
app.UseHangfireServer();
app.UseHangfireDashboard();
' Run Hangfire server
app.UseHangfireServer()
app.UseHangfireDashboard()
VB   C#

伺服器也可以在 ConfigureServices 中添加。

services.AddHangfireServer();
services.AddHangfireServer();
services.AddHangfireServer()
VB   C#

無需監控的任務

//Fire and forget job / Fire and forget jobs are executed only once and almost immediately after creation.
var jobId = BackgroundJob.Enqueue(() => Console.WriteLine("Fire-and-forget!")); //jobId for Fire and forget job
//Fire and forget job / Fire and forget jobs are executed only once and almost immediately after creation.
var jobId = BackgroundJob.Enqueue(() => Console.WriteLine("Fire-and-forget!")); //jobId for Fire and forget job
'Fire and forget job / Fire and forget jobs are executed only once and almost immediately after creation.
Dim jobId = BackgroundJob.Enqueue(Sub() Console.WriteLine("Fire-and-forget!")) 'jobId for Fire and forget job
VB   C#

定期工作

//Recurring jobs fire many times on the specified CRON schedule.
RecurringJob.AddOrUpdate( "myrecurringjob",() => Console.WriteLine("Recurring!"),Cron.Daily);
//Recurring jobs fire many times on the specified CRON schedule.
RecurringJob.AddOrUpdate( "myrecurringjob",() => Console.WriteLine("Recurring!"),Cron.Daily);
'Recurring jobs fire many times on the specified CRON schedule.
RecurringJob.AddOrUpdate("myrecurringjob",Sub() Console.WriteLine("Recurring!"),Cron.Daily)
VB   C#

延遲的工作

//Delayed jobs are executed only once too, but not immediately, after a certain specific interval.
var jobId = BackgroundJob.Schedule(() => Console.WriteLine("Delayed!"),
    TimeSpan.FromDays(7));
//Delayed jobs are executed only once too, but not immediately, after a certain specific interval.
var jobId = BackgroundJob.Schedule(() => Console.WriteLine("Delayed!"),
    TimeSpan.FromDays(7));
'Delayed jobs are executed only once too, but not immediately, after a certain specific interval.
Dim jobId = BackgroundJob.Schedule(Sub() Console.WriteLine("Delayed!"), TimeSpan.FromDays(7))
VB   C#

延續

//Continuation jobs are executed when its parent job has been finished, immediate child job
BackgroundJob.ContinueJobWith(jobId,() => Console.WriteLine("Continuation!"));
//Continuation jobs are executed when its parent job has been finished, immediate child job
BackgroundJob.ContinueJobWith(jobId,() => Console.WriteLine("Continuation!"));
'Continuation jobs are executed when its parent job has been finished, immediate child job
BackgroundJob.ContinueJobWith(jobId,Sub() Console.WriteLine("Continuation!"))
VB   C#

批次作業

//Batch is a group of background jobs that is created atomically and considered as a single entity. Two jobs can be run as below.
var batchId = BatchJob.StartNew(x =>
{
    x.Enqueue(() => Console.WriteLine("Job 1"));
    x.Enqueue(() => Console.WriteLine("Job 2"));
});
//Batch is a group of background jobs that is created atomically and considered as a single entity. Two jobs can be run as below.
var batchId = BatchJob.StartNew(x =>
{
    x.Enqueue(() => Console.WriteLine("Job 1"));
    x.Enqueue(() => Console.WriteLine("Job 2"));
});
'Batch is a group of background jobs that is created atomically and considered as a single entity. Two jobs can be run as below.
Dim batchId = BatchJob.StartNew(Sub(x)
	x.Enqueue(Sub() Console.WriteLine("Job 1"))
	x.Enqueue(Sub() Console.WriteLine("Job 2"))
End Sub)
VB   C#

批次連續作業

Batch continuation is fired when all background jobs in a parent batch are finished.
BatchJob.ContinueBatchWith(batchId, x =>
{
    x.Enqueue(() => Console.WriteLine("Last Job"));
});
Batch continuation is fired when all background jobs in a parent batch are finished.
BatchJob.ContinueBatchWith(batchId, x =>
{
    x.Enqueue(() => Console.WriteLine("Last Job"));
});
Dim tempVar As Boolean = TypeOf continuation Is fired
Dim [when] As fired = If(tempVar, CType(continuation, fired), Nothing)
Batch tempVar all background jobs in a parent batch are finished.BatchJob.ContinueBatchWith(batchId, Sub(x)
	x.Enqueue(Sub() Console.WriteLine("Last Job"))
End Sub)
VB   C#

儀表板

Hangfire 儀表板是您可以找到所有背景任務資訊的地方。它作為一個 OWIN 中介軟體編寫。 (如果你不熟悉 OWIN,別擔心),因此,您可以將其插入到您的ASP.NET、ASP.NET MVC、Nancy和ServiceStack應用程式中,以及使用 OWIN 自主寄宿 功能可以在控制台應用程式或 Windows 服務中託管儀表板。

當你在視圖中啟用了儀表板功能時,儀表板位於 /hangfire/ 擴展。在這個儀表板中,可以管理後台執行的工作,排程後台工作,查看一次性的工作和週期性工作。工作可以使用工作 ID 來識別。

即時處理

Hangfire .NET Core(對開發人員的運作方式):圖3 - 任務的即時處理

成功的任務

成功的任務可以在下方查看。

Hangfire .NET Core(對開發人員的運作原理):圖 4 - 成功的工作

排程工作

Hangfire .NET Core(開發人員如何運作):圖5 - 排程工作

現在,當您的應用程式運行時,Hangfire 將根據配置的設定處理背景工作。

請記住查閱 Hangfire 文檔以了解更多高級配置選項和功能:Hangfire 文件資料 完整的代碼可以在 GitHub.

介紹 IronPDF

IronPDF 是一个 NuGet 從 套件 Iron Software 它有助於閱讀和生成 PDF 文件。它可以輕鬆地將具有樣式資訊的格式化文件轉換為 PDF。IronPDF 可以輕鬆地從 HTML 內容生成 PDF。它可以從 URL 下載 HTML,然後生成 PDF。

IronPDF 的主要吸引力是其 HTML轉PDF 函數,保持佈局和樣式。它可以從網頁內容創建 PDF,非常適合報告、發票和文檔。此功能支持將 HTML 文件、URL 和 HTML 字串轉換為 PDF。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
Imports IronPdf

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim renderer = New ChromePdfRenderer()

		' 1. Convert HTML String to PDF
		Dim htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>"
		Dim pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent)
		pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf")

		' 2. Convert HTML File to PDF
		Dim htmlFilePath = "path_to_your_html_file.html" ' Specify the path to your HTML file
		Dim pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath)
		pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf")

		' 3. Convert URL to PDF
		Dim url = "http://ironpdf.com" ' Specify the URL
		Dim pdfFromUrl = renderer.RenderUrlAsPdf(url)
		pdfFromUrl.SaveAs("URLToPDF.pdf")
	End Sub
End Class
VB   C#

安裝 IronPDF 庫

C# NuGet 程式庫用于 PDF

安裝與 NuGet

Install-Package IronPdf
Java PDF JAR

下載 DLL

下載DLL

手動安裝到您的項目中

C# NuGet 程式庫用于 PDF

安裝與 NuGet

Install-Package IronPdf
Java PDF JAR

下載 DLL

下載DLL

手動安裝到您的項目中

立即開始在您的專案中使用IronPDF,並享受免費試用。

第一步:
green arrow pointer

查看 IronPDFNuget 快速安裝和部署。已被下載超過800萬次,它正用C#改變PDF。

C# NuGet 程式庫用于 PDF nuget.org/packages/IronPdf/
Install-Package IronPdf

請考慮安裝 IronPDF DLL 直接下載並手動安裝到您的專案或GAC表單: IronPdf.zip

手動安裝到您的項目中

下載DLL

使用 NuGet 套件管理器安裝

要將 IronPDF 整合到您的 Hangfire .NET 項目中,請按照以下步驟操作:

  1. 打開 Visual Studio,在解決方案資源管理器中,右鍵單擊您的項目。
  2. 從上下文菜單中選擇“管理 NuGet 套件…”。
  3. 轉到“浏覽”標籤並搜索 IronPDF。
  4. 從搜索結果中選擇 IronPDF 庫並點擊安裝按鈕。
  5. 接受任何許可協議提示。

如果您想通過套件管理器控制台將 IronPDF 包含在您的項目中,請在套件管理器控制台中執行以下命令:

Install-Package IronPdf

這將會將 IronPDF 取回並安裝到您的專案中。

使用 NuGet 网站安装

有关 IronPDF 的详细概述,包括其功能、兼容性和其他下载选项,请访问 NuGet 网站上的 IronPDF 页面:https://www.nuget.org/packages/IronPdf

通過 DLL 安裝

或者,您可以使用 dll 文件將 IronPDF 直接整合到您的項目中。從這裡下載包含 DLL 的 ZIP 文件 連結. 解壓縮並將 DLL 包含在您的專案中。

現在讓我們修改應用程式,添加一個後臺處理工作以將 HTTP 請求管道網站下載為 PDF 檔。

namespace HangfireDemo.Core;
public class PdfGenerationJob
{
    public void Start(string website)
    {
        // Create a PDF from any existing web page
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        PdfDocument pdf = renderer.RenderUrlAsPdf(website);
        var filePath = AppContext.BaseDirectory + "result.pdf";
        pdf.SaveAs(filePath);
    }
}
namespace HangfireDemo.Core;
public class PdfGenerationJob
{
    public void Start(string website)
    {
        // Create a PDF from any existing web page
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        PdfDocument pdf = renderer.RenderUrlAsPdf(website);
        var filePath = AppContext.BaseDirectory + "result.pdf";
        pdf.SaveAs(filePath);
    }
}
Namespace HangfireDemo.Core
	Public Class PdfGenerationJob
		Public Sub Start(ByVal website As String)
			' Create a PDF from any existing web page
			Dim renderer As New ChromePdfRenderer()
			Dim pdf As PdfDocument = renderer.RenderUrlAsPdf(website)
			Dim filePath = AppContext.BaseDirectory & "result.pdf"
			pdf.SaveAs(filePath)
		End Sub
	End Class
End Namespace
VB   C#

IronPDF 具有內建的方法,可從 URL 下載網站並將其儲存為 PDF 文件。我們將在工作中使用此方法來下載並將其儲存到暫存位置。此後臺工作可以修改為接受多個網站 URL 並將其儲存為 PDF。

現在讓我們添加一個控制器來公開 PDF 生成和下載 API。

using Hangfire;
using HangfireDemo.Core;
using Microsoft.AspNetCore.Mvc;
namespace HangfireDemo.Controllers;
[ApiController]
[Route("[controller]")]
public class PdfGeneratorController : ControllerBase
{
    [HttpGet("request", Name = "Start PDF Generation")]
    public void Start([FromQuery] string websiteUrl)
    {
        BackgroundJob.Enqueue<PdfGenerationJob>(x => x.Start(websiteUrl));
    }
    [HttpGet("result", Name = "Download PDF Generation")]
    public IActionResult WebResult()
    {
        var filePath = AppContext.BaseDirectory + "result.pdf";
        var stream = new FileStream(filePath, FileMode.Open);
       return new FileStreamResult(stream, "application/octet-stream") { FileDownloadName = "website.pdf" };
    }
}
using Hangfire;
using HangfireDemo.Core;
using Microsoft.AspNetCore.Mvc;
namespace HangfireDemo.Controllers;
[ApiController]
[Route("[controller]")]
public class PdfGeneratorController : ControllerBase
{
    [HttpGet("request", Name = "Start PDF Generation")]
    public void Start([FromQuery] string websiteUrl)
    {
        BackgroundJob.Enqueue<PdfGenerationJob>(x => x.Start(websiteUrl));
    }
    [HttpGet("result", Name = "Download PDF Generation")]
    public IActionResult WebResult()
    {
        var filePath = AppContext.BaseDirectory + "result.pdf";
        var stream = new FileStream(filePath, FileMode.Open);
       return new FileStreamResult(stream, "application/octet-stream") { FileDownloadName = "website.pdf" };
    }
}
Imports Hangfire
Imports HangfireDemo.Core
Imports Microsoft.AspNetCore.Mvc
Namespace HangfireDemo.Controllers
	<ApiController>
	<Route("[controller]")>
	Public Class PdfGeneratorController
		Inherits ControllerBase

		<HttpGet("request", Name := "Start PDF Generation")>
		Public Sub Start(<FromQuery> ByVal websiteUrl As String)
			BackgroundJob.Enqueue(Of PdfGenerationJob)(Function(x) x.Start(websiteUrl))
		End Sub
		<HttpGet("result", Name := "Download PDF Generation")>
		Public Function WebResult() As IActionResult
			Dim filePath = AppContext.BaseDirectory & "result.pdf"
			Dim stream = New FileStream(filePath, FileMode.Open)
		   Return New FileStreamResult(stream, "application/octet-stream") With {.FileDownloadName = "website.pdf"}
		End Function
	End Class
End Namespace
VB   C#

我們在這裡創建了兩個 API,一個是啟動背景工作來獲取網站 URL 並啟動下載。另一個 API 是下載 PDF 結果。這些 API 如下所示:

Hangfire .NET Core(開發人員如何使用):圖 7 - PDFGenerator APIs

結果如下所示。

Hangfire .NET Core(如何為開發人員工作):圖8 - 輸出

授權 (免費試用)

若要使上述代碼在無浮水印的情況下運行,則需要許可證密鑰。開發者註冊後可獲得試用許可證。 這裡 是的,試用許可證不需要信用卡。只需提供電子郵件地址並註冊即可獲得免費試用。

結論

Hangfire 和 IronPDF 是一個很好的組合,可在後台生成和下載 PDF。我們可以在各種編程範式中使用 Hangfire 來處理長時間運行的任務。IronPDF 提供了一個靈活且易於使用的生成 PDF 的解決方案。要了解更多關於 IronPDF 的信息,您可以查閱文檔 這裡.

此外,您還可以探索來自 Iron Software 這將幫助您提高編碼技能,並達到現代應用程式的需求。

< 上一頁
C# 空合併運算符(對開發人員的運作方式)
下一個 >
C# 隊列(開發人員如何工作)

準備開始了嗎? 版本: 2024.9 剛剛發布

免費 NuGet 下載 總下載次數: 10,840,061 查看許可證 >