Отражение, метаданные, атрибуты - C# - Ответ 1017083

@~~NightmareZ~~ · 10.10.2010, 20:57. **Показов** 88139. **Ответов** 1

Author24 — интернет-сервис помощи студентам

Одной из особенностей платформы .NET является то, что программы, написанные под неё, не превращаются в монотонные последовательности машинных инструкций, разобрать которые - весьма нетривиальная задача в общем случае, а наоборот, сохраняют первоначальную структуру (включая иерархию классов и т.п.), а также снабжаются подробной информацией о том, где и что лежит и что из себя представляет. Такая информация, такие данные о данных (о программе), называются метаданными.

Часть метаданных генерируется компилятором. Часть можно задавать самому в программном коде при помощи атрибутов. Используется она тоже всюду: и средой исполнения, и программистом (по мере необходимости с помощью системы отражения (reflection)).

Далее для примеров я буду использовать такие типы:

C#

1
2
3

class A { }
class B : A { }
class C { }

Оператор is.

Оператор is позволяет определить, совместим ли объект с указанным типом.
Если ссылка содержит null, оператор is вернёт false.
Объявление неявного оператора преобразования из типа в тип (в данном случае из A в C и/или обратно) никак на оператор is не повлияет.

C#

A objA = new A();
B objB = new B();
 
// True - потому что объект objA является экземпляром класса A.
Console.WriteLine(objA is A);
 
// False - потому что объект objA не является экземпляром класса C.
Console.WriteLine(objA is C);
 
// True - потому что объект objA является экземпляром класса,
// унаследованным от класса A. Потому objB можно приводить к типу A.
Console.WriteLine(objB is A);
 
// False - потому что объект objB никаким образом не связан с классом C.
Console.WriteLine(objB is C);

Оператор as.

Оператор as является оператором приведения, позволяя приводить объект к любому типу. В случае, если приведение не удалось, возвращается null.

C#

1 2	object objB = new B(); A objA = objB as A;

Привести к типу можно и вот таким образом:

C#

1 2	object objB = new B(); A objA = (A)objB;

с той лишь разницей, что в этом случае при неудачном приведении будет брошено исключение InvalidCastException.

Также нужно заметить, что оператор as не выполняет, например, преобразования определённые пользователем.

Оператор typeof и класс System.Type.

Класс System.Type описывает тип данных и с помощью своих методов и свойств открывает доступ к чтению метаданных этого типа. Получить экземпляр данного класса для типа можно несколькими способами:

C#

1
2
3

// С помощью оператора typeof получаем объект,
// описывающий тип, собственно по самому типу
Type t = typeof (A);

C#

// Базовый класс System.Object имеет метод GetType(), который возвращает
// объект класса Type для данной сущности
A obj = new A();
Type t = obj.GetType();

C#

1 2	// Класс Type имеет статический метод GetType(), позволяющий получить тип по его имени Type t = Type.GetType("A");

Здесь "A" - полный путь к типу со всеми пространствами имён.

Некоторые свойства-предикаты класа Type:

IsAbstract - является ли тип абстрактным классом.
IsArray - является ли тип массивом.
IsClass - является ли тип классом (а не интерфейсом или структурой).
IsInterface - является ли тип интерфейсом.
IsEnum - является ли тип перечислением.
IsValueType - является ли тип структурой (а, если точнее, то наследником System.ValueType, а это все нессылочные типы).
и т.д.

Пример:

C#

1 2	// True - тип A является классом Console.WriteLine(typeof(A).IsClass);

Также стоит упомянуть свойство Name, возвращающее имя типа. Может быть полезно при отладке:

C#

1 2	// Выведет "A" Console.WriteLine(typeof(A).Name);

Кроме полезных свойств класс Type содержит также немало методов, также крайне полезных. Например, метод GetMethods() возвращает массив объектов класса MethodInfo. Класс MethodInfo по сути служит тем самым описателем для метода, каким является класс Type для типа. Т.е. GetMethods() возвращает по описателю для каждого метода в данном типе.

Для примера расширим класс A, добавив в него несколько методов:

C#

class A
{
public void MethodHello() { }
public void MethodWorld() { }
private void Abc() { }
}

А теперь выведем их имена на консоль:

C#

Type t = typeof (A);
MethodInfo[] methods = t.GetMethods();
 
foreach (MethodInfo method in methods)
Console.WriteLine(method.Name);

После выполнения данного кода увидим следующее:

Код

MethodHello
MethodWorld
ToString
Equals
GetHashCode
GetType

Это все методы, которые есть у нашего класса A. В том числе и методы, унаследованные (в данном случае от класса System.Object). А, например, метода Abc в списке не оказалось, потому что он является приватным.

Само собой процессом получения методов можно управлять. Для этого в классе Type есть перегруженная версия метода GetMethods, которая принимает в качестве параметра флаги задаваемые перечислением BindingFlags. Например, для того, чтобы вывести и публичные и приватные методы, нужно использовать флаги Public и NonPublic:

C#

1	MethodInfo[] methods = typeof(A).GetMethods(BindingFlags.Public \| BindingFlags.NonPublic \| BindingFlags.Instance);

Кроме метода GetMethods(), есть также метод GetMethod(), позволяющий получить метод по имени. Например, так:

C#

1	MethodInfo method = typeof (A).GetMethod("MethodHello");

Кроме методов класса Type для получения методов типа, есть также следующие методы:

GetMembers() и GetMember() - позволяют получить любые члены типа, включая методы, свойства, конструкторы, вложенные типы и т.д.
GetInterfaces() и GetInterface() - позволяют получить интерфейсы, реализованные типом.
GetNestedTypes() и GetNestedType() - позволяют получить вложенные типы. Т.е. для класса
C#
1 2 3 4
class X { public class Y { } }
эти методы позволяют получить объект описыващий тип Y.
GetProperties() и GetProperty() - позволяют получить свойства.
и т.д.

Вызов члена по его *Info.

Понятное дело, что хорошо иметь под рукой инструмент позволяющий получать информацию о всех типах и их членах. Но всё бы было не так хорошо, если бы на этом всё и заканчивалось. На самом деле все эти классы MethodInfo, PropertyInfo и прочие *Info позволяют не только получить информацию, но и нахально ею воспользоваться. Например, метод можно вызвать:

C#

1
2
3

A objA = new A();
MethodInfo method = objA.GetType().GetMethod("MethodHello");
method.Invoke(objA, null);

Происходит это с помощью метода Invoke класса MethodInfo. Первый аргумент - объект типа, в котором объявлен метод, который мы хотим вызвать (для статических методов, понятное дело, объект не нужен и можно указать null). Второй аргумент - аргументы вызываемого метода (так как у нашего метода их нет, передаём null).

Аналогично со свойствами. Допустим, есть у нас класс

C#

class ClassWithProperty
{
public int Prop { get; set; }
}

тогда можно к его свойству Prop обратиться так:

C#

1
2
3

ClassWithProperty obj = new ClassWithProperty();
PropertyInfo property = obj.GetType().GetProperty("Prop");
property.SetValue(obj, 1, null);

Метод SetValue() класса PropertyInfo позволяет записать значение в свойство (есть также метод GetValue(), с помощью которого можно значения получать). Первый аргумент - объект, с которым хотим работать. Второй аргумент - собственно значение, которое хотим установить. Третий же аргумент позволяет задавать индексы для индексатора (но так как у нас простое свойство, то ставим просто null).

Также стоит упомянуть о конструкторах. Получив объект класса ConstructorInfo, можно, как не сложно догадаться, вызвав его, создать объект.

C#

1 2	Type t = typeof (A); A obj = (A) t.GetConstructors()[0].Invoke(null);

Что это даёт? Например, возможность создавать объекты по их строковому имени. Вот так:

C#

1 2	Type t = Type.GetType("A"); A obj = (A) t.GetConstructors()[0].Invoke(null);

На самом деле, это не единственный и не самый простой способ создать объект по имени класса. Ниже я напишу, как это сделать проще.

Атрибуты.

Атрибуты - это средство привязки информации к различным сущностям: методам, свойствам, типам и даже целым сборкам. По своей сути атрибут - это экземпляр класса унаследованного от System.Attribute.

Присоединить атрибут к сущности можно путём добавления его имени перед ней в квадратных скобках:

C#

public class A
{
[ObsoleteAttribute]
public void B() { }
}

В данном случае предопределённый атрибут ObsoleteAttribute указывает на то, что метод B является устаревшим и его использовать не стоит. Указывает он это среде (IDE), которая соответствующим образом использование такого метода подчеркнёт и компилятору, который выдаст предупреждение.

В C# есть небольшое упрощение: слово Attribute можно не писать, компилятор сам подставит что нужно:

C#

public class A
{
[Obsolete]
public void B() { }
}

Бывают также атрибуты, которые принимают некоторые значения в качестве параметров. В таком случае эти значения нужно указать в круглых скобках после имени атрибута.

Можно, безусловно, создавать свои атрибуты. Для этого просто унаследуемся от класса System.Attribute:

C#

class ColoredAttribute : Attribute
{
public ColoredAttribute(ConsoleColor color)
{
Color = color;
}
 
public ConsoleColor Color { get; private set; }
}

Этот класс позволит задавать "цвет" для любой сущности вот таким образом:

C#

class A
{
[Colored(ConsoleColor.Red)]
public void X() { }
 
[Colored(ConsoleColor.Green)]
public void Y() { }
}

Понятно, что о целях нашего атрибута знаем только мы, потому нужно написать код, который соответствующие методы выведет в консоль заданным нами с помощью атрибута цветом. Для этого обратимся опять к System.Type:

C#

Type t = typeof (A);
foreach (MethodInfo method in t.GetMethods())
{
object[] attribs = method.GetCustomAttributes(typeof(ColoredAttribute), false);
if (attribs.Length == 0) continue;
 
ColoredAttribute attrib = (ColoredAttribute)attribs[0];
Console.ForegroundColor = attrib.Color;
Console.WriteLine(method.Name);
}

Данный код выведет в консоль имя метода X красным цветом и имя метода Y зелёным. Получили мы атрибуты связанные с методами при помощи метода GetCustomAttributes(). Таким же образом можно получать атрибуты и для других сущностей.

При создании своего класса атрибутов стоит обратить внимание на предопределённый атрибут AttributeUsage. С помощью него можно задать область применимости своего атрибута. Например, если определим наш класс таким образом

C#

[AttributeUsage(AttributeTargets.Method)]
class ColoredAttribute : Attribute
{
// ....
}

то использовать атрибут ColoredAttribute можно будет только на методах.

Ещё хочу упомянуть очень полезный в хозяйстве атрибут Conditional. Он позволяет задавать условные методы, которые будут вызываться лишь в том случае, если соответствующий идентификатор определён с помощью директивы #define.

В этом примере метод World() будет вызываться только в случае, если определён идентификатор TEST. Если убрать из кода #define TEST, сообщения Hello на консоли мы не увидим.

C#

#define TEST
 
using System;
using System.Diagnostics;
 
class Program
{
[Conditional("TEST")]
static void World()
{
Console.WriteLine("Hello");
}
 
static void Main()
{
World();
}
}

Вернуться к обсуждению:
Отражение, метаданные, атрибуты C#

Следующий ответ

Другие темы раздела
C# Оригинальный интерфейс https://www.cyberforum.ru/ csharp-net/ thread174487.html Можно ли самому нарисовать внешний вид контролов из winforms, сохранив при этом их логику, чтобы не пришлось полностью создавать свой контрол. Немного слышал про mvc, mvp, хотя не уверен то это или нет, ведь они только помогают отделить логику от внешнего представления, а не создать его.	Проверка на соответствие C# Необходимо сделать проверку на соответствие маски фразы, маска вида asdфывд? где - любое количество любых символов, а ? - любой один символ. Какими методами лучше пользоваться для проверки строк? Что-то думаю, а алгоритм в голову не лезет )
C# Дерево https://www.cyberforum.ru/ csharp-net/ thread174227.html Есть совокупность групп. Каждая из групп состоит из одинаковых слов. Состав слов в группах разный. Необходимо для данных групп организовать дерево. Соответсвенно первый Нод дерева (Root) - первое слов в группе, остальные ноды - Children, предпоследний нод группы должен быть помечен как ChildrenLast. Вот, бьюс как реализовать пооригинальней. Может у кого-нибудь есть предложения? PS...	C# вопрос к среде https://www.cyberforum.ru/ csharp-net/ thread174193.html Скажите пожалуйста ,можно ли где-нибудь отдельно скачать панель элементов к Visual Studio? или надо заново скачивать?
Получение RSS C# Здравствуйте! Подскажите, как можно получить RSS и чтоб каждая "новость" была в отдельной строке?	C# Эффекты изображений https://www.cyberforum.ru/ csharp-net/ thread174109.html Здравствуйте! Мне в приложении нужно организовать обработку изображений (преобразование в различный цветовые системы, добавления эффектов сепии, негатива, полутонов, и т.д.). Но перерыв весь интернет за несколько дней нашел только как сделать негатив. Что и самому догадаться не сложно. Может кто подскажет где можно найти материал по данному вопросу в интернете? Если нет с примерами на данном...
C# DataGridView Loader Привет всем! Мне хотелось бы реализовать программу с DataGridView То есть чтобы при нажатии на кнопку "Load" открывался "OpenFileDialog" и открывал файл .txt. В файле .txt записи: База: New Должность: New И при нажатии кнопки Load в DataGridView загружался этот файл и отображалось это: База: New https://www.cyberforum.ru/ csharp-net/ thread173964.html	C# Программа поиска в реестре Ребят, вот делаю сейчас точную копию редактора реестра виндовс Многие решения уже сделал, но никак не могу понять даже сам принцип, по которому работает поиск в реестре Кто сталкивался, подскажите плиз, какой алгоритм реализовывать? Или быть может есть примеры какие? а то углубляюсь в кучу рекурсий и то и дело постоянно сталкиваюсь с тем, что теряю ссылки на ключи, понимаю что вызвано это...
C# Трудности с отображением шрифта https://www.cyberforum.ru/ csharp-net/ thread173843.html Пишу программу и возникла проблема, заключается в том что мне надо использовать определенный, внутрифирменный шрифт, который в среде Visual Studio и в документе Word выглядит немного по разному, т.е. в ворде выглядит отлично в любом размере, в обычном блокноте а также в visual studio выглядит более менее приемлимо только начиная с размера в 14 , меньше - выглядит коряво, но в любом случае видны...	C# Работа с XML - файлом Необходимо считывать данную структуру XML-файла для дальнейшей работы с ней, а затем сохранять при создании в моем случае новой записи, т.е записывать в файл, в точно таком же виде. Структура XML-файла представлена ниже. Меня интересует в чем и как можно хранить данную структуру, в массиве, в листе, и как именно. Можно конечно сделать просто, взять и каждому файлу сделать соответствие Имя... https://www.cyberforum.ru/ csharp-net/ thread173748.html
Как ассоциировать расширение со своим приложением и открыть файл своей программой C# На последней стадии реализации своей программы задался вопросом. А как сделать так, что бы при открытии определённого файла, он открывался бы в программе? Суть в том, что делаю Music Player и хотелось бы сделать так, что бы когда открываю музыкальный файл из проводника, он открывался бы программой и воспроизводился. Никто не знает ли как реализовать это? :)	C# Реализация ГОСТ Р 34.10-2001 https://www.cyberforum.ru/ csharp-net/ thread173565.html Нужно реализовать стандар Электроной цифровой подписи ГОСТ Р 34.10-2001 на C# (windows form application). Имею множество отдельных классов реализующих даный ГОСТ также есть проект на C# но консольный и работающий некоректно все матириалы если нужно скину. Вот что нужно получить но коечто доработать а именно: 1. параметры должны генерироваться (ключ подписи) 2. должен показоваться хеш код...