.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

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

ここでは .NET CLI を使用してシンプルな天気予報 REST API を作成します。 最初の行は API エンドポイントを実行するための HangfireDemo という名前の .NET Core Web API プロジェクトを作成します。 2行目で、新しく作成したフォルダー "HangfireDemo" に移動し、プロジェクトをビルドします。 次に、プロジェクトに Hangfire NuGet パッケージを追加し、再度ビルドします。 その後、任意のエディタ（Visual Studio 2022 や JetBrains Rider など）でプロジェクトを開くことができます。 この時点でプロジェクトを実行すると、Swagger が以下のように表示されます。

ここでは、日付、概要、気温を返す天気 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 and use SQL Server as storage option
        services.AddHangfire(config => config.UseSqlServerStorage("your_connection_string"));
        services.AddHangfireServer();
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        // Use Hangfire Server and Dashboard for monitoring and managing jobs
        app.UseHangfireServer();
        app.UseHangfireDashboard();
        // Your other configuration settings
    }
}

// Startup.cs
using Hangfire;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // Add Hangfire services and use SQL Server as storage option
        services.AddHangfire(config => config.UseSqlServerStorage("your_connection_string"));
        services.AddHangfireServer();
    }

    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        // Use Hangfire Server and Dashboard for monitoring and managing jobs
        app.UseHangfireServer();
        app.UseHangfireDashboard();
        // Your other configuration settings
    }
}

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

バックグラウンドジョブを作成

バックグラウンドジョブとして実行したいメソッドを定義します。 これらのメソッドは、引数のないコンストラクタを持つクラスのスタティックメソッドまたはインスタンスメソッドである必要があります。 ジョブは再帰ジョブとして実行することも、複数のジョブを同時に実行することもできます。

public class MyBackgroundJob
{
    public void ProcessJob()
    {
        // Background job logic, can be a recurring job or multiple jobs
        Console.WriteLine("Background job is running...");
    }
}

public class MyBackgroundJob
{
    public void ProcessJob()
    {
        // Background job logic, can be a recurring job or multiple jobs
        Console.WriteLine("Background job is running...");
    }
}

ジョブをキューに入れる

Hangfire API を使用してバックグラウンドジョブをキューに入れます。 バックグラウンドジョブを特定の時間に、遅延後に、または定期的に実行するようにスケジュールできます。

// Enqueue a job to run immediately
BackgroundJob.Enqueue<MyBackgroundJob>(x => x.ProcessJob());

// Schedule a job to run after a 5-minute delay
BackgroundJob.Schedule<MyBackgroundJob>(x => x.ProcessJob(), TimeSpan.FromMinutes(5));

// Schedule a recurring job using a job ID
RecurringJob.AddOrUpdate<MyBackgroundJob>("jobId", x => x.ProcessJob(), Cron.Daily);

// Enqueue a job to run immediately
BackgroundJob.Enqueue<MyBackgroundJob>(x => x.ProcessJob());

// Schedule a job to run after a 5-minute delay
BackgroundJob.Schedule<MyBackgroundJob>(x => x.ProcessJob(), TimeSpan.FromMinutes(5));

// Schedule a recurring job using a job ID
RecurringJob.AddOrUpdate<MyBackgroundJob>("jobId", x => x.ProcessJob(), Cron.Daily);

Hangfire ダッシュボードとサーバー

リアルタイムのジョブ監視のために Configure メソッドに Hangfire ダッシュボードとサーバーを追加することができます。

// Run Hangfire server and dashboard
app.UseHangfireServer();
app.UseHangfireDashboard();

// Run Hangfire server and dashboard
app.UseHangfireServer();
app.UseHangfireDashboard();

サーバーは ConfigureServices に追加することも可能です。

services.AddHangfireServer();

services.AddHangfireServer();

// Fire and forget jobs are executed only once and almost immediately after creation.
var jobId = BackgroundJob.Enqueue(() => Console.WriteLine("Fire-and-forget!")); // Job ID for 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!")); // Job ID for fire and forget job

// Recurring jobs fire many times based on a specified CRON schedule.
RecurringJob.AddOrUpdate("myrecurringjob", () => Console.WriteLine("Recurring!"), Cron.Daily);

// Recurring jobs fire many times based on a specified CRON schedule.
RecurringJob.AddOrUpdate("myrecurringjob", () => Console.WriteLine("Recurring!"), Cron.Daily);

// Delayed jobs are executed only once but after a specified interval.
var jobId = BackgroundJob.Schedule(() => Console.WriteLine("Delayed!"), TimeSpan.FromDays(7));

// Delayed jobs are executed only once but after a specified interval.
var jobId = BackgroundJob.Schedule(() => Console.WriteLine("Delayed!"), TimeSpan.FromDays(7));

// Continuation jobs are executed once their parent jobs have completed.
BackgroundJob.ContinueJobWith(jobId, () => Console.WriteLine("Continuation!"));

// Continuation jobs are executed once their parent jobs have completed.
BackgroundJob.ContinueJobWith(jobId, () => Console.WriteLine("Continuation!"));

// Batch is a group of background jobs created atomically and considered as a single entity.
var batchId = BatchJob.StartNew(x =>
{
    x.Enqueue(() => Console.WriteLine("Job 1"));
    x.Enqueue(() => Console.WriteLine("Job 2"));
});

// Batch is a group of background jobs created atomically and considered as a single entity.
var batchId = BatchJob.StartNew(x =>
{
    x.Enqueue(() => Console.WriteLine("Job 1"));
    x.Enqueue(() => Console.WriteLine("Job 2"));
});

// 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"));
});

ダッシュボード

Hangfire ダッシュボードでは、バックグラウンドジョブのすべての情報を見つけることができます。 これは OWIN ミドルウェアとして記述されており（OWIN に詳しくない場合でも心配ありません）、ASP.NET、ASP.NET MVC、Nancy、ServiceStack アプリケーションに接続することができ、OWIN Self-Host 機能を使用して、コンソールアプリケーションまたは Windows サービス内でダッシュボードをホストすることができます。

ダッシュボードが有効になっている場合、/hangfire/ 拡張子でアクセスできます。 このダッシュボードでは、バックグラウンドで実行されているジョブを管理したり、バックグラウンドジョブをスケジュールしたり、頻繁に忘れてしまうジョブを管理したりできます。 ジョブはジョブIDを使用して識別できます。

アプリケーションが実行すると、Hangfire は設定された設定に基づいてバックグラウンドジョブの処理を行います。

Hangfire のより高度な構成オプションと機能については、Hangfire ドキュメント を確認し、GitHub Hangfire デモ から完全なコードを見つけることができます。

IronPDFの紹介

IronPDF for .NET PDF Generation は、Iron Software の PDF ライブラリ の NuGet パッケージであり、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();

        // 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");

        // 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");

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

        // 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");

        // 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");

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

Install-Package IronPdf

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

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" };
    }
}