NServiceBus C#（開発者向けの仕組み）

メッセージベースの通信

NServiceBusは、システム内の異なるサービスやコンポーネント間のメッセージベースの通信を促進します。 コンポーネントを分離させることで、スケールや管理が容易な設計を作成します。

信頼性のあるメッセージング

自動的にリトライ、死活キュー、その他の障害耐性技術を管理することにより、信頼性のあるメッセージ配信を保証します。 分散システムでは、ネットワーク障害や他の問題による失敗が頻発するため、この信頼性は不可欠です。

発行/購読モデル

NServiceBusは発行/購読パターンをサポートしており、サービスがイベントを発行し、他のサービスがこれらのイベントに登録できます。 これはイベント駆動型アーキテクチャを可能にし、システムの一部でのイベント変更が他のコンポーネントで反応を引き起こすことができるようになります。

サガ管理

NServiceBusはサガの統合サポートを提供することで長期的なビジネスプロセスを管理できます。 サガはサービスプラットフォームに状態を管理し、複数のサービス間での複雑な操作を調整することを可能にします。

拡張性とカスタマイズ

それは優れた拡張性を提供し、開発者がメッセージの取り扱いや処理、輸送プロセスをカスタマイズできるようにします。 その適応性により、様々なシナリオで活用できます。

さまざまなメッセージングプラットフォームとの統合

MSMQ、RabbitMQ、Azure Service Bus、Amazon SQSなどの多数のメッセージングシステムと統合できます。 これにより、開発者は要件に最適な通信インフラストラクションソリューションを選択できます。

Visual Studio内でのコンソールプロジェクトの作成プロセスはシンプルです。 Visual Studio環境でこれらの簡単な手順を使用してコンソールアプリケーションを開始してください：

PCにVisual Studioがインストールされていることを確認してください。

新しいプロジェクトを開始する

Fileをクリックし、次にNewを選択し、最後にProjectを選択します。

以下のプロジェクトテンプレート参照リストから"Console App"または"Console App (.NET Core)"テンプレートを選択できます。

"Name"フィールドにプロジェクト名を入力します。

プロジェクトの保存場所を選択します。

"Create"をクリックするとコンソールアプリケーションプロジェクトが開始されます。

NServiceBusパッケージのインストール

NuGetパッケージマネージャコンソールを開くためにTools > NuGet Package Manager > Package Manager Consoleに移動します。

NServiceBus NuGetパッケージをインストールするために次のコマンドを実行します。

Install-Package NServiceBus

トランスポートを選択する

NServiceBusがメッセージを受け取ったり送信したりするにはトランスポートが必要です。 使いやすく、テストや開発に適しているため、Learning Transportを選びます。

Install the package for Learning Transport by executing.

Install-Package NServiceBus.RabbitMQ

NServiceBusの設定

エンドポイントのセットアップ

Program.csファイルの中でNServiceBusエンドポイント設定を行います：

using NServiceBus;
using System;
using System.Threading.Tasks;
using Messages;

class Program
{
    static async Task Main()
    {
        Console.Title = "Sender";
        var endpointConfiguration = new EndpointConfiguration("SenderEndpoint");

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to send a message...");
        Console.ReadLine();

        // Send a message
        var message = new MyMessage
        {
            Content = "Hello, NServiceBus with RabbitMQ!"
        };
        await endpointInstance.Send("ReceiverEndpoint", message).ConfigureAwait(false);
        Console.WriteLine("Message sent. Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

using NServiceBus;
using System;
using System.Threading.Tasks;
using Messages;

class Program
{
    static async Task Main()
    {
        Console.Title = "Sender";
        var endpointConfiguration = new EndpointConfiguration("SenderEndpoint");

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to send a message...");
        Console.ReadLine();

        // Send a message
        var message = new MyMessage
        {
            Content = "Hello, NServiceBus with RabbitMQ!"
        };
        await endpointInstance.Send("ReceiverEndpoint", message).ConfigureAwait(false);
        Console.WriteLine("Message sent. Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

メッセージを作成する

メッセージを表す新しいクラスを追加します。

public class MyMessage : IMessage
{
    public string Content { get; set; }
}

public class MyMessage : IMessage
{
    public string Content { get; set; }
}

メッセージハンドラを作成する

メッセージを処理する新しいクラスを追加します。

using NServiceBus;
using System.Threading.Tasks;

public class MyMessageHandler : IHandleMessages<MyMessage>
{
    public Task Handle(MyMessage message, IMessageHandlerContext context)
    {
        Console.WriteLine($"Received message: {message.Content}");
        return Task.CompletedTask;
    }
}

using NServiceBus;
using System.Threading.Tasks;

public class MyMessageHandler : IHandleMessages<MyMessage>
{
    public Task Handle(MyMessage message, IMessageHandlerContext context)
    {
        Console.WriteLine($"Received message: {message.Content}");
        return Task.CompletedTask;
    }
}

メッセージを送信する

エンドポイントからメッセージを送信します。 ハンドラを助けてメッセージを送信するためにメイン方法を適応させます。

using NServiceBus;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        Console.Title = "Receiver";
        var endpointConfiguration = new EndpointConfiguration("ReceiverEndpoint");

        // Serialization configuration
        endpointConfiguration.UseSerialization<NewtonsoftJsonSerializer>();

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.UseConventionalRoutingTopology(QueueType.Quorum);
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");
        endpointConfiguration.EnableInstallers();

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

using NServiceBus;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        Console.Title = "Receiver";
        var endpointConfiguration = new EndpointConfiguration("ReceiverEndpoint");

        // Serialization configuration
        endpointConfiguration.UseSerialization<NewtonsoftJsonSerializer>();

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.UseConventionalRoutingTopology(QueueType.Quorum);
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");
        endpointConfiguration.EnableInstallers();

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

アプリケーションを起動し、プロジェクトをビルドします。 コンソールには"Received message: Hello, NServiceBus!"と表示されます。

IronPDFとは？

IronPDFは、PDFファイルを作成、読み取り、編集、変換するために設計された.NETライブラリです。 これにより、プログラマは強力で直感的なツールを用いて、C#またはVB.NETアプリケーションでPDFファイルを扱うことができます。 IronPDFの特徴と能力は以下に詳細に説明されています：

IronPDF の機能

Install-Package IronPdf

メッセージを持つ送信者の設定

Messagesプロジェクトは送信者と受信者の双方で使用される共有プロジェクト（クラスライブラリ）です。 Messagesプロジェクトでメッセージクラスを定義します。 "Messages"という名前の新しいクラスライブラリプロジェクトを作成し、ソリューションに追加します。

メッセージを定義する:

Messagesプロジェクト内で、新しいクラスGeneratePdfMessage.csを作成します：

using NServiceBus;

public class GeneratePdfMessage : IMessage
{
    public string Content { get; set; }
    public string OutputPath { get; set; }
}

using NServiceBus;

public class GeneratePdfMessage : IMessage
{
    public string Content { get; set; }
    public string OutputPath { get; set; }
}

送信者プロジェクトと受信者プロジェクトの両方に、Messagesプロジェクトへの参照を含めます。

送信者プロジェクトの中で、メッセージ配信にRabbitMQを使うNServiceBusエンドポイントを設定します。

using NServiceBus;
using System;
using System.Threading.Tasks;
using Messages;

class Program
{
    static async Task Main()
    {
        Console.Title = "Sender";
        var endpointConfiguration = new EndpointConfiguration("SenderEndpoint");

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");
        endpointConfiguration.EnableInstallers();

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to send a message...");
        Console.ReadLine();

        // Send a message
        var message = new GeneratePdfMessage
        {
            Content = "<h1>Hello, NServiceBus with RabbitMQ and IronPDF!</h1>",
            OutputPath = "output.pdf"
        };
        await endpointInstance.Send("ReceiverEndpoint", message).ConfigureAwait(false);
        Console.WriteLine("Message sent. Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

using NServiceBus;
using System;
using System.Threading.Tasks;
using Messages;

class Program
{
    static async Task Main()
    {
        Console.Title = "Sender";
        var endpointConfiguration = new EndpointConfiguration("SenderEndpoint");

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");
        endpointConfiguration.EnableInstallers();

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to send a message...");
        Console.ReadLine();

        // Send a message
        var message = new GeneratePdfMessage
        {
            Content = "<h1>Hello, NServiceBus with RabbitMQ and IronPDF!</h1>",
            OutputPath = "output.pdf"
        };
        await endpointInstance.Send("ReceiverEndpoint", message).ConfigureAwait(false);
        Console.WriteLine("Message sent. Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

エンドポイント構成：エンドポイントはnew EndpointConfiguration("SenderEndpoint")を呼び出して"SenderEndpoint"という名前で初期化されます。

endpointConfigurationはトランスポート構成です。 ローカルRabbitMQインスタンスに接続することにより、メソッドUseTransport()は、NServiceBusをRabbitMQをトランスポートメカニズムとして使用するように設定します。

監査とエラキュー：失敗したメッセージを送信する場所と処理済みメッセージを監査する場所は、SendFailedMessagesTo("error") とAuditProcessedMessagesTo("audit")を使用して設定されます。

メッセージ送信：endpointInstance.Send("ReceiverEndpoint", message) は"ReceiverEndpoint"にGeneratePdfMessageを送信します。

PDF生成のために受信者を設定する

using NServiceBus;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        Console.Title = "Receiver";
        var endpointConfiguration = new EndpointConfiguration("ReceiverEndpoint");

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

using NServiceBus;
using System;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        Console.Title = "Receiver";
        var endpointConfiguration = new EndpointConfiguration("ReceiverEndpoint");

        // Use RabbitMQ Transport
        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
        transport.ConnectionString("host=localhost");

        // Set up error queue
        endpointConfiguration.SendFailedMessagesTo("error");

        // Set up audit queue
        endpointConfiguration.AuditProcessedMessagesTo("audit");

        // Start the endpoint
        var endpointInstance = await Endpoint.Start(endpointConfiguration).ConfigureAwait(false);
        Console.WriteLine("Press Enter to exit...");
        Console.ReadLine();

        // Stop the endpoint
        await endpointInstance.Stop().ConfigureAwait(false);
    }
}

using NServiceBus;
using System;
using System.Threading.Tasks;
using Messages;
using IronPdf;

public class GeneratePdfMessageHandler : IHandleMessages<GeneratePdfMessage>
{
    public Task Handle(GeneratePdfMessage message, IMessageHandlerContext context)
    {
        Console.WriteLine($"Received message to generate PDF with content: {message.Content}");

        // Generate PDF
        var renderer = new HtmlToPdf();
        var pdf = renderer.RenderHtmlAsPdf(message.Content);
        pdf.SaveAs(message.OutputPath);
        Console.WriteLine($"PDF generated and saved to: {message.OutputPath}");

        return Task.CompletedTask;
    }
}

using NServiceBus;
using System;
using System.Threading.Tasks;
using Messages;
using IronPdf;

public class GeneratePdfMessageHandler : IHandleMessages<GeneratePdfMessage>
{
    public Task Handle(GeneratePdfMessage message, IMessageHandlerContext context)
    {
        Console.WriteLine($"Received message to generate PDF with content: {message.Content}");

        // Generate PDF
        var renderer = new HtmlToPdf();
        var pdf = renderer.RenderHtmlAsPdf(message.Content);
        pdf.SaveAs(message.OutputPath);
        Console.WriteLine($"PDF generated and saved to: {message.OutputPath}");

        return Task.CompletedTask;
    }
}