Archive. Posts from 2004 to 2016, kept as they were written. My current blog is at dariuszparys.com.

Partial Methods sind ein neues Sprachfeatures in C# 3.0, damit aus Visual Studio 2008 und dem .NET Framework 3.5 benutzbar. Partial Methods erlaubt es einer Partial Class eine Methode zu implementieren die später von einer weiteren Partial Class Implementierung konsumiert werden kann.

Ein kleines Beispiel macht es einfacher den Einsatz von Partial Methods zu veranschaulichen. Nehmen wir an wir hätten eine Klasse Person. Die Klasse besitzt eine Eigenschaft Lastname. Die Klasse ist Partial gekennzeichnet und lässt sich somit durch eine weitere Partial Class Person erweitern.

public partial class Person
{
    private string lastname;
    public string Lastname
    {
        get
        {
            return this.lastname;
        }

        set
        {
            this.lastname = value;
        }
    }

    partial void LastnameChanging( string value );
    partial void LastnameChanged( string oldValue, string newValue );
}

In Zeile 17 und 18 sind die beiden Partial Methods LastnameChanging und LastnameChanged definiert.

Diese beiden Methodensignaturen werden nun im Setter von Lastname verwendet. Das sieht dann wie folgt aus:

set
{
    LastnameChanging( value );
    string oldValue = this.lastname;
    this.lastname = value;
    LastnameChanged( oldValue, value );
}

Bevor nun die Eigenschaft Lastname gesetzt und damit verändert wird, ruft der Setter entsprechend die LastnameChanging Methode auf und übergibt den neuen Wert. In Zeile 6 wird nun die LastnameChanged Methode aufgerufen und übergibt beide Werte.

Was kann man damit nun machen? Implementiert man nun eine weitere Partial Class, hat man die Möglichkeit auf die Partial Methods zu reagieren und dementsprechend Logik hinzuzufügen. Im unteren Beispiel wird einfach bei LastnameChanging geprüft ob der Wert "hello" entspricht und dann eine Exception geworfen.

public partial class Person
{
    partial void LastnameChanging( string value )
    {
        if( value == "hello" )
        {
            throw new ApplicationException( "This value is not allowed" );
        }
    }

    partial void LastnameChanged( string oldValue, string newValue )
    {
        // do some logging here
    }
}

Partial Methods sind eingeführt worden um die Codegenerierten Partial Class Definitionen diverser Tools um eigene Logik zu erweitern.

So wird zum Beispiel bei LINQ to SQL die Änderungen an den Objekten weitergegeben und ermöglicht es eigene Validierungslogik zu implementieren.

Beim TechTalk in Karlsruhe kam gestern die Frage auf was passiert wenn die Methode definiert ist und aufgerufen wird, jedoch kein Konsument die Implementierung der Signatur vornimmt, wird dann nicht der Compiler meckern?

Der Compiler generiert die Methoden nur wenn diese wirklich konsumiert werden. Benutzt der Setter also eine LastnameChanging Methode so wird diese nur in IL geschrieben wenn eine weitere Partial Class diese Methode auch implementiert.

Hier ein Auszug aus Reflector des Beispiels nur mit der LastnameChanging Methode konsumiert.

shot1

LastnameChanged ist im zwar im Sourcecode definiert und wird benutzt, jedoch ist der Compiler intelligent genug kein IL dafür zu produzieren.