Was genau ist eine Buddy-Klasse und wie verwende ich sie, um Anmerkungen zu einer vorhandenen Klasse hinzuzufügen?

Question

Ich habe den Begriff "Buddy-Klasse" als eine "Antwort" auf Fragen wie "wie kann ich Anmerkungen zu einer partiellen Klasse in einer anderen Datei hinzufügen" gesehen, aber diese Antworten annehmen, ich weiß, was eine Buddy-Klasse ist, und Die Codebeispiele gehen davon aus, dass ich verstehe, wie/warum das funktioniert.

Ich konnte keine einfache Erklärung dafür finden, was eine Buddy-Klasse in C# ist und wie/warum es mir ermöglicht, eine vorhandene Klasse zu ändern, z. B. das Hinzufügen von Anmerkungen zu Eigenschaften.

Answer 1

'Buddy-Klasse' ist nicht unbedingt C# -spezifisch, aber ich glaube, es wird häufiger in .Net als seine Art eines Musters oder einer Technik (Hack) verwendet, um automatisch generierte Klassen zu erweitern und Attribute hinzuzufügen. Sie werden manchmal auch als assoziierte Klassen oder Metadatenklassen bezeichnet. Die Namenskonvention besteht darin, MD (für Metadaten) an die Buddy-Klasse anzuhängen, damit sie als eine identifiziert werden kann. Aus diesem Grund überschreibt automatisch generierter Code alle von Ihnen vorgenommenen Änderungen. Zugehörige Klassen könnten eine Möglichkeit sein, dies zu umgehen, und Sie könnten Ihre benutzerdefinierten Metadaten (z. B. Validierungsattribute) beibehalten. Sie haben eine Klasse, die automatisch erzeugt wird, handlich als partiell markiert (ich glaube, das ist der Grund, warum der partielle Modifikator eingeführt wurde - um automatisch generierte Klassen zu erweitern). Sie möchten ein Attribut anwenden, so dass Sie eine separate Klasse erstellen, die das enthält, und Sie mit der anderen Klasse verbinden.

Wenn VS dies für einen Ihrer Entitäten erzeugt:

public partial class AutoGeneratedClass 
{ 
    public string SomeData { get; set; } 
} 

Und möchten Sie, dass erweitern und fügen Sie benutzerdefinierte Metadaten Sie dies schaffen könnte:

[MetadataType(typeof(NotAutoGeneratedClassMD))] 
public partial class AutoGeneratedClass 
{ 
} 

public class NotAutoGeneratedClassMD 
{ 
    [DisplayName("This is some data")] 
    public string SomeData { get; set; } 
} 

Kurzversion:

Was: Möglichkeit, Klassen zuzuordnen, um eine automatisch generierte Klasse mit benutzerdefinierten Metadaten zu erweitern

Warum: Vermeiden Sie, dass Änderungen an einer automatisch generierten Klasse bei der erneuten Generierung überschrieben werden.

Ich persönlich bin kein Fan, aber das ist eine andere Geschichte :)