Własny Atrybut
Własny Atrybut
Z poprzedniego wpisu https://mateuszstanek.pl/2018/02/03/atrybut-c/ wiemy czym są atrybuty. Pora więc napisać jakiś własny. Aby to zrobić wystarczy dodać nową klasę dziedziczącą z klasy System.Attrybute oraz poinformować z jakimi elementami będzie nasz atrybut współpracował.
W tym celu wykorzystamy 3 z predefiniowanych atrybutów AttributeUsage.
AttributeUsage
Atrybut ten wykorzystywany jest przy definiowaniu nowych atrybutów. Określa on z jakimi elementami kodu może być stosowany, w jaki sposób oraz czy będzie on dziedziczony. Konstruktor wymaga od nas podania tylko z jakimi elementami atrybut będzie wykorzystany. Służy do tego parametr validOn, gdzie możemy dodać wartości z enumeracji AttributeTargets. Wartości tej enumeracji są flagami, tak więc możemy wykorzystać więcej niż 1 wartość poprzez łączenie ich przy pomocy bitowego operatora lub “|”. Dodatkowo przy dodawaniu atrybutu AttributeUsage możemy ustawić 2 wartości logiczne :
- AllowMultiple – która określa czy atrybut może być wykorzystany tylko raz dla danego elementu – wartością domyślną jest False.
- Inherited – która określa czy atrybut jest dziedziczony, tutaj również wartością domyślną jest False.
Więcej https://msdn.microsoft.com/pl-pl/library/system.attributeusageattribute(v=vs.110).aspx
Prosta implementacja
Pora na pierwszy własny atrybut może on wglądać na przykład tak :
|
1 2 3 4 5 6 7 8 9 |
using System; namespace AttributeTests { [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false, Inherited = false)] public class MyCustomAttribute : System.Attribute { } } |
Z deklaracji widzimy, że atrybut może być wykorzystany z właściwościami oraz polami klasy. Jednakże taki atrybut nie niesie ze sobą zbyt wielu informacji, możemy jedynie nim oznaczyć jakieś konkretne pola, bądź właściwości. Gdyby zastosować analogiczny atrybut do metod można by było oznaczać metody do wywołania w określonych przypadkach na przykład przy pisaniu własnych runerów testowych. Jeśli chcemy przekazać więcej informacji musimy dodać do naszej implementacji jakieś właściwości.
W kolejnym przykładzie widzimy atrybut, który przekazuje informacje jak powinniśmy przekształcać na łańcuchy znakowe wartości z naszych właściwości.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
using System; namespace AttributeTests { [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)] public class MyCustomAttribute : System.Attribute { public string ToStringParameter { get; set; } public MyCustomAttribute(string toStringParams) { ToStringParameter = toStringParams; } } } |
W tym miejscu należy dodać, iż zbiór parametrów jest ograniczony do typów prostych (string, bool, byte, char, short, int, long, float, double), typów wyliczeniowych Enum oraz Typu obiektu (System.Type) a także jednowymiarowych tablic tych typów. To ograniczenie uniemożliwia nam przekazanie własnych klas wprost do naszego atrybutu.