C#/.NetでAsposeやiTextSharpはもう使わないで！QuestPDFを使えばPDF生成がより速く効率的！

1. QuestPDF について

QuestPDF は、.NET または .NET Core で PDF ドキュメントを生成するためのオープンソースのツールライブラリです。

完全な改ページサポートと柔軟性を考慮して設計されたレイアウトエンジンを提供します。市面上でよく使われる Aspose や iTextSharp よりもはるかに使いやすいです！

GitHub アドレス：https://github.com/QuestPDF/QuestPDF
公式サイト：https://www.questpdf.com/

2. インストール

Install-Package QuestPDF

3. 例

3.1 簡単な例

PDF ドキュメントの生成は、Header（ヘッダー）、Content（コンテンツ）、Footer（フッター）の 3 つの部分で構成されます。以下はサンプルコードです：

Document.Create(container =>
{
    container.Page(page =>
    {
        page.Size(PageSizes.A4);
        page.Margin(2, Unit.Centimetre);
        page.Background(Colors.White);
        page.DefaultTextStyle(x => x.FontSize(20));

        page.Header()
            .Text("Hello PDF!")
            .SemiBold().FontSize(36).FontColor(Colors.Blue.Medium);

        page.Content()
            .PaddingVertical(1, Unit.Centimetre)
            .Column(x =>
            {
                x.Spacing(20);

                x.Item().Text(Placeholders.LoremIpsum());
                x.Item().Image(Placeholders.Image(200, 100));
            });

        page.Footer()
            .AlignCenter()
            .Text(x =>
            {
                x.Span("Page ");
                x.CurrentPageNumber();
            });
    });
})
.GeneratePdf("hello.pdf");

上記のコードで生成された PDF の結果：

3.2 テンプレート生成

テンプレートを使用した生成は、3 つのアプリケーション層の作業で構成されます：

ドキュメント Model（PDF ドキュメントの内容を記述する一連のクラス）
データソース（ドメインエンティティをドキュメントモデルにマッピングする層）
テンプレート（情報を可視化し、PDF ファイルに変換する方法を記述するプレゼンテーション層）

例えば、基本的な請求書情報を設計する場合、購入リスト、売り手と買い手の住所、請求書番号などを設計します。次のような 3 つの Model クラスを設計します：

public class InvoiceModel
{
    public int InvoiceNumber { get; set; }
    public DateTime IssueDate { get; set; }
    public DateTime DueDate { get; set; }

    public Address SellerAddress { get; set; }
    public Address CustomerAddress { get; set; }

    public List<OrderItem> Items { get; set; }
    public string Comments { get; set; }
}

public class OrderItem
{
    public string Name { get; set; }
    public decimal Price { get; set; }
    public int Quantity { get; set; }
}

public class Address
{
    public string CompanyName { get; set; }
    public string Street { get; set; }
    public string City { get; set; }
    public string State { get; set; }
    public object Email { get; set; }
    public string Phone { get; set; }
}

Model を定義した後、ダミーデータを定義して PDF を埋めます：

public static class InvoiceDocumentDataSource
{
    private static Random Random = new Random();

    public static InvoiceModel GetInvoiceDetails()
    {
        var items = Enumerable
            .Range(1, 8)
            .Select(i => GenerateRandomOrderItem())
            .ToList();

        return new InvoiceModel
        {
            InvoiceNumber = Random.Next(1_000, 10_000),
            IssueDate = DateTime.Now,
            DueDate = DateTime.Now + TimeSpan.FromDays(14),

            SellerAddress = GenerateRandomAddress(),
            CustomerAddress = GenerateRandomAddress(),

            Items = items,
            Comments ="テスト用備考"
        };
    }

    private static OrderItem GenerateRandomOrderItem()
    {
        return new OrderItem
        {
            Name = "商品",
            Price = (decimal)Math.Round(Random.NextDouble() * 100, 2),
            Quantity = Random.Next(1, 10)
        };
    }

    private static Address GenerateRandomAddress()
    {
        return new Address
        {
            CompanyName = "テスト店舗",
            Street = "テスト通り",
            City = "テスト都市",
            State = "テスト状態",
            Email = "テストメール",
            Phone = "テスト電話"
        };
    }
}

次に、テンプレートのスキャフォールディングを構築します。テンプレートのスキャフォールディングを使用するには、IDocument インターフェースを実装する新しいクラスを定義することから始めます。

このインターフェースには 2 つのメソッドが含まれています：

DocumentMetadata GetMetadata();
void Compose(IDocumentContainer container);

最初のメソッドはテンプレートドキュメントの基本情報、2 つ目はテンプレートのコンテナです。これらの原則に基づいてテンプレート層クラスを設計します：

 public class InvoiceDocument : IDocument
{
    public InvoiceModel Model { get; }

    public InvoiceDocument(InvoiceModel model)
    {
        Model = model;
    }

    public DocumentMetadata GetMetadata() => DocumentMetadata.Default;

    public void Compose(IDocumentContainer container)
    {
        container
            .Page(page =>
            {
                page.PageColor(Colors.Red.Lighten1);
                page.Size(PageSizes.A4);
                page.Margin(10);// マージン

                page.Header().Height(100).Background(Colors.LightBlue.Lighten1);
                page.Content().Background(Colors.Grey.Lighten3);
                page.Footer().Height(50).Background(Colors.Grey.Lighten1);
            });
    }
}

PDF のページには常にヘッダー、フッター、コンテンツの 3 つの要素があります。生成されたドキュメントを確認してみましょう：

ここまでで、各セクションが異なる色やサイズを持つ非常にシンプルなページを構築しました。

次に、そのヘッダーを埋めていきます。データソースを整理したら、Element メソッドを呼び出して埋めます：

public void Compose(IDocumentContainer container)
{
    container
        .Page(page =>
        {
            page.PageColor(Colors.Red.Lighten1);
            page.Size(PageSizes.A4);
            page.Margin(10);// マージン

            page.Header().Height(100).Background(Colors.LightBlue.Lighten1).Element(ComposeHeader);
            page.Content().Background(Colors.Grey.Lighten3);
            page.Footer().Height(50).Background(Colors.Grey.Lighten1);
        });
}

void ComposeHeader(IContainer container)
{
    var titleStyle = TextStyle.Default.FontSize(20).SemiBold().FontColor(Colors.Blue.Medium);

    container.Row(row =>
    {
        row.RelativeItem().Column(column =>
        {
            column.Item().Text($"請求書 #{Model.InvoiceNumber}").FontFamily("simhei").Style(titleStyle);

            column.Item().Text(text =>
            {
                text.Span("発行日: ").SemiBold().FontFamily("simhei");
                text.Span($"{Model.IssueDate:d}").FontFamily("simhei");
            });

            column.Item().Text(text =>
            {
                text.Span("支払期日: ").FontFamily("simhei").SemiBold();
                text.Span($"{Model.DueDate:d}").FontFamily("simhei");
            });

        });

    });
}

最後にコンテンツを実装します：

public void Compose(IDocumentContainer container)
{
    container
        .Page(page =>
        {
            page.PageColor(Colors.Red.Lighten1);
            page.Size(PageSizes.A4);
            page.Margin(10);// マージン

            page.Header().Height(100).Background(Colors.LightBlue.Lighten1).Element(ComposeHeader);
            page.Content().Background(Colors.Grey.Lighten3).Element(ComposeContent);
            page.Footer().Height(50).Background(Colors.Grey.Lighten1);
        });
}

void ComposeHeader(IContainer container)
{
    var titleStyle = TextStyle.Default.FontSize(20).SemiBold().FontColor(Colors.Blue.Medium);

    container.Row(row =>
    {
        row.RelativeItem().Column(column =>
        {
            column.Item().Text($"請求書 #{Model.InvoiceNumber}").FontFamily("simhei").Style(titleStyle);

            column.Item().Text(text =>
            {
                text.Span("発行日: ").SemiBold().FontFamily("simhei");
                text.Span($"{Model.IssueDate:d}").FontFamily("simhei");
            });

            column.Item().Text(text =>
            {
                text.Span("支払期日: ").FontFamily("simhei").SemiBold();
                text.Span($"{Model.DueDate:d}").FontFamily("simhei");
            });

        });

    });
}

void ComposeContent(IContainer container)
{
    container.Table(table =>
    {
        // ステップ 1
        table.ColumnsDefinition(columns =>
        {
            columns.ConstantColumn(25);
            columns.RelativeColumn(3);
            columns.RelativeColumn();
            columns.RelativeColumn();
            columns.RelativeColumn();
        });

        // ステップ 2
        table.Header(header =>
        {
            header.Cell().Text("#").FontFamily("simhei");
            header.Cell().Text("商品").FontFamily("simhei");
            header.Cell().AlignRight().Text("価格").FontFamily("simhei");
            header.Cell().AlignRight().Text("数量").FontFamily("simhei");
            header.Cell().AlignRight().Text("合計").FontFamily("simhei");

            header.Cell().ColumnSpan(5)
                .PaddingVertical(5).BorderBottom(1).BorderColor(Colors.Black);
        });

        // ステップ 3
        foreach (var item in Model.Items)
        {
            table.Cell().Element(CellStyle).Text(Model.Items.IndexOf(item) + 1).FontFamily("simhei");
            table.Cell().Element(CellStyle).Text(item.Name).FontFamily("simhei");
            table.Cell().Element(CellStyle).AlignRight().Text($"{item.Price}$").FontFamily("simhei");
            table.Cell().Element(CellStyle).AlignRight().Text(item.Quantity).FontFamily("simhei");
            table.Cell().Element(CellStyle).AlignRight().Text($"{item.Price * item.Quantity}$").FontFamily("simhei");

            static IContainer CellStyle(IContainer container)
            {
                return container.BorderBottom(1).BorderColor(Colors.Grey.Lighten2).PaddingVertical(5);
            }
        }
    });
}

これらの準備が完了したら、PDF ドキュメントを生成できます：

var filePath = "invoice.pdf";

var model = InvoiceDocumentDataSource.GetInvoiceDetails();
var document = new InvoiceDocument(model);
document.GeneratePdf(filePath);

4. まとめ

もちろん他にも楽しい機能がたくさんあります。今日はコンセプトをお伝えして、このライブラリについての印象を持っていただくことを目的としています。今後もこのライブラリの関連機能を発信していきます。もしこのライブラリに興味があれば、ぜひフォローしてください！WeChat 公式アカウント【黑哥聊 dotNet】

C#/.NetでAsposeやiTextSharpはもう使わないで！QuestPDFを使えばPDF生成がより速く効率的！

1. QuestPDF について

2. インストール

3. 例

3.1 簡単な例

3.2 テンプレート生成

4. まとめ

関連読書

C#でPDFファイルを画像に変換する

CodeWF.Markdown：PDFテキストはコピー可能、画像は埋め込み可能。WeChat公式アカウント/知乎/掘金にコピーしてもHTMLソースが表示されない

各OSバージョンの.NETサポート状況（250707更新）

.NETクロスプラットフォームネイティブライブラリ導入実践