CQRS Pattern C#（開発者向けの動作方法）

ステップ 1: ASP.NET アプリケーションの設定

1. Visual Studio を起動し、新しいプロジェクトを作成することを選択します。
2. "ASP.NET Core Web アプリケーション"プロジェクトタイプを検索して選択します。 次へをクリックします。

3. プロジェクトに名前を付けて、その場所を設定します。 作成をクリックします。
4. ASP.NET Core の"Web アプリケーション (モデルビューコントローラ)"テンプレートを選択します。 あなたの要件に合う .NET Core バージョンを対象にしていることを確認してください。 作成をクリックします。

ステップ2

次に、CQRS のためにプロジェクトを整理したくなるでしょう。 コマンド、クエリ、およびそれらが使用する共通インターフェースを分離するフォルダを追加することでこれを行うことができます。 ソリューションエクスプローラーで、プロジェクトを右クリックし、"追加"に移動し、"新しいフォルダ"を選択します。 3つのフォルダ"Commands"、"Queries"、"Interfaces"を作成します。

"Interfaces"フォルダに、あなたのコマンドとクエリのインターフェースを追加します。 コマンドの場合、ICommandHandler というインターフェースがあり、コマンドを取り込みアクションを実行する Handle というメソッドがあります。 クエリの場合、IQueryHandler というインターフェースがあり、クエリを取り込みデータを返す Handle というメソッドを持つことができます。

ステップ3

さて、デモンストレーションのためにコマンドとクエリを追加しましょう。 あなたのアプリケーションがタスクを管理するし、タスクを追加 (コマンド) し、タスクを取得 (クエリ) したいとしましょう。

"Interfaces"フォルダに、2つのインターフェースを追加します:

// Define interfaces for your handlers:
public interface ICommandHandler<TCommand>
{
    void Handle(TCommand command);
}

public interface IQueryHandler<TQuery, TResult>
{
    TResult Handle(TQuery query);
}

// Define interfaces for your handlers:
public interface ICommandHandler<TCommand>
{
    void Handle(TCommand command);
}

public interface IQueryHandler<TQuery, TResult>
{
    TResult Handle(TQuery query);
}

"Commands"フォルダに、AddItemCommand クラスを追加し、タスクの詳細をプロパティとして設定します。 また、ICommandHandler を実装し、データベースにタスクを追加するロジックを含む AddItemCommandHandler クラスを追加します。

"Queries"フォルダに、タスクのリクエストを表す GetTasksQuery クラスを追加します。 IQueryHandler を実装し、データベースからのタスクを取得するロジックを含む GetTasksQueryHandler クラスを追加します。

単純な例として、AddItemCommand は次のように見えるかもしれません:

public class AddItemCommand
{
    public string Name { get; set; }
    public int Quantity { get; set; }

    // Constructor
    public AddItemCommand(string name, int quantity)
    {
        Name = name;
        Quantity = quantity;
    }
}

public class AddItemCommand
{
    public string Name { get; set; }
    public int Quantity { get; set; }

    // Constructor
    public AddItemCommand(string name, int quantity)
    {
        Name = name;
        Quantity = quantity;
    }
}

そして、 AddItemCommandHandler:

public class AddItemCommandHandler : ICommandHandler<AddItemCommand>
{
    public void Handle(AddItemCommand command)
    {
        // Here, you'd add the item to your database, for example, to have employee data stored
        Console.WriteLine($"Adding item: {command.Name} with quantity {command.Quantity}");
        // Add database logic here
    }
}

public class AddItemCommandHandler : ICommandHandler<AddItemCommand>
{
    public void Handle(AddItemCommand command)
    {
        // Here, you'd add the item to your database, for example, to have employee data stored
        Console.WriteLine($"Adding item: {command.Name} with quantity {command.Quantity}");
        // Add database logic here
    }
}

GetItemsQuery はタスクをフェッチするためのパラメータが必要ない場合は空であり、GetItemsQueryHandler は次のように見えるかもしれません:

public class GetItemsQuery
{
    // This class might not need any properties, depending on your query
}

namespace CQRS_testing.Queries
{
    using CQRS_testing.Interfaces;

    public class GetItemsQueryHandler : IQueryHandler<GetItemsQuery, IEnumerable<string>>
    {
        public IEnumerable<string> Handle(GetItemsQuery query)
        {
            // Here, you'd fetch items from your database
            return new List<string> { "Item1", "Item2" };
        }
    }
}

public class GetItemsQuery
{
    // This class might not need any properties, depending on your query
}

namespace CQRS_testing.Queries
{
    using CQRS_testing.Interfaces;

    public class GetItemsQueryHandler : IQueryHandler<GetItemsQuery, IEnumerable<string>>
    {
        public IEnumerable<string> Handle(GetItemsQuery query)
        {
            // Here, you'd fetch items from your database
            return new List<string> { "Item1", "Item2" };
        }
    }
}

ASP.NET コントローラでは、これらのハンドラを使用してコマンドとクエリを処理します。 タスクを追加する場合、コントローラアクションは AddTaskCommand を作成し、フォームデータからプロパティを設定し、そしてそれを処理するために AddTaskCommandHandler のインスタンスに渡します。 タスクを取得する場合、データを取得しビューに渡すために GetTasksQueryHandler を呼び出します。

コントローラで接続する

コマンドとクエリが設定されたら、それらをコントローラで使用することができます。 以下は、ItemsController クラスでこれを行う方法の例です:

public class ItemsController : Controller
{
    private readonly ICommandHandler<AddItemCommand> _addItemHandler;
    private readonly IQueryHandler<GetItemsQuery, IEnumerable<string>> _getItemsHandler;

    // Constructor injection is correctly utilized here
    public ItemsController(ICommandHandler<AddItemCommand> addItemHandler, IQueryHandler<GetItemsQuery, IEnumerable<string>> getItemsHandler)
    {
        _addItemHandler = addItemHandler;
        _getItemsHandler = getItemsHandler;
    }

    public IActionResult Index()
    {
        // Use the injected _getItemsHandler instead of creating a new instance
        var query = new GetItemsQuery();
        var items = _getItemsHandler.Handle(query);
        return View(items);
    }

    [HttpPost]
    public IActionResult Add(string name, int quantity)
    {
        // Use the injected _addItemHandler instead of creating a new instance
        var command = new AddItemCommand(name, quantity);
        _addItemHandler.Handle(command);
        return RedirectToAction("Index");
    }
}

public class ItemsController : Controller
{
    private readonly ICommandHandler<AddItemCommand> _addItemHandler;
    private readonly IQueryHandler<GetItemsQuery, IEnumerable<string>> _getItemsHandler;

    // Constructor injection is correctly utilized here
    public ItemsController(ICommandHandler<AddItemCommand> addItemHandler, IQueryHandler<GetItemsQuery, IEnumerable<string>> getItemsHandler)
    {
        _addItemHandler = addItemHandler;
        _getItemsHandler = getItemsHandler;
    }

    public IActionResult Index()
    {
        // Use the injected _getItemsHandler instead of creating a new instance
        var query = new GetItemsQuery();
        var items = _getItemsHandler.Handle(query);
        return View(items);
    }

    [HttpPost]
    public IActionResult Add(string name, int quantity)
    {
        // Use the injected _addItemHandler instead of creating a new instance
        var command = new AddItemCommand(name, quantity);
        _addItemHandler.Handle(command);
        return RedirectToAction("Index");
    }
}

特に ASP.NET Core で依存性注入 (DI) を使用している場合は、Startup.cs ファイルでの DI コンテナへのコマンドとクエリハンドラを登録して、すべてを接続します。この方法で、ASP.NET は必要なときにハンドラのインスタンスを提供できます。

ハンドラを登録する基本的な例がこちらです:

builder.Services.AddTransient<ICommandHandler<AddItemCommand>, AddItemCommandHandler>();
builder.Services.AddTransient<IQueryHandler<GetItemsQuery, IEnumerable<string>>, GetItemsQueryHandler>();

builder.Services.AddTransient<ICommandHandler<AddItemCommand>, AddItemCommandHandler>();
builder.Services.AddTransient<IQueryHandler<GetItemsQuery, IEnumerable<string>>, GetItemsQueryHandler>();

CQRS の実践的な適用において、書き込み操作のデータモデルと読み込み操作のデータモデルの違いは本質的であり、データの取り扱いをサポートする多様で最適化されたアプローチをアーキテクチャに保証します。

コード例

さあ、IronPDF が CQRS パターンに従う C# アプリケーション内でどのように利用できるかを探っていきましょう。 以下は、CQRS 設定内で PDF レポートを生成するために IronPDF を使用する方法を示す簡単な例です。 この例は概念的なものであり、コマンドとしての PDF ドキュメントの生成に焦点を当てています。

using IronPdf;
using System.Threading.Tasks;

namespace PdfGenerationApp.Commands
{
    public class GeneratePdfReportCommand
    {
        // Command handler that generates a PDF report
        public async Task GenerateReportAsync(string reportContent, string outputPath)
        {
            // Initialize the IronPDF HTML to PDF renderer
            var renderer = new ChromePdfRenderer();
            // Use IronPDF to generate a PDF from HTML content
            var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf(reportContent));
            // Save the generated PDF to a specified path
            pdf.SaveAs(outputPath);
        }
    }
}

using IronPdf;
using System.Threading.Tasks;

namespace PdfGenerationApp.Commands
{
    public class GeneratePdfReportCommand
    {
        // Command handler that generates a PDF report
        public async Task GenerateReportAsync(string reportContent, string outputPath)
        {
            // Initialize the IronPDF HTML to PDF renderer
            var renderer = new ChromePdfRenderer();
            // Use IronPDF to generate a PDF from HTML content
            var pdf = await Task.Run(() => renderer.RenderHtmlAsPdf(reportContent));
            // Save the generated PDF to a specified path
            pdf.SaveAs(outputPath);
        }
    }
}

この例では、GeneratePdfReportCommand は CQRS パターンにおけるコマンドを表します。 それは reportContent を HTML 文字列として、outputPath に PDF レポートを保存する GenerateReportAsync というメソッドを含みます。 IronPDF の HtmlToPdf クラスを使って、HTML コンテンツを PDF 形式に変換し、指定されたパスに保存します。 このセットアップは、特に CQRS で推進される責任分離が必要なシナリオで、アプリケーションのアーキテクチャに PDF 生成機能を統合する方法を示しています。