FieldとProperty C#（開発者向けの仕組み）

フィールドとは何ですか？

フィールドは、クラスまたは構造体に直接宣言される変数です。 フィールドは通常、データを直接格納するために使用され、単純ですがカプセル化と制御に関してはリスクがあります。

public class DocumentSettings
{
    public string headerText; // フィールド
}

public class DocumentSettings
{
    public string headerText; // フィールド
}

IRON VB CONVERTER ERROR developers@ironsoftware.com

フィールドは高速で軽量ですが、アクセス修飾子、セッターメソッド、バリデーションロジックのような保護手段がありません。 そのため、特に外部コードによって直接アクセスされる値の場合は注意が必要です。

プロパティとは何ですか？

C#のプロパティはフィールドへの制御されたインターフェースとして機能します。 プロパティの値を取得または割り当てるための柔軟な方法を提供し、そのgetまたはsetアクセサ内で追加のロジックを許可します。

public class DocumentSettings
{
    public string HeaderText { get; set; } // プロパティ
}

public class DocumentSettings
{
    public string HeaderText { get; set; } // プロパティ
}

IRON VB CONVERTER ERROR developers@ironsoftware.com

プロパティはカプセル化を提供し、IronPDFのようなリフレクションを使用するフレームワークと簡単に統合できるため、公的なデータアクセスに最適です。

フィールドとプロパティの主な違い

特徴

フィールド

プロパティ

カプセル化

なし

はい

裏付けロジック

不可能

get/setを介してサポートされる

リフレクションフレンドリー

信頼性がない

はい

データバインディング

理想的ではない

推奨される

要するに、IronPDFのようにリフレクションやシリアル化に依存するツールを使用している場合は、公的なデータにはプロパティを使用する。

例: PDFエクスポート設定

// フィールド: Might be ignored
public class PdfExportOptions
{
    public string footerHtml; // fields store data directly, but not safely
}
// プロパティ: Recognized and controlled
public class PdfExportOptions
{
    public string FooterHtml { get; set; } // easy to modify, validate, or hide
}

// フィールド: Might be ignored
public class PdfExportOptions
{
    public string footerHtml; // fields store data directly, but not safely
}
// プロパティ: Recognized and controlled
public class PdfExportOptions
{
    public string FooterHtml { get; set; } // easy to modify, validate, or hide
}

IRON VB CONVERTER ERROR developers@ironsoftware.com

IronPDFにおけるシリアル化とデータバインディング

IronPDFのHTMLテンプレーティング、フォームの入力、またはメタデータの挿入などの機能は、リフレクションを介してアクセス可能なため、プロパティに依存しています。 テンプレートにデータを渡す場合やフォームをエクスポートする場合:

• フィールドはすべてスキップされる可能性があります。
• プロパティはデータが正しく取得され、最終的なファイルにレンダリングされることを保証します。

これは、複雑なモデルやユーザー生成データを扱う際に特に重要です。

公開APIとのインタラクションにプロパティを使用する

モデルがIronPDF（または他の外部ライブラリ）によって消費される場合は、安全で維持管理可能なアクセスを確保するために、適切なアクセス修飾子を持つ公開プロパティを使用してください。

public class InvoiceData
{
    public string CustomerName { get; set; }
    public DateTime InvoiceDate { get; set; }
}

public class InvoiceData
{
    public string CustomerName { get; set; }
    public DateTime InvoiceDate { get; set; }
}

Public Class InvoiceData
	Public Property CustomerName() As String
	Public Property InvoiceDate() As DateTime
End Class

これにより、IronPDF（他の.NETライブラリ）もリフレクションとシリアル化で値にアクセス可能になります。

公に宣言されたフィールドは、どこからでも直接変更される可能性があります。

外部コンポーネントやライブラリからデータにアクセスしてほしくない内部ロジックにはフィールドを使用します。

public class InvoiceData
{
    private string internalなしte; // なしt meant for IronPDF
}

public class InvoiceData
{
    private string internalなしte; // なしt meant for IronPDF
}

IRON VB CONVERTER ERROR developers@ironsoftware.com

これはロジックをクリーン、セキュア、予測可能に保つための良いプラクティスです。

プロパティ：より安全で柔軟

プロパティを使用すると、getおよびsetアクセサを使用してデータへのアクセスを制御できます。 このアプローチは：

// プロパティ – safer use of our Person class
public class Person
{
    private string _name;
    public string Name
    {
        get => _name;
        set
        {
            if (string.IsNullOrWhiteSpace(value))
                throw new ArgumentException("Name is required");
            _name = value.Trim();
        }
    }
}

// プロパティ – safer use of our Person class
public class Person
{
    private string _name;
    public string Name
    {
        get => _name;
        set
        {
            if (string.IsNullOrWhiteSpace(value))
                throw new ArgumentException("Name is required");
            _name = value.Trim();
        }
    }
}

IRON VB CONVERTER ERROR developers@ironsoftware.com

このアプローチ：

• 悪いデータが保存されるのを防ぎます。
• アクセスをログに記録したり、ビジネスルールを強制したりするためのフックを提供します。
• アプリケーションの内部状態を保護します。
• IronPDFのようなサードパーティライブラリが、安全かつ予測可能にデータを消費できることを保障します。

公式PDFを生成する際のようなセンシティブなシナリオでは、ユーザーメタデータ、請求書、または監査ログを含む情報があるときに、プロパティを使用することでオブジェクトの出入りを完全に制御できます。

IronPDFは本質的にデータの整合性を"侵害"するわけではありませんが、多くの領域でリフレクションに依存しています。

IronPDFは本質的にあなたのデータの整合性を"侵害"しませんが、多くの領域でリフレクションに依存しています。 * サニタイズされ、検証された値のみを公開するようにしたいです。

• サニタイズされ、検証された値のみを公開することを保証したい。
• データがどのように書き込まれ、読み込まれるかを制御したい。

プロパティを使用すると、このデータフローを制御でき、パブリックフィールドを使用するとアプリケーションが意図しない動作にさらされることになります。

using IronPdf;
using System;
public class PdfMetadata
{
    private string _author;
    public string Author
    {
        get => _author;
        set
        {
            if (string.IsNullOrWhiteSpace(value))
                throw new ArgumentException("Author cannot be empty.");
            _author = value.Trim();
        }
    }
}
class Program
{
    static void Main()
    {
        var metadata = new PdfMetadata
        {
            Author = "Jane Doe"
        };
        var htmlContent = $@"
            <html>
                <head><title>Secure PDF</title></head>
                <body>
                    <h1>PDF Generated with IronPDF</h1>
                    <p>Author: {metadata.Author}</p>
                </body>
            </html>";
        var renderer = new HtmlToPdf();
        var pdfDoc = renderer.RenderHtmlAsPdf(htmlContent);
        // Set metadata
        pdfDoc.MetaData.Author = metadata.Author;
        pdfDoc.MetaData.Title = "Secure PDF Report";
        // Save to disk
        pdfDoc.SaveAs("SecureOutput.pdf");
        Console.WriteLine("PDF generated successfully: SecureOutput.pdf");
    }
}

using IronPdf;
using System;
public class PdfMetadata
{
    private string _author;
    public string Author
    {
        get => _author;
        set
        {
            if (string.IsNullOrWhiteSpace(value))
                throw new ArgumentException("Author cannot be empty.");
            _author = value.Trim();
        }
    }
}
class Program
{
    static void Main()
    {
        var metadata = new PdfMetadata
        {
            Author = "Jane Doe"
        };
        var htmlContent = $@"
            <html>
                <head><title>Secure PDF</title></head>
                <body>
                    <h1>PDF Generated with IronPDF</h1>
                    <p>Author: {metadata.Author}</p>
                </body>
            </html>";
        var renderer = new HtmlToPdf();
        var pdfDoc = renderer.RenderHtmlAsPdf(htmlContent);
        // Set metadata
        pdfDoc.MetaData.Author = metadata.Author;
        pdfDoc.MetaData.Title = "Secure PDF Report";
        // Save to disk
        pdfDoc.SaveAs("SecureOutput.pdf");
        Console.WriteLine("PDF generated successfully: SecureOutput.pdf");
    }
}

Imports IronPdf
Imports System
Public Class PdfMetadata
	Private _author As String
	Public Property Author() As String
		Get
			Return _author
		End Get
		Set(ByVal value As String)
			If String.IsNullOrWhiteSpace(value) Then
				Throw New ArgumentException("Author cannot be empty.")
			End If
			_author = value.Trim()
		End Set
	End Property
End Class
Friend Class Program
	Shared Sub Main()
		Dim metadata = New PdfMetadata With {.Author = "Jane Doe"}
		Dim htmlContent = $"
            <html>
                <head><title>Secure PDF</title></head>
                <body>
                    <h1>PDF Generated with IronPDF</h1>
                    <p>Author: {metadata.Author}</p>
                </body>
            </html>"
		Dim renderer = New HtmlToPdf()
		Dim pdfDoc = renderer.RenderHtmlAsPdf(htmlContent)
		' Set metadata
		pdfDoc.MetaData.Author = metadata.Author
		pdfDoc.MetaData.Title = "Secure PDF Report"
		' Save to disk
		pdfDoc.SaveAs("SecureOutput.pdf")
		Console.WriteLine("PDF generated successfully: SecureOutput.pdf")
	End Sub
End Class

Output

このコードがすること

• サニタイズされたプロパティを持つPdfMetadataクラスを作成します。

• サニタイズされたプロパティを持つPdfMetadataクラスを作成します。
• サニタイズされた著者データをHTMLコンテンツとPDFメタデータの両方に注入します。
• サニタイズされた著者データをHTMLコンテンツとPDFメタデータの両方に注入します。