C# Ref (Jak to działa dla programistów)

Zrozumienie parametrów ref

Parametr ref jest parametrem metody, który działa jako odwołanie do zmiennej przekazanej do metody. W przeciwieństwie do standardowych parametrów wartości, w których przekazywana jest tylko kopia zmiennej, parametry ref pozwalają wywołanej metodzie modyfikować wartość oryginalnej zmiennej. Takie zachowanie ma kluczowe znaczenie, gdy potrzebna jest metoda do aktualizacji stanu przekazanych do niej zmiennych.

Rozważmy poniższy przykład ilustrujący podstawowe zastosowanie ref, skupiając się na tym, jak zmienna typu referencyjnego zachowuje wartość parametru w tym samym obiekcie podczas wywołań metod:

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
    }
}

Friend Class Program
	Shared Sub Main()
		Dim number As Integer = 100
		ModifyNumber(number)
		Console.WriteLine(number) ' Output: 200
	End Sub

	' Method that modifies the original number through 'ref'
	Private Shared Sub ModifyNumber(ByRef number As Integer)
		number = 200 ' Modifies the original value
	End Sub
End Class

W tym przykładzie metoda Main deklaruje liczbę całkowitą number i inicjuje ją na 100. Następnie wywołuje ModifyNumber, przekazując number jako parametr ref. Wewnątrz ModifyNumber wartość number zostaje zmieniona na 200. Ponieważ number jest przekazywane przez referencję, zmiana jest odzwierciedlona w pierwotnej wartości w metodzie Main, a 200 jest wyświetlane w konsoli.

Jak działają parametry ref

Deklarując parametr metody za pomocą słowa kluczowego ref, informujesz kompilator, że parametr będzie odwoływał się do oryginalnej zmiennej, a nie do jej kopii. Osiąga się to poprzez przekazywanie adresu pamięci zmiennej, a nie jej rzeczywistej wartości. Zarówno metoda wywoływana, jak i metoda wywołująca mają dostęp do tej samej lokalizacji w pamięci, co oznacza, że wszelkie zmiany wprowadzone w parametrze są wprowadzane bezpośrednio do oryginalnej zmiennej.

Kluczem do zrozumienia ref jest uświadomienie sobie, że można go używać zarówno z typami wartości, jak i typami referencyjnymi. Typy wartości obejmują proste typy danych, takie jak liczby całkowite i struktury, natomiast typy referencyjne obejmują obiekty i tablice. Jednak mimo że zmienne typu referencyjnego z natury przechowują adresy pamięci, użycie ref z typami referencyjnymi pozwala modyfikować rzeczywiste odwołanie, a nie tylko zawartość obiektu.

Różnice między ref a out

Chociaż zarówno ref, jak i out pozwalają na modyfikację oryginalnych zmiennych, istnieją między nimi istotne różnice. Parametr out nie wymaga inicjalizacji przed przekazaniem do metody. Z drugiej strony parametr ref wymaga, aby zmienna została zainicjowana przed jej przekazaniem. Ponadto metoda wykorzystująca parametr out musi przypisać wartość przed zakończeniem działania. Wymóg ten nie dotyczy parametrów ref.

Oto przykładowe zastosowanie słowa kluczowego 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
    }
}

Friend Class Program
	Shared Sub Main()
		Dim result As Integer = Nothing
		CalculateResult(result)
		Console.WriteLine(result) ' Output: 100
	End Sub

	' Method that calculates a result and assigns it via 'out'
	Private Shared Sub CalculateResult(ByRef calculation As Integer)
		calculation = 20 * 5 ' Must initialize the out parameter
	End Sub
End Class

W tym przypadku CalculateResult inicjuje calculation w ramach metody, a Main odzwierciedla wynik.

Praktyczne zastosowanie ref w przeciążaniu metod

ref może być również używane w przeciążaniu metod, gdzie sygnatura metody jest modyfikowana przez słowo kluczowe ref. Sygnatury metod składają się z nazwy metody i typów jej parametrów, w tym informacji o tym, czy parametry są przekazywane przez odwołanie (ref), przez wartość, czy jako parametr out.

Rozważ przeciążenie metod w oparciu o ref i parametry wartości:

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++;
    }
}

Friend Class Program
	Shared Sub Main()
		Dim normalParameter As Integer = 10, refParameter As Integer = 10
		IncrementValue(normalParameter)
		IncrementValue(refParameter)
		Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}") ' Output: Normal: 10, Ref: 11
	End Sub

	' Method that increments a copy of the integer
'INSTANT VB TODO TASK: VB does not allow method overloads which differ only in parameter ByVal/ByRef:
'ORIGINAL LINE: static void IncrementValue(int number)
	Private Shared Sub IncrementValue(ByVal number As Integer)
		number += 1
	End Sub

	' Method that increments the original integer using 'ref'
'INSTANT VB TODO TASK: VB does not allow method overloads which differ only in parameter ByVal/ByRef:
'ORIGINAL LINE: static void IncrementValue(ref int number)
	Private Shared Sub IncrementValue(ByRef number As Integer)
		number += 1
	End Sub
End Class

W tym przypadku IncrementValue jest przeciążona, przy czym jedna wersja przyjmuje parametr normalny, a druga parametr ref. Wersja ref zwiększa wartość oryginalnej zmiennej, podczas gdy wersja standardowa zmienia jedynie jej kopię.

Wprowadzenie do IronPDF

IronPDF for .NET PDF Solutions to kompleksowa biblioteka .NET przeznaczona do pracy z dokumentami PDF. Jest napisany głównie w języku C# i skupia się na upraszczaniu tworzenia i edycji plików PDF na podstawie treści HTML. Dzięki wykorzystaniu silnika renderującego Chrome, IronPDF zapewnia wysokiej jakości dokumenty PDF o idealnej rozdzielczości, które oddają niuanse treści HTML, CSS, JavaScript i obrazów.

Biblioteka ta jest wszechstronna i obsługuje szeroki zakres środowisk .NET, w tym .NET Framework, .NET Core i .NET Standard, dzięki czemu nadaje się do różnych zastosowań, od systemów desktopowych po systemy internetowe. IronPDF nie tylko obsługuje tworzenie plików PDF, ale oferuje również funkcje edycji, zabezpieczania i konwersji plików PDF do innych formatów.

Ta funkcja obejmuje również wyodrębnianie tekstu i obrazów, wypełnianie formularzy, a nawet stosowanie podpisów cyfrowych, zapewniając kompleksową obsługę dokumentów PDF w aplikacjach .NET.

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);
    }
}

Imports IronPdf
Imports System

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		' Set your IronPDF license key
		License.LicenseKey = "License-Key"

		' Initialize the value
		Dim totalSales As Integer = 150

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

		' Use IronPDF to generate a PDF report
		Dim Renderer = New ChromePdfRenderer()
		Dim 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.")
	End Sub

	' Method that adds a monthly bonus to sales using 'ref'
	Private Shared Sub AddMonthlyBonus(ByRef sales As Integer)
		' Assume a bonus of 10% of the sales
		sales += CInt(Math.Truncate(sales * 0.1))
	End Sub
End Class

Wnioski

Zrozumienie słowa kluczowego ref w języku C# stanowi cenne narzędzie do zarządzania sposobem przekazywania danych między metodami. Umożliwiając metodom bezpośrednią modyfikację pierwotnych wartości przekazanych do nich parametrów, ref może sprawić, że Twoje metody będą bardziej elastyczne i wydajne.

W miarę zdobywania doświadczenia z ref lepiej zrozumiesz, kiedy i jak skutecznie z niego korzystać, aby zaspokoić swoje potrzeby programistyczne. IronPDF oferuje bezpłatną wersję próbną, która pozwala zapoznać się z możliwościami obsługi plików PDF, a ceny zaczynają się od $799.