# Hangfireを使ったC#での簡単なジョブ作成手順

## 目次

1. はじめに

2. Hangfireとは

3. 環境設定

   1. 必要なツールとフレームワーク

   2. プロジェクトのセットアップ

4. Hangfireの基本的な利用法

   1. ジョブの実行と管理

   2. ジョブの状態確認

5. 実際のジョブ作成例

   1. 背景ジョブの作成

   2. 再帰ジョブの設定

   3. スケジュールジョブの設定

6. ジョブのデバッグと監視

   1. ダッシュボードの使用

   2. ログ出力によるデバッグ

7. Hangfireのベストプラクティス

8. まとめ

## 1. はじめに

Hangfireは、C#を用いてASP.NETアプリケーション上で容易に背景ジョブを作成、スケジューリング、管理するためのライブラリです。本記事では、Hangfireを使用して簡単なジョブを作成する手順について解説します。

## 2. Hangfireとは

Hangfireは、C#や.NETで開発されたアプリケーションにバックグラウンドタスク機能を追加するための強力なライブラリです。タスクは非同期に実行され、システムの応答性を高めます。また、ジョブはデータベースに保存され、システム再起動後でも再実行されるため、信頼性があります。

## 3. 環境設定

### 3-1. 必要なツールとフレームワーク

- .NET Framework 4.6.1以降または.NET Core 3.1以降

- Visual Studio 2019以降

- SQL ServerもしくはPostgreSQLなどのリレーショナルデータベース（ジョブ情報を保存するため）

### 3-2. プロジェクトのセットアップ

1. **新規プロジェクトの作成**  

   Visual Studioで新しいASP.NET Core Webアプリケーションを作成します。

2. **NuGetパッケージのインストール**  

   Hangfireをプロジェクトで使用するために、次のコマンドをPackage Manager Consoleで実行します:

   ```shell

   Install-Package Hangfire

   ```

3. **データベース接続の設定**  

   `Startup.cs`にある`ConfigureServices`メソッドでHangfireをセットアップします。以下に例を示します。

   ```csharp

   // C#

   using Hangfire;

   using Hangfire.SqlServer;

   public void ConfigureServices(IServiceCollection services)

   {

       services.AddHangfire(configuration => configuration

           .SetDataCompatibilityLevel(CompatibilityLevel.Version_170)

           .UseSimpleAssemblyNameTypeSerializer()

           .UseRecommendedSerializerSettings()

           .UseSqlServerStorage(Configuration.GetConnectionString("DefaultConnection"), new SqlServerStorageOptions

           {

               CommandBatchMaxTimeout = TimeSpan.FromMinutes(5),

               SlidingInvisibilityTimeout = TimeSpan.FromMinutes(5),

               QueuePollInterval = TimeSpan.Zero,

               UseRecommendedIsolationLevel = true,

               DisableGlobalLocks = true

           }));

       services.AddHangfireServer();

   }

   ```

## 4. Hangfireの基本的な利用法

### 4-1. ジョブの実行と管理

Hangfireでは、4種類のジョブを設定できます：  

1. **バックグラウンドジョブ** - 即時実行。

2. **延遅ジョブ** - 指定時間後に実行。

3. **再帰ジョブ** - 定期的に実行。

4. **フィルタ付きジョブ** - 指定されたフィルタ条件で実行。

### 4-2. ジョブの状態確認

Hangfireでは、ジョブの状態はダッシュボードを通じて視覚的に確認できます。ジョブの履歴、ステータス、エラーなどをリアルタイムで確認可能です。

## 5. 実際のジョブ作成例

ここでは、シンプルな背景ジョブをC#で実装する方法を示します。

### 5-1. 背景ジョブの作成

```csharp

// C#

public class SampleJob

{

    public void ExecuteTask()

    {

        Console.WriteLine("Hello, Hangfire!");

    }

}

// このジョブは即時実行されます。

BackgroundJob.Enqueue(() => new SampleJob().ExecuteTask());

```

### 5-2. 再帰ジョブの設定

```csharp

// C#

RecurringJob.AddOrUpdate(

    "my-recurring-job",

    () => Console.WriteLine("Recurring job executed!"),

    Cron.Hourly);

```

このコードは1時間ごとに同じジョブを実行します。

### 5-3. スケジュールジョブの設定

```csharp

// C#

BackgroundJob.Schedule(() => Console.WriteLine("Delayed job!"), TimeSpan.FromMinutes(30));

```

このコードは30分後に1回だけ実行されるジョブを設定します。

## 6. ジョブのデバッグと監視

### 6-1. ダッシュボードの使用

ダッシュボードは、Hangfireのジョブを監視するためのツールです。`Startup.cs`の`Configure`メソッドでダッシュボードを設定します：

```csharp

// C#

app.UseHangfireDashboard("/hangfire", new DashboardOptions

{

    Authorization = new[] { new MyAuthorizationFilter() }

});

```

### 6-2. ログ出力によるデバッグ

ログ記録を設定し、ジョブの動作を綿密に記録することで、問題発生時にも迅速に対応が可能です。

## 7. Hangfireのベストプラクティス

- **再試行の設定**: ジョブ失敗時の再試行戦略を設定して、システムの信頼性を向上させる。

- **競合の管理**: 同時実行ジョブの管理により、データの整合性を維持。

- **データベース負荷の監視**: Hangfireによるデータベースへの負荷を定期的に監視し、必要に応じて設定を最適化。

## 8. まとめ

本記事では、Hangfireを利用したC#での基本的なジョブ作成方法を解説しました。このように、適切なフレームワークを活用することで、アプリケーションに影響を与えずにバックグラウンドでのタスクを効率的に処理することが可能です。ぜひHangfireを利用して、あなたのプロジェクトにも強力なジョブ管理機能を組み込んでください。

Hangfireを使ったC#での簡単なジョブ作成手順

目次

続きを読むには単価診断を受けてください（30秒）