Атрибут и параметр в чем разница
Инструменты пользователя
Инструменты сайта
Содержание
2.9 Введение в атрибуты параметров
1. Понятие о атрибутах
Атрибуты — это информационные признаки (свойства) объектов. Например, атрибут солдата — автомат. А атрибут почтальона — специальная сумка для писем и газет. По сути, атрибуты — это свойства. И часть свойств переменных и процедур программы выносится за понятие свойства во многих распространённых компилируемых языках (например, Си или Ассемблер), так как на этапе исполнения программе либо не нужно знать об этих свойствах, либо узнать о них она не может (ограниченные свойства интроспекции — возможности программы рассматривать своё устройство во время работы). Атрибуты параметров в КП играют важную роль, которая связана с компонентностью. Они позволяют задать правила взаимодействия частей программы, как во время её написания, так и во время её работы. Атрибуты параметров (переменных процедур) частично относятся к метаинформации (информации выходящей за рамки самой программы, это как бы надинформация). В официальной информации по языку Компонентный Паскаль атрибуты называются описатели (несколько общее понятие, так как сама программа является тем же описателем). [↑]
2. Процедура с параметрами без атрибутов
Такой тип процедур был рассмотрен многократно. Например, в процедуре Start* нет никаких параметров, и это допустимо. Но чаще можно встретить объявление процедур в виде:
Параметры, у которых нет никаких атрибутов, кроме описателя их типа в КП принято называть параметры-значения. Внутри процедур с такими параметрами можно делать всё, что угодно, они не изменяют значение исходной переменной, так как копии аргументов создаются локально при вызове процедуры. Их можно вернуть вызывающему участку кода с помощью оператора RETURN. Поскольку на вход процедуры что-то должно быть передано обязательно — начальное значение не инициализируется, в отличии от глобальных переменных, которые инициализуруются нулём, либо NIL, либо строкой с нулевой длиной. [↑]
3. Атрибут IN
Атрибут IN используется в КП чтобы была возможность использовать параметры-переменные в процедурах только на чтение. Причём атрибут IN может быть применён только для записей или массивов. Это своего рода задаваемая пользователем составная/массивовая константа уровня процедуры сложного типа (т. е. не базового — INTEGER, REAL, CHAR и т. д.).
Как видно из примера, при попытке его скомпилировать, посыпятся сообщения об ошибках. И всё именно потому, что параметр с атрибутом IN доступен только для чтения. К тому же, параметр «а» определён как INTEGER, а допустимые типы — записи или массивы. [↑]
4. Атрибут OUT
Может возникнуть необходимость возвращать какие-либо данные из процедуры. Нет никаких проблем, если такой параметр один. Можно использовать ключевое слово RETURN. Если необходимо возвращать множество однотипных значений, можно вернуть ссылку на массив. Что делать, если требуется вернуть несколько значений разных типов? Вот тут и приходит на помощь атрибут параметра процедуры OUT. Посколько такие параметры работают только «на выход», OUT-параметры, как и локальные переменные устанавливаются компилятором в NIL, если это указательные или процедурные типы. Если это другие типы, то надо позаботиться, чтобы процедура возвращала правильные значения (а иначе зачем вообще описывать OUT-параметры?).
Пример ниже показывает как работать с такими параметрами:
Как видно из примера, попытка скомпилировать модуль, с вызовом пройцедуры Do закончилась крахом, так как, в качестве аргументов передаются константы, а не переменные. По возврате из процедуры, чему присваивать возвращаемые значения? В примере, представленном ниже, все ошибки устранены и модуль успешно компилируется:
Оператор RETURN мог бы возвращать несколько значений, во многих языках программирования такой функционал реализован. Но лучше оператор RETURN рассматривать как оператор управления потоком, с возможностью возврата кода выполнения операции, а не штатную возможность возвращать результат операций. Также стоит отметить, что возврат результата требует больше накладных расходов, чем непосредственное изменение переменной.
Отсюда следует понимать для чего нужны OUT-параметры и ключевое слово RETURN:
5. Атрибут VAR
Этот атрибут параметра процедуры позволяет делать с передаваемой переменной всё что угодно. Как принято называть такую передачу в программировании: по ссылке. Все изменения произведённые над такой переменной будут отражены на той переменной, которая была указана в качестве аргумента параметра процедуры. VAR-параметры подобны гуляй-ветру в поле: отследить изменение переменной становится гораздо сложнее, и для контроля за её значением следует использовать контрольные инструкции (использовать эти инструкции, вообще говоря, хороший тон в программировании), речь о которых пойдёт в отдельной главе. Также стоит отметить, что атрибут VAR употреблялся для привязки к типу данных метода через передачу скрытой ссылки на описатель этого типа данных. Различия в привязке методов к типам будут описаны отдельно. [↑]
6. Выводы
Задание атрибутов параметрам функций позволяет более точно управлять приложением. Промышленное программирование требует особого контроля в вопросах обращения к структурам данных. Описанные атрибуты частично входят в вопросы метапрограммирования, уточняют принципы ООП в динамических системах. IN, OUT и VAR-параметры позволяют расширить классический процедурный стиль в разумных пределах, ровно столько, сколько это может требоваться на практике, и при этом, не усложнять семантику Компонентного Паскаля. [↑]
Атрибуты C#: обо всех аспектах
Здравствуй, читатель. В этой статье описаны атрибуты со всех сторон — начиная от спецификации, смысла и определения атрибутов, создания собственных и работе с ними, заканчивая добавлением атрибутов на рантайме и наиболее полезными и интересными существующими атрибутами. Если вам интересна тема атрибутов в C#, то добро пожаловать под кат.
Содержание
Введение
Как всегда, начнем с определений и спецификаций. Это поможет понять и осознать атрибуты на всех уровнях, что, в свою очередь, очень полезно для того, чтобы находить им правильные применения.
С синтаксической точки зрения (в метаданных) есть следующие атрибуты
Пример
Как видно StructLayoutAttribute имеет специальный синтаксис, так как в IL он представлен как «explicit». ObsoleteAttribute использует общий синтаксис — в IL начинается с «.custom». SecurityPermissionAttribute как атрибут безопасности превратился в «.permissionset assert».
Пользовательские атрибуты добавляют пользовательскую информацию к метаданным. Этот механизм может использоваться для хранения специфичной для приложения информации во время компиляции и для доступа к ней во время выполнения или для чтения и анализа другим инструментом. Хотя любой определенный пользователем тип может быть использован в качестве атрибута, для соответствия CLS необходимо, чтобы атрибуты наследовались от System.Attribute. CLI предопределяет некоторые атрибуты и использует их для управления поведением во время выполнения. Некоторые языки определяют атрибуты для представления возможностей языка, не представленных непосредственно в CTS.
Как уже упоминалось, атрибуты хранятся в метаданных, которые, в свою очередь, формируются на этапе компиляции, т.е. вносятся в PE файл (как правило *.dll). Таким образом, добавить во время выполнения атрибут можно только модифицируя исполняемый файл во время выполнения (но времена самоизменяющихся программ уже давно в прошлом). Отсюда следует, что на этапе выполнения их добавить нельзя, но это не совсем точно. В случае, если мы формируем свою сборку, определяем в ней типы, то мы можем на этапе выполнения создать новый тип и вешать атрибуты на него. Так что формально, мы все же можем добавлять атрибуты на этапе выполнения (пример будет в самом низу).
А теперь немного об ограничениях
Если по каким-то причинам в одной сборке существует 2 атрибута с именами Name и NameAtribute, то становится невозможным поставить первый из них. При использовании [Name] (т.е. без суффикса) компилятор говорит, что видит неопределенность. При использовании [NameAttribute] мы поставим NameAttribute, что логично. Для такой мистической ситуации с недостатком воображения при именовании существует специальный синтаксис. Чтобы поставить первую версию без суффикса можно указать знак собаки (т.е. [Name] — шутка, так не надо) перед именем атрибута [@Name].
Пользовательские атрибуты могут быть добавлены к чему угодно, кроме пользовательских атрибутов. Имеется в виду метаданные, т.е. если мы ставим в C# атрибут над классом атрибута, то в метаданных он будет относиться к классу. А вот добавить атрибут к «public» нельзя. Зато можно к сборкам, модулям, классам, типам значений, перечислениям (enum), конструкторам, методам, свойствам, полям, событиям, интерфейсам, параметрам, делегатам, возвращаемым значениям или обобщенным параметрам. В примере ниже приведены очевидные и не очень примеры того, как можно поставить атрибут на ту или иную конструкцию.
Атрибуты имеют 2 типа параметров — именованные и позиционные. К позиционным относятся параметры конструктора. К именованным — публичные свойства с доступным сеттером. При этом это не просто формальные названия, все параметры можно указывать при объявлении атрибута в скобках после его названия. Именованные не являются обязательными.
Допустимые параметры (обоих видов) для атрибута должны быть одного из перечисленных типов:
Существует два вида пользовательских атрибутов: подлинные пользовательские атрибуты (genuine custom attributes) и псевдо-пользовательские (pseudo-custom).
В коде они выглядят одинаково (указываются над конструкцией языка в квадратных скобках), но обрабатываются по-разному:
Большинство пользовательских атрибутов введены на уровне языка. Они хранятся и возвращаются рантаймом, при этом рантайм не знает ничего о значении этих атрибутов. Но все псевдо-пользовательские атрибуты плюс некоторые пользовательские атрибуты представляют особый интерес для компиляторов и для CLI. Таким образом мы переходим к следующему разделу.
Атрибуты с поддержкой рантайма
Данный раздел носит чисто информативный характер, если интереса к тому, что использует рантайм нет, то можно скролить к следующему разделу.
В таблице ниже перечислены псевдо-пользовательские атрибуты и специальные пользовательские атрибуты (CLI или компиляторы обрабатывают их специальным образом).
Псевдо-пользовательские атрибуты (их нельзя получить через рефлексию).
CLI Атрибуты:
| Атрибут | Описание |
|---|---|
| AssemblyAlgorithmIDAttribute | Записывает идентификатор используемого алгоритма хеширования. Задает поле Assembly.HashAlgId |
| AssemblyFlagsAttribute | Записывает флаги для соответствующей сборки. Задает поле Assembly.Flags |
| DllImportAttribute | Предоставляет информацию о коде, реализованном в неуправляемой библиотеке. Устанавливает Method.Flags.PinvokeImpl бит соответствующего метода; добавляет новую запись в ImplMap (устанавливая значения MappingFlags, MemberForwarded, ImportName и ImportScope) |
| StructLayoutAttribute | Позволяет явно задать способ размещения полей ссылочного или значимого типа. Устанавливает поле TypeDef.Flags.LayoutMask для типа. Также может устанавливать поля TypeDef.Flags.StringFormatMask, ClassLayout.PackingSize и ClassLayout.ClassSize |
| FieldOffsetAttribute | Определяет смещение в байтах полей в ссылочном или значимом типе. Устанавливает значение FieldLayout.OffSet для соответствующего метода |
| InAttribute | Показывает, что параметр передается как [in] аргумент. Устанавливает Param.Flags.In бит для соответствующего параметра |
| OutAttribute | Показывает, что параметр передается как [out] аргумент. Устанавливает Param.Flags.Out бит для соответствующего параметра |
| MarshalAsAttribute | Определяет способ маршалинга данных между управляемым и неуправляемым кодом. Устанавливает Field.Flags.HasFieldMarshal бит для поля (или Param.Flags.HasFieldMarshal бит для параметра); Добавляет запись в таблицу FieldMarshal (устанавливая значения Parent и NativeType) |
| MethodImplAttribute | Определяет детали реализации метода. Устанавливает значение Method.ImplFlags для соответствующего метода |
CLS Атрибуты — языки должны поддерживать их:
| Атрибут | Описание |
|---|---|
| AttributeUsageAttribute | Используется для указания, как атрибут может быть использован |
| ObsoleteAttribute | Показывает, что элемент не должен использоваться |
| CLSCompliantAttribute | Указывает, объявлен ли элемент как CLS-совместимый |
| Атрибут | Описание |
|---|---|
| ThreadStaticAttribute | Предоставляет поля типа, относящиеся к потоку |
| ConditionalAttribute | Помечает метод как вызываемый, опираясь на условие компиляции (указанное в /define). Если условие не соблюдено, то метод не вызовется (И не будет скомпилирован в IL). Может быть помечен только void метод. В противном случае возникнет ошибка компиляции |
| DecimalConstantAttribute | Сохраняет значение константы типа decimal в метаданных |
| DefaultMemberAttribute | Определяет член класса, который будет использоваться по умолчанию методом InvokeMember |
| CompilationRelaxationsAttribute | Указывает, являются ли исключения из проверок инструкций строгими или смягченными. На текущий момент можно передать только параметр NoStringInterning, который помечает сборку как не требующую интернирования строковых литералов. Но этот механизм все еще может использоваться |
| FlagsAttribute | Атрибут, указывающий, должен ли enum восприниматься как битовые флаги |
| IndexerNameAttribute | Указывает имя, под которым индексатор будет известен в языках программирования, которые не поддерживают такую возможность напрямую |
| ParamArrayAttribute | Показывает, что метод принимает переменное число параметров |
Полезные атрибуты
Неотъемлемой частью разработки программного продукта является отладка. И зачастую в большой и сложной системе требуется десятки и сотни раз запускать один и тот же метод и наблюдать за состоянием объектов. При этом на раз 20 уже начинает конкретно бесить необходимость разворачивать один объект вглубь раз 400, чтоб увидеть значение одной переменной и перезапустить метод заново.
Для более спокойной и быстрой отладки можно использовать атрибуты, модифицирующие поведение отладчика.
DebuggerDisplayAttribute указывает, как отображается тип или его член в окне переменных отладчика (ну и не только).
Единственным аргументом конструктора является строка с форматом отображения. То, что будет находиться между фигурными скобками, будет вычислено. Формат как у интерполированной строки, только без доллара. Нельзя использовать указатели в вычисляемом значении. Кстати, если у вас есть переопределенный ToString, то его значение будет показываться как если бы оно было в этом атрибуте. Если есть и ToString и атрибут, то значение берется из атрибута. 
DebuggerBrowsableAttribute определяет способ отображения поля или свойства в окне переменных отладчика. Принимает DebuggerBrowsableState, который имеет 3 опции:
DebuggerTypeProxy — если объект просматривается в отладчике сотни раз в день, то можно заморочиться и потратить минуты 3 на создание прокси объекта, который отобразит исходный объект как надо. Обычно прокси объект для отображения — внутренний класс. Собственно, он и будет отображаться вместо целевого объекта.
Другие полезные атрибуты
ThreadStatic — атрибут позволяющий сделать статическую переменную своей для каждого потока. Для этого надо поставить атрибут над статическим полем. Стоит помнить важный нюанс — инициализация статическим конструктором будет выполнена только один раз, и переменная поменяется в том потоке, который выполнит статический конструктор. В остальных она останется дефолтной. (ЗЫ. Если вам необходимо такое поведение, советую взглянуть в сторону класса ThreadLocal).
InternalsVisibleTo — позволяет указать сборку, которой будут видны элементы, помеченные internal. Может показаться, что если какой-то сборке нужны определенные типы и их члены, можно просто пометить их public и не париться. Но хорошая архитектура подразумевает сокрытие деталей имплементации. Тем не менее они могут понадобиться для каких-нибудь инфраструктурных вещей, например, тестовых проектов. С помощью этого атрибута можно поддерживать и инкапсуляцию, и требуемый процент покрытия тестами.
HandleProcessCorruptedStateExceptions — позволяет отпугивать робких программистов и ловить исключения поврежденного состояния. По умолчанию для таких исключений CLR не выполняет отловки. В общем случае лучшим выходом будет как раз позволить приложению упасть. Это опасные исключения, показывающие, что память процесса повреждена, так что использование данного атрибута — идея очень плохая. Но возможно в некоторых случаях, для локальной разработки будет полезно на некоторое время поставить данный атрибут. Чтобы словить исключение поврежденного состояния, достаточно просто поставить этот атрибут над методом. И если уже дошло до использования этого атрибута, то рекомендуется (впрочем, как и всегда) отлавливать какое-то конкретное исключение.
DisablePrivateReflection — делает все приватные члены сборки недосягаемыми для рефлексии. Атрибут ставиться на сборку.
Определение своего атрибута
Не просто так этом раздел стоит последним. Ведь лучший способ понять, в каких случаях будет выгодно использовать атрибут — посмотреть на уже используемые. Сложно сказать формализованное правило, когда следует задуматься о собственном атрибуте. Зачастую их используют как дополнительную информацию о типе/его члене или другой конструкции языка, которая бывает общей у совершенно разных сущностей. Как пример — все атрибуты, используемые для сериализации/ОРМ/форматирования и тд. Из-за обширного применения данных механизмов к совершенно разным типам, зачастую не известным разработчикам соответствующего механизма, использование атрибутов — отличный способ дать пользователю возможность предоставлять декларативную информацию для данного механизма.
Использование своих атрибутов можно разделить на 2 части:
Создание атрибута и его использование
Для создания своего атрибута достаточно наследоваться от System.Attribute. При этом желательно придерживаться упомянутого стиля именования — заканчивать имя класса на Attribute. При этом никакой ошибки не будет, если опустить этот суффикс. Как упоминалось ранее, атрибуты могут иметь 2 типа параметров — позиционные и именованные. Логика их применения такая же, как и со свойствами и параметрами конструктора у класса — значения, необходимые для создания объекта, для которых не существует разумного «дефолта» выносятся в позиционные (т.е. конструктор). То, чему можно поставить какой-то разумный дефолт, который будет зачастую использован, лучше выделить в именованный (т.е. свойство).
Немаловажным в создании атрибута является ограничение мест его применения. Для этого используется AttributeUsageAttribute. Обязательным параметром (позиционным) является AttributeTarget, определяющий место использования атрибута (метод, сборка и тд). Необязательными (именованными) параметрами являются:
Метод (функция) — тоже информация и тоже может описывать конструкцию. И используя полиморфизм в атрибутах можно предоставить весьма мощный и удобный инструмент, где пользователь сможет влиять как на информацию, используемую вашим инструментом, так и на определенные этапы выполнения и обработки. При этом ему не надо будет плодить классы, внедрять зависимости, стоить фабрики и их интерфейсы, которые будут создавать эти классы. Достаточно будет создать единственный класс-наследник, который инкапсулирует в себе детали работы с элементом, к которому он относится. Но, как правило, достаточно обычного «РОСО» атрибута с парой свойств.
Получение и обработка атрибута
Обработка полученных атрибутов зависит от конкретного случая и может быть сделана абсолютно по-разному. Сложно привести полезные для этого функции и приемы.
Получение атрибутов во время выполнения осуществляется с помощью рефлексии. Для получения атрибута с определенного элемента существуют различные способы.
Но все берет начало от интерфейса ICustomAttributeProvider. Его реализуют такие типы как Assembly, MemberInfo, Module, ParameterInfo. В свою очередь наследниками MemberInfo являются Type, EventInfo, FieldInfo, MethodBase, PropertyInfo.
Интерфейс имеет лишь 3 функции, и они не очень удобные. Они работают с массивами (даже если мы знаем, что атрибут может быть лишь один) и не параметризованы типом (используют object). Поэтому напрямую к функциям этого интерфейса придется обращаться редко (не сказал никогда, потому что не хочу быть категоричным). Для удобства использования существует класс CustomAttributeExtensions, в котором собрано множество методов расширения для всевозможных типов, выполняющих несложные операции по приведению типов, выборке единственного значения и так далее, тем самым освобождая разработчика от данной необходимости. Также эти методы доступны как статические в классе Attribute с полезнейшей функцией игнорирования параметра inherit (для нонконформистов).
Основные используемые функции приведены ниже. Первый параметр, указывающий какой тип расширяет метод, я опустил. Также везде, где указан параметр bool inherit существует перегрузка без него (со значением по умолчанию true). Этот параметр указывает, нужно ли учитывать при выполнении метода атрибуты родительского класса или базового метода (если используется на переопределенном методе). В случае, если в атрибуте inherit = flase, то даже установка его в true не поможет учитывать атрибуты базового класса
| Название метода | Описание |
|---|---|
| GetCustomAttributes (bool inherit) | получает перечисление атрибутов указанного типа. Если атрибут один, вернется перечисление из 1 элемента |
| GetCustomAttribute (bool inherit) | возвращает единственный атрибут указанного типа. Если таких несколько, выбрасывает исключение System.Reflection.AmbiguousMatchException: Multiple custom attributes of the same type found |
| GetCustomAttributes() | возвращает перечисление атрибутов всех типов |
| GetCustomAttributesData() | возвращает перечисление CustomAttributeData, в котором есть свойства позволяющие получить конструктор, параметры (именованные и позиционные), аргументы конструктора |
| IsDefined(Type attrType, bool inherit) | возвращает true, если атрибут объявлен над элементом, false если нет |
Для наглядности предлагаю взглянуть на небольшое демо работы всех упомянутых функций.
Ну и для академического интереса привожу пример определения атрибутов во время выполнения. Данный код не претендует на звание самого красивого и поддерживаемого.
В чем разница между атрибутом и свойством?
Кажется, это означает одно и то же. Но какой термин больше подходит в каком контексте?
В общих терминах (и при обычном использовании английского языка) термины означают одно и то же.
В конкретном контексте HTML/Javascript эти термины путаются, потому что HTML-представление элемента DOM имеет attribute (это термин, используемый в XML для пар ключ/значение, содержащихся в теге), но когда представленные в виде объекта JavaScript, эти атрибуты отображаются в виде объекта свойства.
Чтобы еще больше запутать вещи, изменения в свойствах обычно обновляют атрибуты.
Однако, если вы впоследствии прочитали это свойство, оно будет нормализовано до абсолютного URL, хотя атрибут может быть относительным URL!
Эти слова существовали задолго до появления информатики.
Часто атрибут используется для описания механизма или реальной вещи.
Свойство используется для описания модели.
Например, документ (сидящий на вашем столе) может иметь атрибут, который является черновиком.
Класс, который моделирует документы, имеет свойство указывать, является ли это черновиком. В этом случае собственность захватывает государство.
Точное значение этих терминов будет во многом зависеть от того, на каком языке/системе/вселенной вы говорите.
В HTML/XML атрибут является частью тега со знаком равенства и значением, а свойство ничего не значит, например.
Поэтому нам нужно больше информации о том, какой домен вы обсуждаете.
В этом случае тип и проверенные являются атрибутами. Свойство, тем не менее, является значением этих атрибутов, которое браузер сохраняет внутри элемента DOM. Часто значения атрибутов и свойств равны, вот что делает его таким запутанным.
В этом примере элемент DOM input имеет свойство type со значением «checkbox» и свойство checked со значением true (обратите внимание, что это значение отличается от значения внутри атрибута HTML).
Используя Firebug, вы можете наблюдать за поведением свойств, щелкая элемент и выбирая «DOM view».