C# Ref (How It Works For Developers)

瞭解 ref 參數

ref 參數是一種方法參數，可作為傳入方法中變數的參照。 ref 參數與標準值參數不同，標準值參數僅傳送變數的副本，而 ref 參數允許被呼叫的方法修改原始變數的值。 當您需要一個方法來更新傳給它的變數的狀態時，這個行為是非常重要的。

請參考以下範例來示範 ref 的基本用法，重點在於 參考類型變數如何在整個方法呼叫過程中，在相同的物件中保留其 參數值：

class Program
{
    static void Main()
    {
        int number = 100;
        ModifyNumber(ref number);
        Console.WriteLine(number); // Output: 200
    }

    // Method that modifies the original number through 'ref'
    static void ModifyNumber(ref int number)
    {
        number = 200; // Modifies the original value
    }
}

class Program
{
    static void Main()
    {
        int number = 100;
        ModifyNumber(ref number);
        Console.WriteLine(number); // Output: 200
    }

    // Method that modifies the original number through 'ref'
    static void ModifyNumber(ref int number)
    {
        number = 200; // Modifies the original value
    }
}

在此示例中，Main 方法声明了一个整数 number，并将其初始化为 100。然後，它呼叫 ModifyNumber 並傳入 number 作為 ref 參數。 在 ModifyNumber 中，number 的值變更為 200。由於 number 是經由參照傳送的，所以這個改變會反映在 Main 方法中的原始值，並且 200 會被列印到控制台。

參考參數如何運作

當您使用 ref 關鍵字宣告一個方法參數時，您是在告訴編譯器該參數將引用原始變數，而不是副本。 這是透過傳送變數的記憶體位址而非實際值來達成的。 被呼叫方法和呼叫方法都會存取相同的記憶體位置，這表示對參數所做的任何變更都會直接變更到原始變數。

理解 ref 的關鍵在於認識到它可以用於值類型和引用類型。值類型包括簡單的資料類型，例如整數和結構體，而參考類型則包括物件和陣列。 然而，儘管參照類型變數本質上持有記憶體位址，但在參照類型中使用 ref 可讓您修改實際的參照，而不僅僅是物件的內容。

ref 與 out 的差異

雖然 ref 和 out 兩個關鍵字都允許修改原始變數，但仍有重要的區別。 out 參數在傳給方法之前不需要初始化。 相反地，ref 參數要求在傳送變數之前先將其初始化。 此外，使用 out 參數的方法有義務在方法回傳前指定一個值。 此要求不適用於 ref 參數。

以下是您可能使用 out 關鍵字的方式：

class Program
{
    static void Main()
    {
        int result;
        CalculateResult(out result);
        Console.WriteLine(result); // Output: 100
    }

    // Method that calculates a result and assigns it via 'out'
    static void CalculateResult(out int calculation)
    {
        calculation = 20 * 5; // Must initialize the out parameter
    }
}

class Program
{
    static void Main()
    {
        int result;
        CalculateResult(out result);
        Console.WriteLine(result); // Output: 100
    }

    // Method that calculates a result and assigns it via 'out'
    static void CalculateResult(out int calculation)
    {
        calculation = 20 * 5; // Must initialize the out parameter
    }
}

在這種情況下，CalculateResult 會初始化方法內的 calculation ，而 Main 則會反映結果。

方法重載中 ref 的實際使用

ref 也可以用在方法重載中，方法簽章會被 ref 關鍵字改變。 方法簽章由方法名稱及其參數類型組成，包括參數是以參照 (ref)、參數值或 out 參數傳送。

考慮基於 ref 和值參數的重載方法：

class Program
{
    static void Main()
    {
        int normalParameter = 10, refParameter = 10;
        IncrementValue(normalParameter);
        IncrementValue(ref refParameter);
        Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}"); // Output: Normal: 10, Ref: 11
    }

    // Method that increments a copy of the integer
    static void IncrementValue(int number)
    {
        number++;
    }

    // Method that increments the original integer using 'ref'
    static void IncrementValue(ref int number)
    {
        number++;
    }
}

class Program
{
    static void Main()
    {
        int normalParameter = 10, refParameter = 10;
        IncrementValue(normalParameter);
        IncrementValue(ref refParameter);
        Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}"); // Output: Normal: 10, Ref: 11
    }

    // Method that increments a copy of the integer
    static void IncrementValue(int number)
    {
        number++;
    }

    // Method that increments the original integer using 'ref'
    static void IncrementValue(ref int number)
    {
        number++;
    }
}

在此，IncrementValue 被重載，其中一個版本使用一般參數，另一個版本使用 ref 參數。 ref 版本會增加原始變數，而一般版本只會變更副本。

IronPDF 簡介

IronPDF for .NET PDF Solutions 是專為處理 PDF 文件而設計的綜合性 .NET 函式庫。 它主要以 C# 建立，著重於簡化 PDFs from HTML content 的建立與操作。 透過採用 Chrome 演算引擎，IronPDF 可提供高品質、像素完美的 PDF 文件，並能捕捉 HTML、CSS、JavaScript 及圖片內容的細微差異。

此程式庫用途廣泛，支援多種 .NET 環境，包括 .NET Framework、.NET Core 和 .NET Standard，因此適用於從桌面系統到網頁系統的各種應用程式。 IronPDF 不僅支援 PDF 的建立，還提供編輯、安全保護以及將 PDF 轉換為其他格式的功能。

此功能可延伸至擷取文字和影像、填寫表單，甚至套用數位簽章，以確保在 .NET 應用程式中全面處理 PDF 文件。

using IronPdf;
using System;

class Program
{
    static void Main(string[] args)
    {
        // Set your IronPDF license key
        License.LicenseKey = "License-Key";

        // Initialize the value
        int totalSales = 150;

        // Modify the value within the method using 'ref'
        AddMonthlyBonus(ref totalSales);

        // Use IronPDF to generate a PDF report
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>");

        // Save the PDF to a file
        PDF.SaveAs("MonthlySalesReport.pdf");

        // Confirm the PDF has been generated
        Console.WriteLine("PDF generated successfully. Check your project directory.");
    }

    // Method that adds a monthly bonus to sales using 'ref'
    static void AddMonthlyBonus(ref int sales)
    {
        // Assume a bonus of 10% of the sales
        sales += (int)(sales * 0.1);
    }
}

using IronPdf;
using System;

class Program
{
    static void Main(string[] args)
    {
        // Set your IronPDF license key
        License.LicenseKey = "License-Key";

        // Initialize the value
        int totalSales = 150;

        // Modify the value within the method using 'ref'
        AddMonthlyBonus(ref totalSales);

        // Use IronPDF to generate a PDF report
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>");

        // Save the PDF to a file
        PDF.SaveAs("MonthlySalesReport.pdf");

        // Confirm the PDF has been generated
        Console.WriteLine("PDF generated successfully. Check your project directory.");
    }

    // Method that adds a monthly bonus to sales using 'ref'
    static void AddMonthlyBonus(ref int sales)
    {
        // Assume a bonus of 10% of the sales
        sales += (int)(sales * 0.1);
    }
}

結論

瞭解 C# 中的 ref 關鍵字，可為管理資料如何在方法之間傳遞提供有價值的工具。 透過允許方法直接修改傳給它們的參數的原始值，ref 可以讓您的方法更靈活、更強大。

當您獲得使用 ref 的經驗後，您將會更了解何時以及如何有效地使用它來滿足您的程式設計需求。 IronPDF 提供 免費試用，讓您開始使用 PDF 功能，定價從 $799 起。