Creazione di attributi personalizzati (Guida per programmatori C#)

Articolo
09/12/2008

Aggiornamento: Luglio 2008

È possibile creare attributi personalizzati definendo una classe Attribute, ovvero una classe che deriva direttamente o indirettamente da Attribute, in modo da semplificare e velocizzare l'identificazione delle definizioni di attributo nei metadati. Si supponga di voler applicare alle classi e alle strutture dei tag che indichino il nome del programmatore che ha scritto ogni singola classe o struttura. È possibile definire una classe Attribute Author personalizzata:

[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct)
]
public class Author : System.Attribute
{
    private string name;
    public double version;

    public Author(string name)
    {
        this.name = name;
        version = 1.0;
    }
}

Il nome della classe corrisponde al nome dell'attributo, ovvero Author. Deriva da System.Attribute, pertanto è una classe Attribute personalizzata. I parametri del costruttore sono i parametri posizionali dell'attributo personalizzato, in questo caso name, ed eventuali proprietà o campi pubblici in lettura-scrittura sono parametri denominati. In questo caso version è l'unico parametro denominato. Si noti l'utilizzo dell'attributo AttributeUsage per rendere l'attributo Author valido solo per dichiarazioni di class e struct.

È possibile utilizzare questo nuovo attributo come indicato di seguito:

[Author("H. Ackerman", version = 1.1)]
class SampleClass
{
    // H. Ackerman's code goes here...
}

AttributeUsage ha un parametro denominato, AllowMultiple, che consente di rendere multiuso un attributo personalizzato o di destinarlo a un unico utilizzo.

[System.AttributeUsage(System.AttributeTargets.Class |
                       System.AttributeTargets.Struct,
                       AllowMultiple = true)  // multiuse attribute
]
public class Author : System.Attribute

[Author("H. Ackerman", version = 1.1)]
[Author("M. Knott", version = 1.2)]
class SampleClass
{
    // H. Ackerman's code goes here...
    // M. Knott's code goes here...
}

Nota:
Se la classe Attribute contiene una proprietà, tale proprietà deve essere di lettura-scrittura. Gli attributi di sola scrittura non sono supportati nelle classi Attibute in C#.