Atrybuty w C#
Atrybut
Zacznijmy od tego czym jest Atrybut. A jest on niczym więcej jak dodatkowymi metadanymi, które można dodać w naszym kodzie. Atrybuty można dodawać do większości elementów klasy czy też biblioteki.
A więc do :
- assembly
- modułów
- klass
- struktur
- enum-ów
- konstruktora
- metod
- właściwości
- pól
- eventów
- Interface
- parametrów
- delegatów
- wartości zwracanych
- parametrów generycznych
Atrybuty w C# zapisuje się w nawiasach Kwadratowych “[MójAttrybut]” nad lub przy odpowiednim elemencie, do którego ma zostać dodany dany atrybut.
Zastosowanie
Jak już wiemy atrybut jest dodatkową informacją, którą możemy odczytać, czy to my, czy użyta przez nas biblioteka zewnętrzna, czy choćby runner testowy. Tak tak wykorzystujemy atrybuty częściej niż nam się wydaje. Znane mi frameworki testowe wykorzystują atrybuty. To właśnie dzięki nim framework wie, która metoda to test, a która jest setupem dla wszystkich testów. Atrybuty są również bardzo często wykorzystywane przez wszelkiej maści serializery. Tam atrybuty umożliwiają zmianę nazw właściwości w wynikowym obiekcie z serializowanym. Innym miejscem są kontrolery ASP.NET, gdzie możemy zdefiniować mapowania metod i ścieżek.
Predefiniowane Atrybuty .Net
Framework .Net posiada 3 predefiniowane atrybuty i wszystkie inne są atrybutami dodanymi przez wykorzystywane przez nas biblioteki lub nas samych. Dzisiaj chciałbym zaprezentować 2 z nich Obsolete oraz Conditional, trzecim atrybutem czyli AttributeUsage zajmiemy się w kolejnym wpisie odnoszącym się do naszych własnych atrybutów.
Obsolete
Atrybut ten służy do oznaczania przestarzałych elementów naszej klasy czy biblioteki. Dzięki niemu możemy dać znać pozostałym programistom, że powinni wykorzystać inną metodę. Atrybut ten ma 2 parametry, które możemy ustawić
- message – to wiadomość, którą zwróci nam kompilator w formie warninga lub errora
- error – wartość logiczna czy kompilator ma zwrócić błąd czy też nie
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
using System; namespace AttributeTests { class Program { static void Main(string[] args) { VeryOldMethod("data"); OldMethod("data"); Console.ReadLine(); } [Obsolete("use NewMethog",false)] public static void OldMethod(string s) { Console.WriteLine(s); } [Obsolete("use NewMethog", true)] public static void VeryOldMethod(string s) { Console.WriteLine(s); } public static void NewMethod(string s) { Console.WriteLine(s); } } } |
Zwraca nam
|
1 2 |
1>C:\Users\mateu\Source\Repos\AttributeTests\AttributeTests\Program.cs(13,13,13,34): error CS0619: 'Program.VeryOldMethod(string)' is obsolete: 'use NewMethog' 1>C:\Users\mateu\Source\Repos\AttributeTests\AttributeTests\Program.cs(14,13,14,30): warning CS0618: 'Program.OldMethod(string)' is obsolete: 'use NewMethog' |
więcej https://msdn.microsoft.com/pl-pl/library/system.obsoleteattribute(v=vs.110).aspx
Conditional
Atrybut ten umożliwia warunkowe wykonanie metody jeśli symbol, który jest podany jako parametr Atrybutu jest zdefiniowany. A więc możemy wykorzystywać ten atrybut podobnie do #IF …. z tym, że do całych metod.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
#define OTHER using System; using System.Diagnostics; namespace AttributeTests { class Program { static void Main(string[] args) { ConditionalDebug("data"); ConditionalOther("data"); Console.ReadLine(); } [Conditional("DEBUG")] public static void ConditionalDebug(string s) { Console.WriteLine($"DEBUG: {s}"); } [Conditional("OTHER")] public static void ConditionalOther(string s) { Console.WriteLine($"OTHER: {s}"); } } } |
więcej https://msdn.microsoft.com/pl-pl/library/system.diagnostics.conditionalattribute(v=vs.110).aspx