что такое сигнатура в программировании простыми словами
Функциональное мышление. Часть 8
Привет, Хабр! Мы с небольшим запозданием возвращаемся с новогодних каникул с продолжением нашей серии статей про функциональное программирование. Сегодня расскажем про понимание функций через сигнатуры и определение собственных типов для сигнатур функций. Подробности под катом!
Не очевидно, но в F# два синтаксиса: для обычных (значимых) выражений и для определения типов. Например:
Выражения для типов имеют особый синтаксис, который отличается от синтаксиса обычных выражений. Вы могли заметить множество примеров этого синтаксиса во время работы с FSI (FSharp Interactive), т.к. типы каждого выражения выводятся вместе с результатами его выполнения.
Как вы знаете, F# использует алгоритм вывода типов, поэтому зачастую вам не надо явно прописывать типы в коде, особенно в функциях. Но для эффективной работы с F# необходимо понимать синтаксис типов, что бы вы смогли определять свои собственные типы, отлаживать ошибки приведения типов и читать сигнатуры функций. В этой статье я сосредоточусь на использовании типов в сигнатурах функций.
Вот несколько примеров сигнатур с синтаксисом типов:
Понимание функций через сигнатуры
Часто, даже просто изучив сигнатуру функции, можно получить некоторое представление о том, что она делает. Рассмотрим несколько примеров и проанализируем их по очереди.
Поиск библиотечных методов при помощи сигнатур
Сигнатуры функций очень важны в поиске библиотечных функций. Библиотеки F# содержат сотни функций, что поначалу может сбивать с толку. В отличие от объектно-ориентированных языков, вы не можете просто «войти в объект» через точку, чтобы найти все связанные методы. Но если вы знаете сигнатуру желаемой функции, вы быстро сможете сузить круг поисков.
Например, у вас два списка, и вы хотите найти функцию комбинирующую их в один. Какой сигнатурой обладала бы искомая функция? Она должна была бы принимать два списка в качестве параметров и возвращать третий, все одного типа:
Теперь перейдем на сайт документации MSDN для модуля List, и поищем похожую функцию. Оказывается, существует лишь одна функция с такой сигнатурой:
Определение собственных типов для сигнатур функций
Когда-нибудь вы захотите определить свои собственные типы для желаемой функции. Это можно сделать при помощи ключевого слова «type»:
В дальнейшем вы можете использовать эти типы для ограничения значений параметров функций.
Например, второе объявление из-за наложенного ограничения упадет с ошибкой приведения типов. Если мы его уберём (как в третьем объявлении), ошибка исчезнет.
Проверка понимания сигнатур функций
Хорошо ли вы понимаете сигнатуры функций? Проверьте себя, сможете ли вы создать простые функции с сигнатурами ниже. Избегайте явного указания типов!
Дополнительные ресурсы
Для F# существует множество самоучителей, включая материалы для тех, кто пришел с опытом C# или Java. Следующие ссылки могут быть полезными по мере того, как вы будете глубже изучать F#:
Также описаны еще несколько способов, как начать изучение F#.
И наконец, сообщество F# очень дружелюбно к начинающим. Есть очень активный чат в Slack, поддерживаемый F# Software Foundation, с комнатами для начинающих, к которым вы можете свободно присоединиться. Мы настоятельно рекомендуем вам это сделать!
Не забудьте посетить сайт русскоязычного сообщества F#! Если у вас возникнут вопросы по изучению языка, мы будем рады обсудить их в чатах:
Об авторах перевода
Автор перевода @kleidemos
Перевод и редакторские правки сделаны усилиями русскоязычного сообщества F#-разработчиков. Мы также благодарим @schvepsss и @shwars за подготовку данной статьи к публикации.
Что такое сигнатура функции? Signature (сигнатура) — это что?
Сигнатура — это часть общего объявления функции, которая позволяет средствам трансляции выполнять идентификацию этой самой функции среди других. В разных языках программирования есть различные представление о сигнатуре (signature).
Сигнатура (signature): какая она бывает?
Существует как сигнатура реализации, так и сигнатура вызова (обычно эти понятия различают).
Signature вызова в большинстве случаев формируется из синтаксической конструкции вызова функции, при этом учитывается сигнатура области её видимости, а также имя функции и последовательность фактических типов аргументов в самом вызове и в типе результата.
Signature в разных языках программирования
В языке программирования С++ простая функция распознаётся компилятором по последовательности типов её аргументов и её имени, что и составляет в данном языке сигнатуру или сигнату функции. И если функция — это метод некоторого класса, то в Signature участвует и имя класса.
Если говорить о языке программирования Java, то тут сигнатура метода составляется из его имени и последовательности типа параметров. То есть тип значение в signature не участвует.
Однако давайте подробнее остановимся на том, зачем нужна сигнатура в JavaScript.
Signature в JavaScript: особенности применения signature
Когда программист на Javascript овладевает самыми глубокими секретами функционального программирования, он всё чаще встречает стрелки с типом, которые написаны над функциями. Первая мысль: «Что такое? Я же мастер по динамически типизированному Javascript, который свободен от ограничений типов».
На самом деле, всё просто, а такие записи не что иное, как сигнатура типов. С помощью signature можно рассказать о функции, причём сама по себе сигнатура значит в функциональном программировании гораздо больше, чем можно подумать.
Почему Signature полезна в коде?
Signature определяет возвращаемые и входящие типы для функции, включая иногда типы, число и порядок аргументов, которые содержатся в функции. Таким образом, signature используется для отслеживания работы функции.
Сигнатура типов основана на системе Хиндли-Милнера. Если вы обнаружите функцию, которая задокументирована Signature и будете уметь понимать её, это даст вам самое наглядное представление о работе данной функции.
Signature и простые функции
Смотрим пример использования signature:
Собственно говоря, вполне нормально, когда функция имеет множественные signatures, пока это удобно. Но если она становится чересчур гибкой, следует использовать произвольные переменные Хиндли-Милнера.
Выводы о signature
Умение понимать signature полезно как в JavaScript, так и в прочих функциональных языках. И если нам нужно заимствовать любую чистую функцию, мы можем всего лишь обратиться к её signature, чтобы понять, с каким участком кода нам надо работать.
Магические сигнатуры методов в C#
Представляю вашему вниманию перевод статьи The Magical Methods in C# автора CEZARY PIĄTEK.
Есть определенный набор сигнатур методов в C#, имеющих поддержку на уровне языка. Методы с такими сигнатурами позволяют использовать специальный синтаксис со всеми его преимуществами. Например, с их помощью можно упростить наш код или создать DSL для того, чтобы выразить решение проблемы более красивым образом. Я встречаюсь с такими методами повсеместно, так что я решил написать пост и обобщить все мои находки по этой теме, а именно:
Синтаксис инициализации коллекций
Синтаксис инициализации коллекции довольно старая фича, т. к. она существует с C# 3.0 (выпущен в конце 2007 года). Напомню, синтаксис инициализации коллекции позволяет создать список с элементами в одном блоке:
Этот код эквивалентен приведенному ниже:
Возможность использования синтаксиса инициализации коллекции не ограничивается только классами из BCL. Он может быть использован с любым типом, удовлетворяющим следующим условиям:
Мы можем добавить поддержку синтаксиса инициализации коллекции, определив Add как метод расширения:
Этот синтаксис также можно использовать для вставки элементов в поле-коллекцию без публичного сеттера:
Синтаксис инициализации коллекции полезен при инициализации коллекции известным числом элементов. Но что если мы хотим создать коллекцию с переменным числом элементов? Для этого есть менее известный синтаксис:
Такое возможно для типов, удовлетворяющих следующим условиям:
Благодаря этому мы можем написать следующее:
Или даже собрать коллекцию из смеси индивидуальных элементов и результатов нескольких перечислений (IEnumerable):
Без подобного синтаксиса очень сложно получить подобный результат в блоке инициализации.
Синтаксис инициализации словарей
Одна из крутых фич C# 6.0 — инициализация словаря по индексу, которая упростила синтаксис инициализации словарей. Благодаря ей мы можем писать более читаемый код:
Этот код эквивалентен следующему:
Это немного, но это определенно упрощает написание и чтение кода.
Лучшее в инициализации по индексу — это то, что она не ограничивается классом Dictionary и может быть использована с любым другим типом, определившим индексатор:
Деконструкторы
В C# 7.0 помимо кортежей был добавлен механизм деконструкторов. Они позволяют декомпозировать кортеж в набор отдельных переменных:
Что эквивалентно следующему:
Этот синтаксис позволяет обменять значения двух переменных без явного объявления третьей:
Или использовать более краткий метод инициализации членов класса:
Деконструкторы могут быть использованы не только с кортежами, но и с другими типами. Для использования деконструкции типа этот тип должен реализовывать метод, подчиняющийся следующим правилам:
Для нашего типа Point мы можем объявить деконструктор следующим образом:
Пример использования приведен ниже:
«Под капотом» он превращается в следующее:
Деконструкторы могут быть добавлены к типам с помощью методов расширения:
Пользовательские awaitable типы
Это может быть переписано намного красивее с использованием синтаксиса async/await :
Вы можете спросить: «Каков возможный сценарий использования синтаксиса await с пользовательским awaitable типом?». Если это так, то я рекомендую вам прочитать статью Stephen Toub под названием «await anything», которая показывает множество интересных примеров.
Паттерн query expression
Разумеется, мы не обязаны реализовывать все эти методы для того, чтобы использовать синтаксис LINQ с нашим пользовательским типом. Список обязательных операторов и методов LINQ для них можно посмотреть здесь. Действительно хорошее объяснение того, как это сделать, можно найти в статье Understand monads with LINQ автора Miłosz Piechocki.
Подведение итогов
Цель этой статьи заключается вовсе не в том, чтобы убедить вас злоупотреблять этими синтаксическими трюками, а в том, чтобы сделать их более понятными. С другой стороны, их нельзя всегда избегать. Они были разработаны для того, чтобы их использовать, и иногда они могут сделать ваш код лучше. Если вы боитесь, что получившийся код будет непонятен вашим коллегам, вам нужно найти способ поделиться знаниями с ними (или хотя бы ссылкой на эту статью). Я не уверен, что это полный набор таких «магических методов», так что если вы знаете еще какие-то — пожалуйста, поделитесь в комментариях.
Сигнатура
Сигнатура (лат. signature — обозначать, указывать).
Информатика
Математика
Военное дело
Полиграфия
См. также
 | Список значений слова или словосочетания со ссылками на соответствующие статьи. Если вы попали сюда из другой статьи Википедии, пожалуйста, вернитесь и уточните ссылку так, чтобы она указывала на статью. |
Полезное
Смотреть что такое «Сигнатура» в других словарях:
СИГНАТУРА — (лат., от signum знак). 1) аптечный ярлык на стеклянках и коробках с лекарствами, выдаваемыми по рецепту, на которых пишется самый рецепт, а также имя больного и порядок приёма. 2) знак, буква, ставящаяся внизу на первой странице каждого печ.… … Словарь иностранных слов русского языка
СИГНАТУРА — СИГНАТУРА, сигнатуры, жен. 1. Обозначение в рецепте, как больной должен принимает данное лекарство (апт.). Название лекарства пишется по латыни, а сигнатура по русски. 2. Бумажный ярлычок с копией рецепта врача, прилагаемый аптекой к лекарству… … Толковый словарь Ушакова
сигнатура — нумерация, копия, сигнатурка, рецепт Словарь русских синонимов. сигнатура сущ., кол во синонимов: 6 • копия (41) • … Словарь синонимов
СИГНАТУРА — в медицине 1) часть рецепта с указанием способа употребления лекарства.2) Копия рецепта, прилагаемая к выданному аптекой лекарству … Большой Энциклопедический словарь
СИГНАТУРА — (средневековое лат. signatura знак от лат. signo указываю, обозначаю), в полиграфии последовательная нумерация печатного листа, проставляемая арабскими цифрами на 1 й и 3 й его полосах (в нижнем левом углу) … Большой Энциклопедический словарь
СИГНАТУРА — СИГНАТУРА, ы, жен. (спец.). Часть рецепта с указанием способа употребления лекарства, а также копия рецепта, прилагаемая аптекой к изготовленному лекарству. | уменьш. сигнатурка, и, жен. | прил. сигнатурный, ая, ое. Толковый словарь Ожегова. С.И … Толковый словарь Ожегова
сигнатура — Порядковый номер печатного листа, проставляемый перед нормой в левом углу нижнего поля первой страницы каждого печатного листа и повторяемый на третьей странице со звездочкой, набранной на верхнюю линию шрифта, уже без нормы. [ГОСТ Р 7.0.3 2006]… … Справочник технического переводчика
Сигнатура — порядковый номер печ. л., проставляемый перед нормой в нижнем поле первой страницы каждого печ. л. и повторяемый на третьей странице каждого л. со звездочкой, набранной на верхнюю линию шрифта, уже без нормы. С. служит для контроля за… … Издательский словарь-справочник
Сигнатура — (от лат. signatura обозначать, указывать) 1) порядковый номер печатного листа издания, проставляемый в левом нижнем углу на первой странице листа вместе с нормой и на третьей странице со звездочкой; 2) обозначение тетрадей в книжно журнальном… … Реклама и полиграфия
ОГЛАВЛЕНИЕ
1. Сигнатуры (продолжение)
Здесь приведено продолжение первой части.
1.1 LocalVarSig
Сигнатура LocalVarSig также индексируется столбцом StandAloneSig.Signature, он хранит тип всех локальных переменных, выделенных во время выполнения метода. Элемент LOCAL_SIG является прологом сигнатуры и имеет постоянное значение 0x07, элемент Count является сжатым беззнаковым целым, хранящим количество локальных переменных, принадлежащих связанному с ними методу, элемент BYREF является сокращением константы ELEMENT_TYPE_BYREF (смотрите константы в первой части) и показывает, что элемент Type(тип) указывает на реальную переменную. Элемент Constraint(ограничение) показывает, что целевой тип не будет перемещаться сборщиком мусора при выполнении восстановления памяти, так как локальные переменные находятся в стеке (где сборщик мусора не выполняет никаких действий), Type(тип) переменной должен быть ссылочным типом (как System.Object – выделяется в куче) или типом значения (как System.Decimal – выделяется в стеке), но если целевой тип (закрепленный) является типом значения, его определение должно содержать элемент BYREF, в данном случае ссылка на переменную хранится в стеке, но сама переменная выделяется в куче. Более подробно о закреплении рассказано здесь. На рисунке 1 ниже показана полная схема синтаксиса для этой сигнатуры.
Обратите особое внимание на элемент TYPEDBYREF на схеме ниже: это типизированная ссылка, она содержит не только управляемый указатель (как нормальная ссылка) на адрес, но и динамическое представление данных. Процитируем описание элемента из спецификации: «Сигнатура локальной переменной типизированной ссылки указывает, что локальная переменная будет содержать управляемый указатель на адрес и динамическое представление типа, хранящиеся по этому адресу. Сигнатура типизированной ссылки похожа на константу byref, но тогда как byref определяет тип как часть ограничения byref (и, стало быть, статически как часть описания типа), типизированная ссылка динамически предоставляет информацию о типе. Типизированная ссылка, по сути, является полной сигнатурой и не сочетается с другими ограничениями. В частности, невозможно задать byref, тип которого является типизированной ссылкой».
Рисунок 1. Схема синтаксиса сигнатуры LocalVarSig
Пример 1
Данный пример показывает объявление типов значений byref в стеке (только), пример кода написан на языке CIL (общий промежуточный язык) и выглядит так.
Сигнатура LocalVarSig для этого примера кода приведена в таблице ниже.
Смещение
Значение
Что означает
пролог сигнатуры (константа LOCAL _ SIG ).
Общее число переменных, объявленных в этом методе, равняется одной.
Тип переменной ( int 32 ), смотрите константы в первой части.
Пример 2
Пример ниже показывает, что происходит с сигнатурой при использовании типизированной ссылки: в начале объявляется переменная IntVar, в следующей строке получается типизированная ссылка с помощью ключевого слова __makeref (недокументировано и не совместимо с CLS) и сохраняется в переменной TypedByRefVar.
LocalVarSig для этого примера выглядит, как показано ниже.
Смещение
Значение
Что означает
пролог сигнатуры (константа LOCAL _ SIG )
Общее число переменных, объявленных в этом методе, равняется двум.
Тип первой переменной ( int 32 ), смотрите константы в первой части.
Тип второй переменной ( TYPEDBYREF ), смотрите константы в первой части.
Пример 3
Рассмотрим немного более сложный пример: в этом примере кода создается класс TestDataClass, имеющий лишь один член по имени StringVarToBePinned типа string(строка). В методе TestMethod (помеченный как unsafe) создается экземпляр класса TestDataClass, в строке ниже закрепляется член StringVarToBePinned и ссылка на него присваивается указателю FixedVar с помощью ключевого слова fixed. Такая обработка гарантирует, что между фигурными скобками <и>член dataClass.StringVarToBePinned не будет перемещаться действиями сборщика мусора, а значит, указатель FixedVar на член всегда будет действителен внутри фигурных скобок ключевого слова fixed. В методе нельзя непосредственно объявить переменную, которая будет закреплена, потому что такое значение уже закреплено (помещено в стек), поэтому переменная должна быть обернута классом TestDataClass (помещенным в кучу).
Данный пример сложен еще по одной причине: в какой-то момент он использует еще не описанный элемент, то есть TypeDefOrRefEncoded, этот элемент определяет, в какой строке и в какой таблице метаданных (TypeDef, TypeRef или TypeSpec) описан заданный тип. Здесь эти элементы детально не разбираются, если хотите – перейдите сразу к описанию этого элемента в подразделе 5.2 TypeDefOrRefEncoded в следующем разделе. LocalVarSig для вышеприведенного кода рассмотрена в таблице ниже.
Смещение
Значение
Что означает
пролог сигнатуры (константа LOCAL _ SIG )
Общее число переменных, объявленных в этом методе, равняется трем.
Тип указателя из предыдущего байта ( char – в конце это char * ), смотрите константы в первой части.
Третья переменная закреплена, смотрите константы.
Тип третьей закрепленной переменной ( string ), смотрите константы.
1.2 CustomAttrib
Рисунок 2a. Схема синтаксиса сигнатуры CustomAttrib
Рисунок 2b. Схема синтаксиса сигнатуры CustomAttrib
Рисунок 2c. Схема синтаксиса сигнатуры CustomAttrib
Пожалуй, эта часть – самая непонятная из всех четырех. Формат, принимаемый Elem, зависит от следующих условий (взято из спецификации).
Если тип параметра простой (первая линия на схеме выше) (bool, char, float32, float64, int8, int16, int32, int64, unsigned int8,unsigned int16, unsigned int32 или unsigned int64), то ‘блоб’ содержит его двоичное значение (Val). (bool – один байт со значением 0 (false) или 1 (true); char – двухбайтный символ Юникод; а остальные имеют свой очевидный смысл.) Данная схема также используется, если тип параметра – enum – хранит значение целого типа, лежащего в основе enum(перечисление).
Рисунок 2d. Схема синтаксиса сигнатуры CustomAttrib
Последняя часть показывает формат элемента NamedArg, являющегося именованным аргументом (полем или свойством). Так как поля и свойства могут иметь одинаковое имя, первым элементом является FIELD, имеющее постоянное однобайтовое значение 0x53, если именованный параметр ссылается на поле или PROPERTY, имеющее постоянное однобайтовое значение 0x54, если именованный параметр ссылается на свойство. Далее идет элемент FieldOrPropType, описывающий тип именованного свойства или поля в одном или двух байтах: если тип именованного параметра – распакованный простой тип значения (определен выше), то FieldOrPropType должен содержать ровно одно постоянное значение связанного с ним типа (BOOLEAN, CHAR, I1, U1, I2, U2, I4, U4, I8, U8, R4, R8, STRING – смотрите таблицу констант в первой части), но если тип именованного параметра – упакованный простой тип значения, то перед элементом FieldOrPropType стоит байт, содержащий значение 0x51, в этом случае FieldOrPropType занимает два байта. Элемент FieldOrPropName является SerString (объяснен выше), содержащим имя свойства или поля. В конце идет один элемент FixedArg, показанный выше. Элемент NamedArg является нормальным FixedArg, перед которым стоит некоторая дополнительная информация, указывающая, какое поле или свойство он обозначает.
Пример 1
Данный пример показывает формат элемента SerString и как CustomAttrib различает поля и свойства, служащие именованными параметрами. В примере ниже имеется атрибут TestAttribute, требующий передачи одного фиксированного параметра Fixed1 типа int32, дополнительно можно (и это делается) передать два дополнительных именованных параметра типа int16 и string, как показано в куске кода ниже.
Полная сигнатура CustomAttrib для этого случая имеет длину 33 байта, поэтому в некоторых точках несколько байтов были объединены в одну строку с общим описанием.