Wann sollten Sie Erweiterungsmethoden für Ihre eigenen Klassen schreiben?

Ich habe kürzlich eine Codebasis gesehen, in der eine Datenklasse Addressirgendwo und dann an einem anderen Ort definiert wurde:

fun Address.toAnschrift() = let { address ->
    Anschrift().apply {
        // mapping code here...
    }
}

Ich fand es verwirrend, diese Methode nicht direkt an der Adresse zu haben. Gibt es etablierte Muster oder Best Practices für die Verwendung von Erweiterungsmethoden? Oder muss das Buch darüber noch geschrieben werden?

Beachten Sie, dass ich trotz der Kotlin-Syntax in meinem Beispiel an allgemeinen Best Practices interessiert bin, da diese auch für C # oder andere Sprachen mit diesen Funktionen gelten würden.

Erweiterungsmethoden bieten nichts, was auf andere Weise nicht möglich ist. Sie sind syntaktischer Zucker, um die Entwicklung zu verbessern, ohne einen tatsächlichen technischen Nutzen zu bieten.

Erweiterungsmethoden sind relativ neu. Standards und Konventionen werden normalerweise von der Meinung der Bevölkerung festgelegt (plus langjähriger Erfahrung darüber, was letztendlich eine schlechte Idee ist), und ich glaube nicht, dass wir an dem Punkt angelangt sind, an dem wir eine endgültige Linie ziehen können, der alle zustimmen.

Ich kann jedoch mehrere Argumente sehen, die auf Dingen basieren, die ich von Kollegen gehört habe.

1. Sie ersetzen normalerweise statische Methoden.

Erweiterungsmethoden basieren am häufigsten auf Dingen, die sonst statische Methoden gewesen wären, nicht auf Klassenmethoden. Sie sehen aus wie Klassenmethoden, sind es aber nicht wirklich.

Erweiterungsmethoden sollten einfach nicht als Alternative für Klassenmethoden betrachtet werden. sondern um ansonsten syntaktisch hässlichen statischen Methoden ein "Klassenverfahren" zu verleihen .

2. Wenn Ihre beabsichtigte Methode spezifisch für ein konsumierendes Projekt ist, jedoch nicht für die Quellbibliothek.

Nur weil Sie sowohl die Bibliothek als auch den Verbraucher entwickeln, bedeutet dies nicht, dass Sie bereit sind, die Logik dort zu platzieren, wo sie passt.

Zum Beispiel:

• Sie haben eine PersonDtoKlasse aus Ihrem DataLayerProjekt.
• Ihr WebUIProjekt möchte a PersonDtoin a konvertieren können PersonViewModel.

Sie können (und möchten) diese Konvertierungsmethode nicht zu Ihrem DataLayerProjekt hinzufügen . Da diese Methode auf das WebUIProjekt beschränkt ist, sollte sie sich in diesem Projekt befinden.

Mit einer Erweiterungsmethode können Sie diese Methode innerhalb Ihres Projekts (und möglicher Konsumenten Ihres Projekts) global zugänglich machen, ohne dass die DataLayerBibliothek sie implementieren muss.

3. Wenn Sie der Meinung sind, dass Datenklassen nur Daten enthalten sollten.

Beispielsweise Personenthält Ihre Klasse die Eigenschaften für eine Person. Sie möchten jedoch einige Methoden haben, mit denen einige Daten formatiert werden können:

public class Person
{
    //The properties...

    public SecurityQuestionAnswers GetSecurityAnswers()
    {
        return new SecurityQuestionAnswers()
        {
            MothersMaidenName = this.Mother.MaidenName,
            FirstPetsName = this.Pets.OrderbyDescending(x => x.Date).FirstOrDefault()?.Name
        };
    }
}

Ich habe viele Mitarbeiter gesehen, die die Idee hassen, Daten und Logik in einer Klasse zu mischen. Ich bin mit einfachen Dingen wie dem Formatieren von Daten nicht ganz einverstanden, aber ich gebe zu, dass es sich im obigen Beispiel schmutzig anfühlt Person, wenn man sich darauf verlassen muss SecurityQuestionAnswers.

Durch das Einfügen dieser Methode in eine Erweiterungsmethode wird verhindert, dass die ansonsten reine Datenklasse beschmutzt wird.

Beachten Sie, dass dieses Argument stilistisch ist. Dies ähnelt Teilklassen. Dies hat wenig bis gar keinen technischen Vorteil, aber Sie können Code in mehrere Dateien aufteilen, wenn Sie ihn für sauberer halten (z. B. wenn viele Benutzer die Klasse verwenden, sich aber nicht um Ihre zusätzlichen benutzerdefinierten Methoden kümmern).

4. Hilfsmethoden

In den meisten Projekten neige ich dazu, Helferklassen zu haben. Hierbei handelt es sich um statische Klassen, die normalerweise eine Sammlung von Methoden zur einfachen Formatierung bereitstellen.

Beispielsweise hatte eine Firma, bei der ich arbeitete, ein bestimmtes Datums- / Uhrzeitformat, das sie verwenden wollten. Anstatt die Formatzeichenfolge überall einzufügen oder die Formatzeichenfolge zu einer globalen Variablen zu machen, habe ich mich für eine DateTime-Erweiterungsmethode entschieden:

public static string ToCompanyFormat(this DateTime dt)
{
    return dt.ToString("...");
} 

Ist das besser als eine normale statische Hilfsmethode? Ich glaube schon. Es bereinigt die Syntax. Anstatt

DateTimeHelper.ToCompanyFormat(myObj.CreatedOn);

Ich könnte:

myObj.CreatedOn.ToCompanyFormat();

Dies ähnelt einer fließenden Version derselben Syntax. Ich mag es mehr, obwohl es keinen technischen Vorteil hat, wenn man übereinander steht.

Alle diese Argumente sind subjektiv. Keiner von ihnen deckt einen Fall ab, der sonst niemals abgedeckt werden könnte.

• Jede Erweiterungsmethode kann problemlos in eine normale statische Methode umgeschrieben werden.
• Code kann mithilfe von Teilklassen in Dateien getrennt werden, auch wenn keine Erweiterungsmethoden vorhanden waren.

Andererseits können wir Ihre Behauptung aufgreifen, dass sie niemals extrem notwendig sind:

• Warum brauchen wir Klassenmethoden, wenn wir immer statische Methoden mit einem Namen erstellen können, der eindeutig angibt, dass es sich um eine bestimmte Klasse handelt?

Die Antwort auf diese und Ihre Frage bleibt dieselbe:

• Schönere Syntax
• Verbesserte Lesbarkeit und weniger Code-Pedanterie (Code wird in weniger Zeichen auf den Punkt gebracht)
• Intellisense liefert kontextbezogene Ergebnisse (Erweiterungsmethoden werden nur für den richtigen Typ angezeigt. Statische Klassen können überall verwendet werden).

Eine besondere Erwähnung:

• Erweiterungsmethoden ermöglichen eine Verkettung des Codierungsstils. Dies ist in letzter Zeit populärer geworden, im Gegensatz zu der Vanille-Methoden-Wrapping-Syntax. Ähnliche syntaktische Einstellungen finden Sie in der Methodensyntax von LINQ.
• Während die Methodenverkettung auch mithilfe von Klassenmethoden durchgeführt werden kann; Beachten Sie, dass dies für statische Methoden nicht ganz gilt. Erweiterungsmethoden basieren am häufigsten auf Dingen, die sonst statische Methoden gewesen wären, nicht auf Klassenmethoden.

Ich stimme Flater zu, dass nicht genügend Zeit für die Kristallisation von Konventionen vorhanden war, aber wir haben das Beispiel der .NET Framework-Klassenbibliotheken selbst. Beachten Sie, dass LINQ-Methoden beim Hinzufügen zu .NET nicht direkt hinzugefügt wurden IEnumerable, sondern als Erweiterungsmethoden.

Was können wir daraus ziehen? LINQ ist

1. eine zusammenhängende Reihe von Funktionen, die nicht immer benötigt werden,
2. soll im Methodenverkettungsstil verwendet werden (z. B. A.B().C()anstelle von C(B(A))), und
3. erfordert keinen Zugriff auf den privaten Status des Objekts

Wenn Sie alle drei Funktionen haben, sind Erweiterungsmethoden sehr sinnvoll. In der Tat würde ich argumentieren, dass wenn eine Reihe von Methoden Feature # 3 und eines der ersten beiden Features hat, Sie erwägen sollten, sie Erweiterungsmethoden zu machen.

Erweiterungsmethoden:

1. So können Sie vermeiden, die Kern-API einer Klasse zu verschmutzen.
2. Ermöglichen Sie nicht nur den Methodenverkettungsstil, sondern auch die flexiblere Verarbeitung von nullWerten, da eine von einem nullWert aufgerufene Erweiterungsmethode einfach das nullerste Argument erhält.
3. Verhindern Sie, dass Sie versehentlich auf den privaten / geschützten Status in einer Methode zugreifen / diesen ändern, die keinen Zugriff darauf haben sollte

Erweiterungsmethoden haben einen weiteren Vorteil: Sie können weiterhin als statische Methode verwendet und direkt als Wert an eine Funktion höherer Ordnung übergeben werden. Wenn MyMethodes sich also um eine Erweiterungsmethode handelt, myList.Select(x => x.MyMethod())können Sie sie einfach verwenden myList.Select(MyMethod). Ich finde das schöner.

Die treibende Kraft hinter Erweiterungsmethoden ist die Fähigkeit, allen Klassen oder Schnittstellen eines bestimmten Typs Funktionen hinzuzufügen, unabhängig davon, ob sie versiegelt sind oder sich in einer anderen Baugruppe befinden. Sie können dies anhand von LINQ-Code nachweisen, indem Sie allen IEnumerable<T>Objekten Funktionen hinzufügen , unabhängig davon, ob es sich um Listen oder Stapel usw. handelt. Das Konzept bestand darin, die Funktionen zukunftssicher zu machen, sodass Sie IEnumerable<T>LINQ automatisch verwenden können , wenn Sie eigene Funktionen entwickeln .

Die Sprachfunktion ist jedoch so neu, dass Sie keine Richtlinien haben, wann Sie sie verwenden oder nicht verwenden sollen. Sie ermöglichen jedoch eine Reihe von Dingen, die bisher nicht möglich waren:

• Fließende APIs ( ein Beispiel für das Hinzufügen fließender APIs zu nahezu jedem Objekt finden Sie unter Fließende Zusicherungen. )
• Integrieren von Funktionen (NetCore Asp.NET MVC verwendet Erweiterungsmethoden, um Abhängigkeiten und Funktionen im Startcode zu verkabeln.)
• Lokalisieren der Auswirkungen eines Features (Ihr Beispiel in der Eröffnungserklärung)

Um fair zu sein, wird nur die Zeit zeigen, wie weit zu weit ist oder an welchem ​​Punkt Erweiterungsmethoden eher ein Hindernis als ein Segen werden. Wie in einer anderen Antwort erwähnt, enthält eine Erweiterungsmethode nichts, was mit einer statischen Methode nicht möglich wäre. Bei vernünftiger Verwendung können sie den Code jedoch leichter lesbar machen.

Was ist mit der absichtlichen Verwendung von Erweiterungsmethoden in derselben Assembly?

Ich denke, es ist wertvoll, die Kernfunktionalität gut getestet und vertrauenswürdig zu haben und dann erst dann damit herumzuspielen, wenn Sie es unbedingt müssen. Neuer Code, der davon abhängt, aber nur zum Nutzen des neuen Codes Funktionen bereitstellen muss, kann mithilfe von Erweiterungsmethoden Funktionen hinzufügen, die den neuen Code unterstützen. Diese Funktionen sind nur für den neuen Code von Interesse, und der Umfang der Erweiterungsmethoden ist auf den Namespace beschränkt, in dem sie deklariert sind.

Ich würde die Verwendung von Erweiterungsmethoden nicht blind ausschließen, aber ich würde überlegen, ob die neue Funktionalität wirklich zu dem vorhandenen Kerncode hinzugefügt werden sollte, der gut getestet ist.

Gibt es etablierte Muster oder Best Practices für die Verwendung von Erweiterungsmethoden?

Einer der häufigsten Gründe für die Verwendung von Erweiterungsmethoden ist das "Erweitern, nicht Ändern" von Schnittstellen. Anstatt zu haben IFoound IFoo2, wo letztere eine neue Methode einführt Bar, Barwird IFooüber eine Erweiterungsmethode hinzugefügt .

Einer der Gründe dafür verwendet Linq - Erweiterungsmethoden für Where, Selectetc ist , um Benutzern zu ermöglichen , ihre eigenen Versionen dieser Methoden zu definieren, die dann auch von der Linq Abfragesyntax verwendet werden.

Darüber hinaus ist der Ansatz, den ich verwende und der zu dem zu passen scheint, was ich im .NET Framework normalerweise sehe, zumindest:

1. Fügen Sie Methoden, die in direktem Zusammenhang mit der Klasse stehen, in die Klasse selbst ein.
2. Fügen Sie alle Methoden, die nicht mit der Kernfunktionalität der Klasse zusammenhängen, in Erweiterungsmethoden ein.

Also , wenn ich eine habe Option<T>, würde ich die Dinge wie HasValue, Value, ==usw. innerhalb des Typs selbst. Aber so etwas wie eine MapFunktion, die die Monade von T1in konvertiert T2, würde ich eine Erweiterungsmethode einfügen:

public static Option<TOutput> Map<TInput, TOutput>(this Option<TInput> input, 
                                                   Func<TInput, TOutput> f) => ...