Field vs Property C# (How it Works for Developers)

什麼是欄位？

欄位是直接在類別或結構中聲明的變數。 欄位通常用於直接儲存資料，這使得它們簡單但在封裝和控制方面存在風險。

public class DocumentSettings
{
    public string headerText; // 欄位
}

public class DocumentSettings
{
    public string headerText; // 欄位
}

Public Class DocumentSettings
    Public headerText As String ' 欄位
End Class

欄位速度快且輕量，但缺乏接入修飾符、設定器方法或驗證邏輯等保護措施。 因此，當值被外部程式碼直接存取時，應謹慎使用它們。

什麼是屬性？

C#中的屬性作為欄位的控制介面。 它提供了一種靈活的方式來檢索或分配屬性值，同時允許在其get或set存取器中增加額外的邏輯。

public class DocumentSettings
{
    public string HeaderText { get; set; } // 屬性
}

public class DocumentSettings
{
    public string HeaderText { get; set; } // 屬性
}

Public Class DocumentSettings
    Public Property HeaderText As String ' 屬性
End Class

屬性非常適合公有資料存取，因為它們提供了封裝，並能夠輕鬆地整合使用反射的框架，如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
}

' 欄位: Might be ignored
Public Class PdfExportOptions
    Public footerHtml As String ' fields store data directly, but not safely
End Class

' 屬性: Recognized and controlled
Public Class PdfExportOptions
    Public Property FooterHtml As String ' easy to modify, validate, or hide
End Class

IronPDF中的序列化與資料綁定

像HTML模板、表單填寫或元資料插入這樣的IronPDF特性依賴於屬性，因為它們可以通過反射存取。 如果您正在將資料傳遞給模板或匯出表單：

• 欄位可能完全被略過。
• 屬性確保資料正確地檢索並呈現在最終的文件中。

這在處理複雜模型或使用者生成的資料時尤其重要。

使用屬性進行公共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
}

Public Class InvoiceData
    Private internal否te As String ' 否t meant for IronPDF
End Class

這是一個良好的做法，保持您的邏輯清晰、安全和可預測。

欄位：不安全，控制較弱

欄位直接暴露資料，沒有任何邏輯或防護措施。 當您聲明一個公有欄位時，您開放了這個數值，允許應用程式內的任何地方——甚至是外部庫——直接修改。

// 欄位 – no protection
public class Person
{
    public string name;
}

// 欄位 – no protection
public class Person
{
    public string name;
}

' 欄位 – no protection
Public Class Person
    Public name As String
End Class

在這種設定下：

• 任何人可以無限制地讀寫名稱值。
• 您無法攔截更改以進行驗證、日誌記錄或清理。
• 像IronPDF這樣的庫可以在意外的方式下消耗或覆蓋這些資料，如果被錯誤使用的話。

這種缺乏控制可能會比預期的更像是一個安全風險，尤其是在處理使用者輸入、生成動態文件或跨邊界暴露內部物件時（例如通過API、序列化或Razor模板）。

屬性：更安全，更具靈活性

屬性允許您使用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();
        }
    }
}

' 屬性 – safer use of our Person class
Public Class Person
    Private _name As String
    Public Property Name As String
        Get
            Return _name
        End Get
        Set(value As String)
            If String.IsNullOrWhiteSpace(value) Then
                Throw New ArgumentException("Name is required")
            End If
            _name = value.Trim()
        End Set
    End Property
End Class

這種方法：

• 防止不良資料被儲存。
• 為您提供鉤子來記錄存取或強制執行業務規則。
• 保護應用程式的內部狀態。
• 確保任何第三方程式庫（如IronPDF）可以安全且可預測地消耗您的資料。

在敏感場景下——如使用者元資料、發票或審計日誌生成官方PDF時——使用屬性讓您完全控制流入和流出物件的內容。

這對IronPDF有何意義

IronPDF本身並不會"違反"您的資料完整性，但它確實依賴於反射的許多方面。 如果您將資料模型傳入Razor模板、元資料欄位或匯出配置：

• 您想確保只有經過清理、驗證的數值被暴露。
• 您想控制資料的讀寫方式。

使用屬性允許您控制這個流程，而公有欄位則讓您的應用程式更容易受到未預期行為的影響。

此程式碼的作用

• 建立一個具有清理屬性的PdfMetadata類。
• 使用ChromePdfRenderer渲染基本HTML模板。
• 將清理過的作者資料注入到HTML內容和PDF元資料中。
• 將最終輸出保存為SecureOutput.pdf。