C# Virtual-Schlüsselwort (Funktionsweise für Entwickler)

Grundlegende Verwendung des virtuellen Schlüsselworts

Im Wesentlichen ist eine virtuelle Methode eine Basisklassenmethode, die es abgeleiteten Klassen ermöglicht, eine spezifische Implementierung für Methoden bereitzustellen, die bereits in der Basisklasse definiert sind.

Das virtuelle Schlüsselwort in C# kennzeichnet eine Methode, Eigenschaft oder ein Ereignis als virtuell, was signalisiert, dass es in jeder Klasse, die davon erbt, überschrieben werden kann. Betrachten wir das folgende Beispiel, in dem wir eine Basisklasse Shape mit einer virtuellen Methode Area definieren:

public class Shape
{
    public virtual double Area()
    {
        return 0; // Default implementation, returns 0
    }
}

public class Shape
{
    public virtual double Area()
    {
        return 0; // Default implementation, returns 0
    }
}

Public Class Shape
	Public Overridable Function Area() As Double
		Return 0 ' Default implementation, returns 0
	End Function
End Class

Virtuelle Methoden außer Kraft setzen

Abgeleitete Klassen können diese virtuellen Methoden überschreiben, um ihre eigene Implementierung bereitzustellen, die auf die spezifischen Anforderungen der abgeleiteten Klasse zugeschnitten ist. Mit dem override-Schlüsselwort erstellen wir eine Circle-Klasse, die von Shape abgeleitet ist und ihre eigene Version der Area-Methode bereitstellt:

public class Circle : Shape
{
    public double Radius { get; set; }

    public Circle(double radius)
    {
        Radius = radius;
    }

    public override double Area()
    {
        // Own implementation for circle area
        return Math.PI * Radius * Radius; 
    }
}

public class Circle : Shape
{
    public double Radius { get; set; }

    public Circle(double radius)
    {
        Radius = radius;
    }

    public override double Area()
    {
        // Own implementation for circle area
        return Math.PI * Radius * Radius; 
    }
}

Public Class Circle
	Inherits Shape

	Public Property Radius() As Double

	Public Sub New(ByVal radius As Double)
		Me.Radius = radius
	End Sub

	Public Overrides Function Area() As Double
		' Own implementation for circle area
		Return Math.PI * Radius * Radius
	End Function
End Class

Im obigen Code stellt die Circle-Klasse ihre spezifische Implementierung der Area-Methode bereit, die die Fläche eines Kreises berechnet. Dies demonstriert die Leistungsfähigkeit von virtuellen Methoden im Polymorphismus.

Nichtvirtuelle Methoden

Es ist wichtig zu beachten, dass nicht alle Methoden virtuell sein müssen oder sollten. Eine nicht-virtuelle Methode wird so definiert, dass sie in abgeleiteten Klassen nicht überschrieben werden kann, was bedeutet, dass die ursprüngliche Implementierung unverändert bleibt und von allen Klassen genutzt wird, die davon erben. Dies ist nützlich, wenn eine Basisklasse eine Standardimplementierung bereitstellt, die nicht verändert werden sollte.

Praktische Anwendung

Lassen Sie uns diese Konzepte in einem praktischen Szenario umsetzen. Betrachten Sie das folgende Programm, das unsere Shape- und Circle-Klassen verwendet:

public class Program
{
    public static void Main(string[] args)
    {
        Shape myShape = new Shape();
        Shape myCircle = new Circle(5);

        // Display the area calculation of the default and overridden methods.
        Console.WriteLine($"Shape area: {myShape.Area()}");
        Console.WriteLine($"Circle area: {myCircle.Area()}");
    }
}

public class Program
{
    public static void Main(string[] args)
    {
        Shape myShape = new Shape();
        Shape myCircle = new Circle(5);

        // Display the area calculation of the default and overridden methods.
        Console.WriteLine($"Shape area: {myShape.Area()}");
        Console.WriteLine($"Circle area: {myCircle.Area()}");
    }
}

Public Class Program
	Public Shared Sub Main(ByVal args() As String)
		Dim myShape As New Shape()
		Dim myCircle As Shape = New Circle(5)

		' Display the area calculation of the default and overridden methods.
		Console.WriteLine($"Shape area: {myShape.Area()}")
		Console.WriteLine($"Circle area: {myCircle.Area()}")
	End Sub
End Class

Das obige Beispielprogramm zeigt den Polymorphismus in Aktion und das Wesen der virtuellen Funktion. Obwohl myCircle als Shape deklariert ist, ruft es die überschreibene Area-Methode aus der Circle-Klasse auf und zeigt den dynamischen Dispatch-Mechanismus an, der durch die Schlüsselwörter virtual und override ermöglicht wird.

Abstrakte Methoden und Klassen

Abstrakte Methoden sind ein weiterer Schritt und werden in abstrakten Klassen verwendet. Eine abstrakte Methode ist eine in der Basisklasse deklarierte Methode ohne Implementierung und muss in abgeleiteten Klassen überschrieben werden. Sie zwingt abgeleitete Klassen, eine Implementierung für die abstrakte Methode bereitzustellen und stellt eine konsistente Schnittstelle sicher, während sie für jedes abgeleitete Klassen eine angepasste Funktionalität zulässt.

Methodenüberladung vs. Überschreibung

Es ist auch wichtig, den Unterschied zwischen Methodenüberladung und -überschreibung zu verstehen. Methodenüberladung tritt innerhalb derselben Klasse auf und ermöglicht mehr als einer Methode denselben Namen, jedoch mit unterschiedlichen Parametern zu haben. Methodenüberschreibung, unterstützt durch die Schlüsselwörter virtual und override, ermöglicht es einer abgeleiteten Klasse, eine andere Implementierung für eine in der Basisklasse definierte Methode bereitzustellen.

Virtuelle Eigenschaften und Ereignisse

Neben Methoden können auch Eigenschaften und Ereignisse virtuell sein. Dies ermöglicht es abgeleiteten Klassen, benutzerdefinierte Getter, Setter und Ereignishandler bereitzustellen und die Flexibilität von Klassenhierarchien weiter zu verbessern.

Beispiel: PDF-Rendering mit virtuellen Methoden anpassen

Stellen Sie sich vor, Sie haben eine Basisklasse, die IronPDF verwendet, um PDFs aus HTML-Strings darzustellen. Indem die Darstellungsmethode als virtuell markiert wird, ermöglichen Sie abgeleiteten Klassen, den Darstellungsprozess zu ändern oder zu verbessern. Hier ist ein einfaches Beispiel:

public class BasicPdfRenderer
{
    // Virtual method allowing customization in derived classes
    public virtual byte[] RenderHtmlToPdf(string htmlContent)
    {
        // Use IronPDF to render PDF from HTML
        var renderer = new IronPdf.ChromePdfRenderer();
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlContent);
        return pdfDocument.BinaryData;
    }
}

public class CustomPdfRenderer : BasicPdfRenderer
{
    // Overriding the base class method to implement custom rendering settings
    public override byte[] RenderHtmlToPdf(string htmlContent)
    {
        var renderer = new IronPdf.ChromePdfRenderer();
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlContent);

        // Apply a prominent watermark to the PDF document
        pdfDocument.ApplyWatermark("<h2 style='color:red; font-size: 60px; opacity: 0.5; text-shadow: 2px 2px 5px grey;'>SAMPLE</h2>",
                                   30,
                                   IronPdf.Editing.VerticalAlignment.Middle,
                                   IronPdf.Editing.HorizontalAlignment.Center);

        // Return the binary data of the PDF document
        return pdfDocument.BinaryData;
    }
}

class Program
{
    static void Main(string[] args)
    {
        License.LicenseKey = "License-Key";

        // HTML content to be converted to PDF
        string htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a simple PDF document generated from HTML.</p>";

        // Create an instance of CustomPdfRenderer
        CustomPdfRenderer renderer = new CustomPdfRenderer();

        // Call RenderHtmlToPdf method to generate PDF binary data
        byte[] pdfData = renderer.RenderHtmlToPdf(htmlContent);

        // Specify the file path to save the PDF
        string filePath = "f:\\CustomRenderedPdf.pdf";

        // Save the binary data to a file
        File.WriteAllBytes(filePath, pdfData);

        // Output success message
        Console.WriteLine($"PDF generated and saved to {filePath}");
    }
}

public class BasicPdfRenderer
{
    // Virtual method allowing customization in derived classes
    public virtual byte[] RenderHtmlToPdf(string htmlContent)
    {
        // Use IronPDF to render PDF from HTML
        var renderer = new IronPdf.ChromePdfRenderer();
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlContent);
        return pdfDocument.BinaryData;
    }
}

public class CustomPdfRenderer : BasicPdfRenderer
{
    // Overriding the base class method to implement custom rendering settings
    public override byte[] RenderHtmlToPdf(string htmlContent)
    {
        var renderer = new IronPdf.ChromePdfRenderer();
        var pdfDocument = renderer.RenderHtmlAsPdf(htmlContent);

        // Apply a prominent watermark to the PDF document
        pdfDocument.ApplyWatermark("<h2 style='color:red; font-size: 60px; opacity: 0.5; text-shadow: 2px 2px 5px grey;'>SAMPLE</h2>",
                                   30,
                                   IronPdf.Editing.VerticalAlignment.Middle,
                                   IronPdf.Editing.HorizontalAlignment.Center);

        // Return the binary data of the PDF document
        return pdfDocument.BinaryData;
    }
}

class Program
{
    static void Main(string[] args)
    {
        License.LicenseKey = "License-Key";

        // HTML content to be converted to PDF
        string htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a simple PDF document generated from HTML.</p>";

        // Create an instance of CustomPdfRenderer
        CustomPdfRenderer renderer = new CustomPdfRenderer();

        // Call RenderHtmlToPdf method to generate PDF binary data
        byte[] pdfData = renderer.RenderHtmlToPdf(htmlContent);

        // Specify the file path to save the PDF
        string filePath = "f:\\CustomRenderedPdf.pdf";

        // Save the binary data to a file
        File.WriteAllBytes(filePath, pdfData);

        // Output success message
        Console.WriteLine($"PDF generated and saved to {filePath}");
    }
}

Public Class BasicPdfRenderer
	' Virtual method allowing customization in derived classes
	Public Overridable Function RenderHtmlToPdf(ByVal htmlContent As String) As Byte()
		' Use IronPDF to render PDF from HTML
		Dim renderer = New IronPdf.ChromePdfRenderer()
		Dim pdfDocument = renderer.RenderHtmlAsPdf(htmlContent)
		Return pdfDocument.BinaryData
	End Function
End Class

Public Class CustomPdfRenderer
	Inherits BasicPdfRenderer

	' Overriding the base class method to implement custom rendering settings
	Public Overrides Function RenderHtmlToPdf(ByVal htmlContent As String) As Byte()
		Dim renderer = New IronPdf.ChromePdfRenderer()
		Dim pdfDocument = renderer.RenderHtmlAsPdf(htmlContent)

		' Apply a prominent watermark to the PDF document
		pdfDocument.ApplyWatermark("<h2 style='color:red; font-size: 60px; opacity: 0.5; text-shadow: 2px 2px 5px grey;'>SAMPLE</h2>", 30, IronPdf.Editing.VerticalAlignment.Middle, IronPdf.Editing.HorizontalAlignment.Center)

		' Return the binary data of the PDF document
		Return pdfDocument.BinaryData
	End Function
End Class

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		License.LicenseKey = "License-Key"

		' HTML content to be converted to PDF
		Dim htmlContent As String = "<h1>Hello, IronPDF!</h1><p>This is a simple PDF document generated from HTML.</p>"

		' Create an instance of CustomPdfRenderer
		Dim renderer As New CustomPdfRenderer()

		' Call RenderHtmlToPdf method to generate PDF binary data
		Dim pdfData() As Byte = renderer.RenderHtmlToPdf(htmlContent)

		' Specify the file path to save the PDF
		Dim filePath As String = "f:\CustomRenderedPdf.pdf"

		' Save the binary data to a file
		File.WriteAllBytes(filePath, pdfData)

		' Output success message
		Console.WriteLine($"PDF generated and saved to {filePath}")
	End Sub
End Class

Wir verwenden IronPDF innerhalb einer BasicPdfRenderer-Klasse, um HTML in PDF zu konvertieren, wobei ihre RenderHtmlToPdf-Methode als virtuell markiert wird, um Anpassungen zu ermöglichen. Die von BasicPdfRenderer abgeleitete CustomPdfRenderer-Klasse überschreibt diese Methode, um nicht nur die Konvertierung durchzuführen, sondern auch ein auffälliges, großes rotes Wasserzeichen über das generierte PDF einzufügen.

Ausgabe PDF-Datei

Dies ist die PDF-Datei, die von IronPDF generiert wurde: