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

メディエーター・パターンとMediatRへのイントロダクション

メディエーター・パターンは、オブジェクト間の直接的な依存関係を削減して、疎結合を促進する形で相互作用を容易にするソフトウェア設計パターンです。 MediatRは、オブジェクト間のコミュニケーション促進においてシンプルさと効率性に重点を置いた野心的でない仲介者実装を提供します。

MediatRライブラリの中心にはリクエストと複数のハンドラの概念があります。 リクエストポイントで、オブジェクトはMediatRメカニズムによる処理を待つ操作や行動の詳細をカプセル化します。 各リクエストは対応するハンドラまたはハンドルメソッドで処理され、リクエストを実行するビジネスロジックが含まれます。この構造は、読み取りと書き込み操作の分離がよりメンテナブルでスケーラブルなソフトウェアアーキテクチャにつながるコマンドクエリ責任分離（CQRS）パターンを実装するのに特に有用です。

パッケージマネージャコンソールでの.NET CoreプロジェクトへのMediatRのインストール

ASP.NET CoreプロジェクトでMediatRを使用し始めるには、まずMediatRパッケージをインストールする必要があります。 これは、次のコマンドを使用してVisual Studioのパッケージマネージャコンソールで行うことができます。

Install-Package MediatR

パッケージをインストールした後、MediatRをASP.NET Core依存注入コンテナに追加することが必要です。 これは通常、使用しているASP.NET Coreのバージョンに応じて、ウェブアプリケーションプロジェクトのProgram.csまたはStartup.csファイルで行います。 最小限のAPIプレゼンテーションレイヤーを持つプログラムでこれを行う方法を示します。

// Initialize a new web application
var builder = WebApplication.CreateBuilder(args);

// Add MediatR to the service container
builder.Services.AddMediatR(typeof(Program).Assembly);

// Build the web application
var app = builder.Build();

// Initialize a new web application
var builder = WebApplication.CreateBuilder(args);

// Add MediatR to the service container
builder.Services.AddMediatR(typeof(Program).Assembly);

// Build the web application
var app = builder.Build();

プログラムクラスで、var builder = WebApplication.CreateBuilder(args);は、MediatR統合の舞台を整えつつウェブアプリケーションを初期化します。

初めてのMediatRリクエストとハンドラの作成

MediatRリクエストは、特定の操作を実行するために必要なデータを表すシンプルなクラスです。 新しいユーザーを作成するためのコマンドを表すリクエストクラスの例を示します。

public class CreateUserCommand : IRequest<int>
{
    public string Name { get; set; }
    public string Email { get; set; }
    public int Id { get; set; }
}

public class CreateUserCommand : IRequest<int>
{
    public string Name { get; set; }
    public string Email { get; set; }
    public int Id { get; set; }
}

この例では、CreateUserCommandクラスは、IRequestインターフェースを実装し、このリクエストが作成されたユーザーのIDを表す整数応答を期待することを示しています。

次に、このリクエストに対するハンドラを作成する必要があります。各ハンドラ内で、Handleメソッドはリクエストのロジックが実行される場所です。

public class CreateUserHandler : IRequestHandler<CreateUserCommand, int>
{
    public async Task<int> Handle(CreateUserCommand command, CancellationToken token)
    {
        // Implement logic to create a user here
        // For this example, let's pretend we create a user and return the ID
        return await Task.FromResult(1); // Assume the user's ID is 1
    }
}

public class CreateUserHandler : IRequestHandler<CreateUserCommand, int>
{
    public async Task<int> Handle(CreateUserCommand command, CancellationToken token)
    {
        // Implement logic to create a user here
        // For this example, let's pretend we create a user and return the ID
        return await Task.FromResult(1); // Assume the user's ID is 1
    }
}

[ApiController]
[Route("[controller]")]
public class UsersController : ControllerBase
{
    private readonly IMediator _mediator;

    public UsersController(IMediator mediator)
    {
        _mediator = mediator;
    }

    [HttpPost]
    public async Task<ActionResult<int>> Create(CreateUserCommand command)
    {
        var userId = await _mediator.Send(command);
        return CreatedAtRoute("GetUser", new { id = userId }, command);
    }
}

[ApiController]
[Route("[controller]")]
public class UsersController : ControllerBase
{
    private readonly IMediator _mediator;

    public UsersController(IMediator mediator)
    {
        _mediator = mediator;
    }

    [HttpPost]
    public async Task<ActionResult<int>> Create(CreateUserCommand command)
    {
        var userId = await _mediator.Send(command);
        return CreatedAtRoute("GetUser", new { id = userId }, command);
    }
}

IronPDFライブラリの紹介

IronPDFは、アプリケーション内でPDFファイルを作成、編集、および処理するための簡単な方法を必要とする.NET開発者向けに設計されたC#ライブラリです。 開発者は、ウェブページやHTMLコードを直接PDF形式に変換することで、複雑なAPIを使わずにPDFを生成できます。 IronPDFはPDFを作成するだけにとどまらず、 PDF内のフォームの追加や編集、テキスト、画像の追加、ページの追加、さらにはPDF文書内でのフォームの記入および編集などの編集機能を提供します。 開発者はPDFファイルのマージ、分割、パスワードおよびアクセス許可を使用したセキュリティの設定など、包括的にPDFを操作できます。

IronPDFは、元のレイアウトとスタイルを正確に保持したHTML to 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");
    }
}

using IronPdf;

public class PdfGenerator
{
    public void CreatePdfWithMediaInfo(string htmlContent)
    {
        // Insert your License Key here if required
        License.LicenseKey = "License-Key";

        // Initialize the HtmlToPdf renderer
        var renderer = new ChromePdfRenderer();

        // Create an HTML template with media information
        string htmlTemplate = $@"
            <html>
            <head>
                <title>Media Information</title>
            </head>
            <body>
                <h1>Media Details</h1>
                <!-- Insert your media information here -->
                {htmlContent}
            </body>
            </html>";

        // Convert the HTML string to a PDF document
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate);
        pdfDocument.SaveAs("MediaInformation.pdf");
    }
}

class Program
{
    static void Main(string[] args)
    {
        // Example HTML content with MediatR information
        string htmlContent = @"
            <div>
                <h2>MediatR Information</h2>
                <p>MediatR is a media tracking system...</p>
            </div>";

        // Create an instance of PdfGenerator
        PdfGenerator pdfGenerator = new PdfGenerator();

        // Call the CreatePdfWithMediaInfo method to generate the PDF
        pdfGenerator.CreatePdfWithMediaInfo(htmlContent);

        Console.WriteLine("PDF generated successfully.");
    }
}

using IronPdf;

public class PdfGenerator
{
    public void CreatePdfWithMediaInfo(string htmlContent)
    {
        // Insert your License Key here if required
        License.LicenseKey = "License-Key";

        // Initialize the HtmlToPdf renderer
        var renderer = new ChromePdfRenderer();

        // Create an HTML template with media information
        string htmlTemplate = $@"
            <html>
            <head>
                <title>Media Information</title>
            </head>
            <body>
                <h1>Media Details</h1>
                <!-- Insert your media information here -->
                {htmlContent}
            </body>
            </html>";

        // Convert the HTML string to a PDF document
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlTemplate);
        pdfDocument.SaveAs("MediaInformation.pdf");
    }
}

class Program
{
    static void Main(string[] args)
    {
        // Example HTML content with MediatR information
        string htmlContent = @"
            <div>
                <h2>MediatR Information</h2>
                <p>MediatR is a media tracking system...</p>
            </div>";

        // Create an instance of PdfGenerator
        PdfGenerator pdfGenerator = new PdfGenerator();

        // Call the CreatePdfWithMediaInfo method to generate the PDF
        pdfGenerator.CreatePdfWithMediaInfo(htmlContent);

        Console.WriteLine("PDF generated successfully.");
    }
}

結論

この記事で説明したステップに従うことで、MediatRをプロジェクトに組み込み、基本的なコマンドおよびクエリハンドリングから通知および振る舞いなどの高度な機能を活用するための確固たる基盤を得ることができるはずです。 アプリケーションが成長および進化するにつれて、MediatRはコードベースをクリーンで、保守性が高く、拡張性のある状態に保つのに役立つツールとパターンを提供します。

締めくくりとして、異なるライブラリやツール、例えばIronPDFを調査し、それを統合することで、.NETプロジェクトをさらに充実させることができることを述べる価値があります。 IronPDFは高度なPDF機能の無料試用版を提供します。 高度なPDF機能を必要とするプロジェクトに対しては、IronPDFのライセンスは$799から始まり、アプリケーションの機能を拡張したい.NET開発者にとって堅牢なソリューションを提供します。