So erstellen Sie ein benutzerdefiniertes Attribut in C #

Ich habe viele Male versucht, aber ich bin immer noch nicht in der Lage, die Verwendung von benutzerdefinierten Attributen zu verstehen (ich habe bereits viele Links durchlaufen).

Kann mir bitte jemand ein sehr einfaches Beispiel für ein benutzerdefiniertes Attribut mit Code erklären?

Während der Code zum Erstellen eines benutzerdefinierten Attributs ziemlich einfach ist, ist es sehr wichtig, dass Sie verstehen, was Attribute sind:

Attribute sind Metadaten, die in Ihrem Programm kompiliert wurden. Attribute selbst fügen einer Klasse, Eigenschaft oder einem Modul keine Funktionalität hinzu - nur Daten. Mithilfe der Reflexion können diese Attribute jedoch genutzt werden, um Funktionen zu erstellen.

Schauen wir uns zum Beispiel den Validierungsanwendungsblock aus der Microsoft Enterprise Library an . Wenn Sie sich ein Codebeispiel ansehen, sehen Sie:

    /// <summary>
    /// blah blah code.
    /// </summary>
    [DataMember]
    [StringLengthValidator(8, RangeBoundaryType.Inclusive, 8, RangeBoundaryType.Inclusive, MessageTemplate = "\"{1}\" must always have \"{4}\" characters.")]
    public string Code { get; set; }

Aus dem obigen Snippet könnte man schließen, dass der Code immer validiert wird, wenn er gemäß den Regeln des Validators geändert wird (im Beispiel mindestens 8 Zeichen und höchstens 8 Zeichen). Aber die Wahrheit ist, dass das Attribut nichts tut; Wie bereits erwähnt, werden der Eigenschaft nur Metadaten hinzugefügt.

Die Unternehmensbibliothek verfügt jedoch über eine Validation.ValidateMethode, die Ihr Objekt untersucht und für jede Eigenschaft prüft, ob der Inhalt gegen die durch das Attribut angegebene Regel verstößt.

So sollten Sie also über Attribute nachdenken - eine Möglichkeit, Ihrem Code Daten hinzuzufügen, die später möglicherweise von anderen Methoden / Klassen / etc. Verwendet werden.

Sie beginnen mit dem Schreiben einer Klasse, die von Attribute abgeleitet ist :

public class MyCustomAttribute: Attribute
{
    public string SomeProperty { get; set; }
}

Dann können Sie alles (Klasse, Methode, Eigenschaft, ...) mit diesem Attribut dekorieren:

[MyCustomAttribute(SomeProperty = "foo bar")]
public class Foo
{

}

und schließlich würden Sie Reflexion verwenden, um es zu holen:

var customAttributes = (MyCustomAttribute[])typeof(Foo).GetCustomAttributes(typeof(MyCustomAttribute), true);
if (customAttributes.Length > 0)
{
    var myAttribute = customAttributes[0];
    string value = myAttribute.SomeProperty;
    // TODO: Do something with the value
}

Sie können die Zieltypen, auf die dieses benutzerdefinierte Attribut angewendet werden kann, mithilfe des Attributs AttributeUsage einschränken :

/// <summary>
/// This attribute can only be applied to classes
/// </summary>
[AttributeUsage(AttributeTargets.Class)]
public class MyCustomAttribute : Attribute

Wichtige Informationen zu Attributen:

• Attribute sind Metadaten.
• Sie werden zur Kompilierungszeit in die Assembly eingebrannt , was sehr schwerwiegende Auswirkungen darauf hat, wie Sie ihre Eigenschaften festlegen können. Es werden nur konstante (zur Kompilierungszeit bekannte) Werte akzeptiert
• Die einzige Möglichkeit, benutzerdefinierte Attribute zu verstehen und zu verwenden, ist die Verwendung von Reflection . Wenn Sie also zur Laufzeit keine Reflektion verwenden, um sie abzurufen und etwas mit einem benutzerdefinierten Attribut zu dekorieren, erwarten Sie nicht, dass viel passiert.
• Der Zeitpunkt der Erstellung der Attribute ist nicht deterministisch. Sie werden von der CLR instanziiert und Sie haben absolut keine Kontrolle darüber.

Verwenden Sie die großartige Antwort von Darin Dimitrov , um auf ein benutzerdefiniertes Attribut für eine Eigenschaft und nicht für eine Klasse zuzugreifen:

Das dekorierte Eigentum [der Klasse Foo]:

[MyCustomAttribute(SomeProperty = "This is a custom property")]
public string MyProperty { get; set; }

Abrufen:

PropertyInfo propertyInfo = typeof(Foo).GetProperty(propertyToCheck);
object[] attribute = propertyInfo.GetCustomAttributes(typeof(MyCustomAttribute), true);
if (attribute.Length > 0)
{
    MyCustomAttribute myAttribute = (MyCustomAttribute)attribute[0];
    string propertyValue = myAttribute.SomeProperty;
}

Sie können dies in eine Schleife werfen und mithilfe der Reflektion auf dieses benutzerdefinierte Attribut für jede Eigenschaft der Klasse zugreifen Foo:

foreach (PropertyInfo propertyInfo in Foo.GetType().GetProperties())
{
    string propertyName = propertyInfo.Name;

    object[] attribute = propertyInfo.GetCustomAttributes(typeof(MyCustomAttribute), true);
    // Just in case you have a property without this annotation
    if (attribute.Length > 0)
    {
        MyCustomAttribute myAttribute = (MyCustomAttribute)attribute[0];
        string propertyValue = myAttribute.SomeProperty;
        // TODO: whatever you need with this propertyValue
    }
}

Vielen Dank an dich, Darin !!