Accesso ad attributi personalizzati

Articolo
08/22/2007

Dopo che gli attributi sono stati associati a elementi del programma, è possibile verificarne l'esistenza ed esaminarne il valore tramite reflection. In .NET Framework versioni 1.0 e 1.1 gli attributi personalizzati vengono esaminati nel contesto di esecuzione. In .NET Framework versione 2.0 è disponibile un nuovo contesto di caricamento, Reflection-Only, che consente di esaminare il codice che non è possibile caricare per l'esecuzione.

Contesto Reflection-Only

Il codice caricato nel contesto Reflection-Only non può essere eseguito. Non è pertanto possibile creare istanze di attributi personalizzati, operazione per cui è richiesta l'esecuzione dei costruttori. Per caricare ed esaminare gli attributi personalizzati nel contesto Reflection-Only, utilizzare la classe CustomAttributeData. È possibile ottenere istanze di questa classe utilizzando l'overload appropriato del metodo statico System.Reflection.CustomAttributeData.GetCustomAttributes. Per informazioni al riguardo, vedere Procedura: caricare assembly nel contesto Reflection-Only.

Contesto di esecuzione

I metodi di reflection principali per eseguire query sugli attributi presenti nel contesto di esecuzione sono System.Reflection.MemberInfo.GetCustomAttributes e System.Reflection.Assembly.GetCustomAttributes.

L'accessibilità di un attributo personalizzato viene controllata in riferimento all'assembly a cui l'attributo è collegato. In altri termini, si verifica se un metodo di un tipo dell'assembly a cui è collegato l'attributo personalizzato può chiamare il costruttore dell'attributo personalizzato.

Metodi quali System.Reflection.Assembly.GetCustomAttributes(Type, Boolean) controllano la visibilità e l'accessibilità dell'argomento type. È possibile recuperare un attributo personalizzato del tipo definito dall'utente tramite GetCustomAttributes solo nel codice dell'assembly che contiene tale tipo.

Nell'esempio in C# riportato di seguito viene rappresentato un tipico modello di progettazione di attributi personalizzati. Viene illustrato il modello di reflection degli attributi personalizzati adottato dal runtime.

System.DLL
public class DescriptionAttribute : Attribute
{
}

System.Web.DLL
internal class MyDescriptionAttribute : DescriptionAttribute
{
}

public class LocalizationExtenderProvider
{
    [MyDescriptionAttribute(...)]
    public CultureInfo GetLanguage(...)
    {
    }
}

Se il runtime tenta di recuperare gli attributi personalizzati del tipo di attributo personalizzato pubblico DescriptionAttribute collegato al metodo GetLanguage, effettua le seguenti operazioni:

Controlla che l'argomento di tipo DescriptionAttribute per Type.GetCustomAttributes(Type tipo) sia pubblico e quindi visibile e accessibile.
Controlla che il tipo definito dall'utente MyDescriptionAttribute derivato da DescriptionAttribute sia visibile e accessibile all'interno dell'assembly System.Web.DLL, in cui è collegato al metodo GetLanguage().
Controlla che il costruttore di MyDescriptionAttribute sia visibile e accessibile all'interno dell'assembly System.Web.DLL.
Chiama il costruttore di MyDescriptionAttribute con i parametri dell'attributo personalizzato e restituisce il nuovo oggetto al chiamante.

Il modello di reflection degli attributi personalizzati può perdere istanze di tipi definiti dall'utente all'esterno dell'assembly in cui il tipo è definito. Questo modello non differisce da quello in cui si inquadrano i membri della libreria di sistema del runtime, che restituiscono istanze di tipi definiti dall'utente, quali Type.GetMethods(), che restituisce una matrice di oggetti RuntimeMethodInfo. Per impedire a un client di rilevare informazioni su un attributo personalizzato definito dall'utente, definire i membri del tipo come non pubblici.

Nell'esempio che segue viene illustrato il metodo principale per accedere agli attributi personalizzati tramite reflection.

Class Class1
    Public Shared Sub Main()
        Dim info As System.Reflection.MemberInfo = GetType(Class1)
        Dim attributes() As Object = info.GetCustomAttributes(True)
        For i As Integer = 0 To attributes.Length - 1
            System.Console.WriteLine(attributes(i))
        Next i
    End Sub
End Class

class MyClass 
{ 
    public static void Main() 
    {
        System.Reflection.MemberInfo info = typeof(MyClass);
        object[] attributes = info.GetCustomAttributes(true);
        for (int i = 0; i < attributes.Length; i++)
        {
            System.Console.WriteLine(attributes[i]);
        }
    }
}

Vedere anche

Riferimenti

MemberInfo.GetCustomAttributes
Attribute.GetCustomAttributes

Concetti

Visualizzazione delle informazioni sul tipo
Considerazioni sulla protezione in relazione alla reflection

Condividi tramite