PHP: Сигнатура функции
В этом уроке мы научимся работать с сигнатурой функции. Также мы узнаем, как функция принимает и возвращает значения. Мы разберем функции abs() и round() .
Функция abs()
Функция abs() , которая возвращает абсолютное значение, принимает параметр — число. Если вызывать abs() без параметров, то PHP выдаст следующее:
TypeError: abs() expects exactly 1 argument, 0 given Так интерпретатор сообщает, что функция ожидает один параметр, а мы вызвали ее без параметров.
Параметрами abs() могут быть только числа. Если мы попробуем передать в нее строку, это приведет к следующей ошибке:
TypeError: abs(): Argument #1 ($num) must be of type int|float, string given Результат вызова этой функции — тоже всегда число. Другая функция может иметь иное число параметров и другие типы параметров. Например, может существовать функция, которая принимает три параметра: число, строку и еще одно число.
Откуда мы знаем, сколько и каких параметров нужно функции abs() и какого типа будет возврат? Мы посмотрели в сигнатуру этой функции. Сигнатура определяет входные параметры и их типы, а также выходной параметр и его тип.
О функции abs() можно почитать в официальной документации PHP. В разделе «Описание» есть такой текст:
abs(int|float $num): int|float Возвращает абсолютное значение num. Это сигнатура функции и короткое пояснение на русском языке.
Информация расшифровывается так:
- Функция называется abs
- Функция принимает параметр: число (num)
- Функция возвращает число
- Функция возвращает абсолютное значение num
Если параметров больше одного, то передавать их можно только в той последовательности, в которой они определены в сигнатуре. Любая функция возвращает всегда только одно значение. Это ограничение существует на уровне языка, и не может нарушаться.
Аргументы по умолчанию
Рассмотрим функцию round() . Она округляет переданное число:
Мы передали в нее два аргумента: число и точность округления. 0 означает, что округление будет до целого значения.
Чаще всего нужно округлять именно до целого числа, поэтому создатели функции round сделали второй аргумент необязательным и задали ему внутри функции значение по умолчанию 0 . Значит, можно не указывать второй аргумент, а результат будет тем же:
А если нужна другая точность, то можно передать аргумент:
Если функция в PHP принимает необязательные аргументы, то они всегда стоят после обязательных. Их количество может быть любым. Это зависит от самой функции. Но такие аргументы всегда идут рядом и в конце списка аргументов.
Задание
Теперь ваша очередь посмотреть на сигнатуру функции в документации и разобраться, как её использовать. Можете читать документацию на русском языке, но программист обязан уметь читать документацию на английском. Используйте словари или переводчики при необходимости. Лучше сразу привыкать и подтягивать навыки чтения на английском, иначе будут сложности в будущем.
В PHP есть функция ucfirst() . Изучите её сигнатуру на странице https://php.net/manual/ru/function.ucfirst.php.
Напишите программу, которая использует функцию ucfirst() с переменной $text и выводит результат на экран. Значение переменной $text уже определено.
Упражнение не проходит проверку — что делать? ��
Если вы зашли в тупик, то самое время задать вопрос в «Обсуждениях». Как правильно задать вопрос:
- Обязательно приложите вывод тестов, без него практически невозможно понять что не так, даже если вы покажете свой код. Программисты плохо исполняют код в голове, но по полученной ошибке почти всегда понятно, куда смотреть.
В моей среде код работает, а здесь нет ��
Тесты устроены таким образом, что они проверяют решение разными способами и на разных данных. Часто решение работает с одними входными данными, но не работает с другими. Чтобы разобраться с этим моментом, изучите вкладку «Тесты» и внимательно посмотрите на вывод ошибок, в котором есть подсказки.
Мой код отличается от решения учителя ��
Это нормально ��, в программировании одну задачу можно выполнить множеством способов. Если ваш код прошел проверку, то он соответствует условиям задачи.
В редких случаях бывает, что решение подогнано под тесты, но это видно сразу.
Прочитал урок — ничего не понятно ��
Создавать обучающие материалы, понятные для всех без исключения, довольно сложно. Мы очень стараемся, но всегда есть что улучшать. Если вы встретили материал, который вам непонятен, опишите проблему в «Обсуждениях». Идеально, если вы сформулируете непонятные моменты в виде вопросов. Обычно нам нужно несколько дней для внесения правок.
Кстати, вы тоже можете участвовать в улучшении курсов: внизу есть ссылка на исходный код уроков, который можно править прямо из браузера.
Определения
- Сигнатура функции — формальное описание типов аргументов и типа возвращаемого значения функции.
Что такое сигнатура метода в php
Каждое определение класса начинается с ключевого слова class , затем следует имя класса, и далее пара фигурных скобок, которые заключают в себе определение свойств и методов этого класса.
Именем класса может быть любое слово, при условии, что оно не входит в список зарезервированных слов PHP, начинается с буквы или символа подчёркивания и за которым следует любое количество букв, цифр или символов подчёркивания. Если задать эти правила в виде регулярного выражения, то получится следующее выражение: ^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$ .
Класс может содержать собственные константы, переменные (называемые свойствами) и функции (называемые методами).
Пример #1 Простое определение класса
class SimpleClass
// объявление свойства
public $var = ‘значение по умолчанию’ ;
// объявление метода
public function displayVar () echo $this -> var ;
>
>
?>
Псевдопеременная $this доступна в том случае, если метод был вызван в контексте объекта. $this — значение вызывающего объекта.
Внимание
Вызов нестатического метода статически вызывает ошибку Error . До PHP 8.0.0 это привело бы к уведомлению об устаревании, и $this не была бы определена.
Пример #2 Некоторые примеры псевдо-переменной $this
class A
function foo ()
if (isset( $this )) echo ‘$this определена (‘ ;
echo get_class ( $this );
echo «)\n» ;
> else echo «\$this не определена.\n» ;
>
>
>
$a = new A ();
$a -> foo ();
$b = new B ();
$b -> bar ();
Результат выполнения данного примера в PHP 7:
$this определена (A) Deprecated: Non-static method A::foo() should not be called statically in %s on line 27 $this не определена. Deprecated: Non-static method A::foo() should not be called statically in %s on line 20 $this не определена. Deprecated: Non-static method B::bar() should not be called statically in %s on line 32 Deprecated: Non-static method A::foo() should not be called statically in %s on line 20 $this не определена.
Результат выполнения данного примера в PHP 8:
$this определена (A) Fatal error: Uncaught Error: Non-static method A::foo() cannot be called statically in %s :27 Stack trace: #0 thrown in %s on line 27
Классы, доступные только для чтения
Начиная с PHP 8.2.0, класс может быть помечен модификатором readonly . Пометка класса как readonly добавит модификатор readonly к каждому объявленному свойству и предотвратит создание динамических свойств. Более того, невозможно добавить их поддержку с помощью атрибута AllowDynamicProperties . Попытка это сделать приведёт к ошибке компиляции.
#[ \AllowDynamicProperties ]
readonly class Foo >
// Fatal error: Cannot apply #[AllowDynamicProperties] to readonly class Foo
?>
Поскольку ни нетипизированные, ни статические свойства не могут быть помечены модификатором readonly , классы, доступные только для чтения также не могут их объявлять:
// Fatal error: Readonly property Foo::$bar must have type
?>
readonly class Foo
public static int $bar ;
>
// Fatal error: Readonly class Foo cannot declare static properties
?>
Класс readonly может быть расширен тогда и только тогда, когда дочерний класс также является классом readonly .
new
Для создания экземпляра класса используется директива new . Новый объект всегда будет создан, за исключением случаев, когда он содержит конструктор, в котором определён вызов исключения в случае возникновения ошибки. Рекомендуется определять классы до создания их экземпляров (в некоторых случаях это обязательно).
Если с директивой new используется строка ( string ), содержащая имя класса, то будет создан новый экземпляр этого класса. Если имя находится в пространстве имён, то оно должно быть задано полностью.
Замечание:
В случае отсутствия аргументов в конструктор класса, круглые скобки после названия класса можно опустить.
Пример #3 Создание экземпляра класса
// Это же можно сделать с помощью переменной:
$className = ‘SimpleClass’ ;
$instance = new $className (); // new SimpleClass()
?>
Начиная с PHP 8.0.0, поддерживается использование оператора new с произвольными выражениями. Это позволяет создавать более сложные экземпляры, если выражение представлено в виде строки ( string ). Выражения должны быть заключены в круглые скобки.
Пример #4 Создание экземпляра с использованием произвольного выражения
В данном примере мы показываем несколько вариантов допустимых произвольных выражений, которые представляют имя класса. Пример вызова функции, конкатенации строк и константы ::class .
class ClassA extends \stdClass <>
class ClassB extends \stdClass <>
class ClassC extends ClassB <>
class ClassD extends ClassA <>
function getSomeClass (): string
return ‘ClassA’ ;
>
var_dump (new ( getSomeClass ()));
var_dump (new ( ‘Class’ . ‘B’ ));
var_dump (new ( ‘Class’ . ‘C’ ));
var_dump (new ( ClassD ::class));
?>
Результат выполнения данного примера в PHP 8:
object(ClassA)#1 (0) < >object(ClassB)#1 (0) < >object(ClassC)#1 (0) < >object(ClassD)#1 (0)
В контексте класса можно создать новый объект через new self и new parent .
Когда происходит присвоение уже существующего экземпляра класса новой переменной, то эта переменная будет указывать на этот же экземпляр класса. То же самое происходит и при передаче экземпляра класса в функцию. Копию уже созданного объекта можно создать через её клонирование.
Пример #5 Присваивание объекта
$instance = new SimpleClass ();
$assigned = $instance ;
$reference =& $instance ;
$instance -> var = ‘$assigned будет иметь это значение’ ;
$instance = null ; // $instance и $reference становятся null
var_dump ( $instance );
var_dump ( $reference );
var_dump ( $assigned );
?>
Результат выполнения данного примера:
NULL NULL object(SimpleClass)#1 (1) < ["var"]=>string(30) "$assigned будет иметь это значение" >
Создавать экземпляры объекта можно двумя способами:
Пример #6 Создание новых объектов
class Test
static public function getNew ()
return new static;
>
>
class Child extends Test
<>
$obj1 = new Test ();
$obj2 = new $obj1 ;
var_dump ( $obj1 !== $obj2 );
$obj3 = Test :: getNew ();
var_dump ( $obj3 instanceof Test );
$obj4 = Child :: getNew ();
var_dump ( $obj4 instanceof Child );
?>
Результат выполнения данного примера:
bool(true) bool(true) bool(true)
Обратиться к свойству или методу только что созданного объекта можно с помощью одного выражения:
Пример #7 Доступ к свойствам/методам только что созданного объекта
echo (new DateTime ())-> format ( ‘Y’ );
?>
Результатом выполнения данного примера будет что-то подобное:
2016
Замечание: До PHP 7.1 аргументы не имели значения, если не определена функция конструктора.
Свойства и методы
Свойства и методы класса живут в разделённых «пространствах имён», так что возможно иметь свойство и метод с одним и тем же именем. Ссылки как на свойства, так и на методы имеют одинаковую нотацию, и получается, что получите вы доступ к свойству или же вызовете метод — определяется контекстом использования.
Пример #8 Доступ к свойству vs. вызов метода
public function bar () return ‘метод’ ;
>
>
$obj = new Foo ();
echo $obj -> bar , PHP_EOL , $obj -> bar (), PHP_EOL ;
Результат выполнения данного примера:
свойство метод
Это означает, что вызвать анонимную функцию, присвоенную переменной, напрямую не получится. Вместо этого свойство должно быть назначено, например, переменной. Можно вызвать такое свойство напрямую, заключив его в скобки.
Пример #9 Вызов анонимной функции, содержащейся в свойстве
public function __construct () $this -> bar = function() return 42 ;
>;
>
>
echo ( $obj -> bar )(), PHP_EOL ;
Результат выполнения данного примера:
extends
Класс может наследовать константы, методы и свойства другого класса используя ключевое слово extends в его объявлении. Невозможно наследовать несколько классов, один класс может наследовать только один базовый класс.
Наследуемые константы, методы и свойства могут быть переопределены (за исключением случаев, когда метод или константа класса объявлены как final) путём объявления их с теми же именами, как и в родительском классе. Существует возможность доступа к переопределённым методам или статическим свойствам путём обращения к ним через parent::
Замечание: Начиная с PHP 8.1.0, константы можно объявлять окончательными (final).
Пример #10 Простое наследование классов
class ExtendClass extends SimpleClass
// Переопределение метода родителя
function displayVar ()
echo «Расширенный класс\n» ;
parent :: displayVar ();
>
>
$extended = new ExtendClass ();
$extended -> displayVar ();
?>
Результат выполнения данного примера:
Расширенный класс значение по умолчанию
Правила совместимости сигнатуры
При переопределении метода его сигнатура должна быть совместима с родительским методом. В противном случае выдаётся фатальная ошибка или, до PHP 8.0.0, генерируется ошибка уровня E_WARNING . Сигнатура является совместимой, если она соответствует правилам контравариантности, делает обязательный параметр необязательным, добавляет только необязательные новые параметры и не ограничивает, а только ослабляет видимость. Это известно как принцип подстановки Барбары Лисков или сокращённо LSP. Правила совместимости не распространяются на конструктор и сигнатуру private методов, они не будут выдавать фатальную ошибку в случае несоответствия сигнатуры.
Пример #11 Совместимость дочерних методов
class Base
public function foo ( int $a ) echo «Допустимо\n» ;
>
>
class Extend1 extends Base
function foo ( int $a = 5 )
parent :: foo ( $a );
>
>
class Extend2 extends Base
function foo ( int $a , $b = 5 )
parent :: foo ( $a );
>
>
$extended1 = new Extend1 ();
$extended1 -> foo ();
$extended2 = new Extend2 ();
$extended2 -> foo ( 1 );
Результат выполнения данного примера:
Допустимо Допустимо
Следующие примеры демонстрируют, что дочерний метод, который удаляет параметр или делает необязательный параметр обязательным, несовместим с родительским методом.
Пример #12 Фатальная ошибка, когда дочерний метод удаляет параметр
class Base
public function foo ( int $a = 5 ) echo «Допустимо\n» ;
>
>
class Extend extends Base
function foo ()
parent :: foo ( 1 );
>
>
Результат выполнения данного примера в PHP 8 аналогичен:
Fatal error: Declaration of Extend::foo() must be compatible with Base::foo(int $a = 5) in /in/evtlq on line 13
Пример #13 Фатальная ошибка, когда дочерний метод делает необязательный параметр обязательным.
class Base
public function foo ( int $a = 5 ) echo «Допустимо\n» ;
>
>
class Extend extends Base
function foo ( int $a )
parent :: foo ( $a );
>
>
Результат выполнения данного примера в PHP 8 аналогичен:
Fatal error: Declaration of Extend::foo(int $a) must be compatible with Base::foo(int $a = 5) in /in/qJXVC on line 13
Внимание
Переименование параметра метода в дочернем классе не является несовместимостью сигнатуры. Однако это не рекомендуется, так как приведёт к Error во время выполнения, если используются именованные аргументы.
Пример #14 Ошибка при использовании именованных аргументов и параметров, переименованных в дочернем классе
class A public function test ( $foo , $bar ) <>
>
class B extends A public function test ( $a , $b ) <>
>
// Передача параметров согласно контракту A::test()
$obj -> test ( foo : «foo» , bar : «bar» ); // ОШИБКА!
Результатом выполнения данного примера будет что-то подобное:
Fatal error: Uncaught Error: Unknown named parameter $foo in /in/XaaeN:14 Stack trace: #0 thrown in /in/XaaeN on line 14
::class
Ключевое слово class используется для разрешения имени класса. Чтобы получить полное имя класса ClassName , используйте ClassName::class . Обычно это довольно полезно при работе с классами, использующими пространства имён.
Пример #15 Разрешение имени класса
Результат выполнения данного примера:
NS\ClassName
Замечание:
Разрешение имён класса с использованием ::class происходит на этапе компиляции. Это означает, что на момент создания строки с именем класса автозагрузки класса не происходит. Как следствие, имена классов раскрываются, даже если класс не существует. Ошибка в этом случае не выдаётся.
Пример #16 Отсутствует разрешение имени класса
print Does\Not\Exist ::class;
?>
Результат выполнения данного примера:
Does\Not\Exist
Начиная с PHP 8.0.0, константа ::class также может использоваться для объектов. Это разрешение происходит во время выполнения, а не во время компиляции. То же самое, что и при вызове get_class() для объекта.
Пример #17 Разрешение имени объекта
namespace NS class ClassName >
>
$c = new ClassName ();
print $c ::class;
?>
Результат выполнения данного примера:
NS\ClassName
Методы и свойства Nullsafe
Начиная с PHP 8.0.0, к свойствам и методам можно также обращаться с помощью оператора «nullsafe»: ?-> . Оператор nullsafe работает так же, как доступ к свойству или методу, как указано выше, за исключением того, что если разыменование объекта выдаёт null , то будет возвращён null , а не выброшено исключение. Если разыменование является частью цепочки, остальная часть цепочки пропускается.
Аналогично заключению каждого обращения в is_null() , но более компактный.
Пример #18 Оператор Nullsafe
// Начиная с PHP 8.0.0, эта строка:
$result = $repository ?-> getUser ( 5 )?-> name ;
// Эквивалентна следующему блоку кода:
if ( is_null ( $repository )) $result = null ;
> else $user = $repository -> getUser ( 5 );
if ( is_null ( $user )) $result = null ;
> else $result = $user -> name ;
>
>
?>
Замечание:
Оператор nullsafe лучше всего использовать, когда null считается допустимым и ожидаемым значением для возвращаемого свойства или метода. Для индикации ошибки предпочтительнее выбрасывать исключение.
User Contributed Notes 11 notes
15 years ago
I was confused at first about object assignment, because it’s not quite the same as normal assignment or assignment by reference. But I think I’ve figured out what’s going on.
First, think of variables in PHP as data slots. Each one is a name that points to a data slot that can hold a value that is one of the basic data types: a number, a string, a boolean, etc. When you create a reference, you are making a second name that points at the same data slot. When you assign one variable to another, you are copying the contents of one data slot to another data slot.
Now, the trick is that object instances are not like the basic data types. They cannot be held in the data slots directly. Instead, an object’s «handle» goes in the data slot. This is an identifier that points at one particular instance of an obect. So, the object handle, although not directly visible to the programmer, is one of the basic datatypes.
What makes this tricky is that when you take a variable which holds an object handle, and you assign it to another variable, that other variable gets a copy of the same object handle. This means that both variables can change the state of the same object instance. But they are not references, so if one of the variables is assigned a new value, it does not affect the other variable.
// Assignment of an object
Class Object public $foo = «bar» ;
>;
$objectVar = new Object ();
$reference =& $objectVar ;
$assignment = $objectVar
//
// $objectVar —>+———+
// |(handle1)—-+
// $reference —>+———+ |
// |
// +———+ |
// $assignment —>|(handle1)—-+
// +———+ |
// |
// v
// Object(1):foo=»bar»
//
?>
$assignment has a different data slot from $objectVar, but its data slot holds a handle to the same object. This makes it behave in some ways like a reference. If you use the variable $objectVar to change the state of the Object instance, those changes also show up under $assignment, because it is pointing at that same Object instance.
$objectVar -> foo = «qux» ;
print_r ( $objectVar );
print_r ( $reference );
print_r ( $assignment );
//
// $objectVar —>+———+
// |(handle1)—-+
// $reference —>+———+ |
// |
// +———+ |
// $assignment —>|(handle1)—-+
// +———+ |
// |
// v
// Object(1):foo=»qux»
//
?>
But it is not exactly the same as a reference. If you null out $objectVar, you replace the handle in its data slot with NULL. This means that $reference, which points at the same data slot, will also be NULL. But $assignment, which is a different data slot, will still hold its copy of the handle to the Object instance, so it will not be NULL.
$objectVar = null ;
print_r ( $objectVar );
print_r ( $reference );
print_r ( $assignment );
Сигнатура метода
Самый распространенный вариант использования ключевого слова static — статический метод. Несмотря на то, что к статическим методам можно обращаться с помощью объектного оператора ( -> ), рекомендуется использовать оператор разрешения области видимости ( :: ), поскольку альтернатива устарела и, вероятно, будет удалена в будущем. С помощью оператора разрешения области видимости можно вызывать статические методы напрямую в классе, а не в его экземпляре. В результате этого ключевое слово $this становится недоступным в теле статических методов.
Статические методы можно использовать для реализации шаблона фабричный метод (Factory Method), который создает новые экземпляры содержащего его класса при каждом вызове. В данном примере фабричный метод fromArray создает экземпляр объекта User , присваивает ему значения из массива и возвращает экземпляр:
class User
public static function fromArray($attributes)
$user = new User();
$user->name = $attributes['first'] . ' ' . $attributes['last'];
$user->password = password_hash($attributes['password'], PASSWORD_BCRYPT); return $user;
>
>$user = User::fromArray([
'first' => 'ryan',
'last' => 'cco',
'password' => 'password'
]);
Эту логику можно извлечь в отдельный класс, который известен как шаблон проектирования статическая фабрика (Static Factory):
class UserFactory
public static function build($attributes)
//
>
>$user = UserFactory::build($attributes);
Свойства
В отличие от обычных свойств, изменение значения статического свойства во время выполнения программы повлияет на все экземпляры содержащего свойство класса. Даже на те, для которых еще не созданы экземпляры. Таким образом, статические свойства можно рассматривать в качестве “констант изменяемого класса”. На статические свойства можно ссылаться только с помощью оператора разрешения области видимости.
Благодаря природе статических свойств их можно использовать для реализации шаблона одиночка (Singleton). Одиночка содержит один и тот же экземпляр класса на протяжении всего выполнения программы.
В данном примере первый вызов Queue::getInstance() создает и назначает экземпляр Queue для Queue::$instance и возвращает его. Каждый последующий вызов будет возвращать один и тот же экземпляр Queue , ранее присвоенный Queue::$instance :
class Queue
private static $instance; public static function getInstance()
if (static::$instance === null) static::$instance = new Queue();
> return static::$instance;
>
>
Переменные
В контексте статической функции переменные сохраняют свое значение даже после выхода программы из области видимости содержащей их функции. В контексте метода класса статические переменные обладают дополнительным поведением, подобным статическим свойствам: изменения их значений отражаются во всех экземплярах класса. Несмотря на схожесть со статическими свойствами, статические переменные доступны только в теле функции или метода.
Статические переменные часто используются в технике оптимизации под названием мемоизация. Ее целью является ускорение дорогостоящей операции за счет кэширования результатов и сохранения их для последующего вызова с теми же параметрами.
В данном примере мы создаем уникальный для предоставленных параметров хеш и используем его для уникальной идентификации вызова в качестве ключа. Если значение $key в качестве индекса для $cache не найдено, то выполняем preg_replace и сохраняем его вывод в индексе $key , принадлежащему $cache . Каждый последующий вызов для replace с теми же параметрами будет обходить вызов preg_replace и возвращать значение из предыдущего вызова:
function replace($pattern, $replacement, $subject)
static $cache = []; $key = md5(serialize(func_get_args())); if (!isset($cache[$key])) $cache[$key] = preg_replace(
$pattern, $replacement, $subject
);
> return $cache[$key];
>
Анонимные функции
Подобно методам, при определении в контексте класса анонимные функции не связаны с содержащим их классом и не имеют доступа через $this .
Статические анонимные функции не обладают такой широтой вариантов использования, как обычные анонимные функции. Стоит отметить, что статические анонимные функции немного улучшают производительность и могут использоваться в любых экземплярах при отсутствии необходимости привязки содержащего класса к анонимной функции.
$unpublished = array_filter($posts, static function ($post) return ! $post->published;
>);
Позднее статическое связывание
Позднее статическое связывание демонстрирует другой вариант использования ключевого слова static : в контексте наследования. В этом контексте static относится к вызываемому классу, а не к тому, для которого был определен метод: на него, в свою очередь, будет ссылаться self или __CLASS__ :
class A
public function saySelfValue()
echo self::class;
> public function sayClassValue()
echo __CLASS__;
> public function sayStaticValue()
echo static::class;
>
>class B extends A
>$a = new A();
$a->saySelfValue(); // 'A'
$a->sayStaticValue(); // 'A'
$a->sayStaticValue(); // 'A'$b = new B();
$b->saySelfValue(); // 'A'
$b->sayStaticValue(); // 'B'
$b->sayStaticValue(); // 'A'
Заключение
Мы рассмотрели несколько примеров использования ключевого слова static в PHP. Хотя сценарии использования умозрительны, они очень реалистичны. Польза, которую они могут принести вашему коду, может быть огромной. По крайней мере, знакомство с этими способами использования static сделает вас сильным разработчиком.
- Java убьет ваш стартап. PHP спасёт его
- 3 способа клонирования объектов в JavaScript
- Основы JavaScript: управление DOM элементами (часть 1)
Что такое сигнатура в программировании: терминология и примеры
Сергей Немчинский: Что такое преждевременная оптимизация? Почему это плохо?
Как начинающему программисту оценить качество своего кода?
Сергей Немчинский: Почему ты не развиваешься как программист: причины и что с этим делать?
Сергей Немчинский: Как решать задачи как программист?
Сергей Немчинский: Какие проекты делать начинающему программисту?
Сигнатура означает подпись, на английском signature. В программировании сигнатура позволяет идентифицировать функцию, класс, метод или интерфейс среди многих других. Что такое сигнатура, как она применяется в разных языках и для чего полезна, читайте в данной статье.
Что такое сигнатура в программировании
Сигнатура — это объявление функции или метода, а также его параметры. Сигнатура содержит информацию о том, какие аргументы передаются в функцию или метод, их типы и названия, а также информацию о возвращаемых значениях.
При объявлении функции, сигнатура может содержать следующую информацию:
- имя функции;
- типы и количество параметров.
Например, сигнатура простой функции сложения на JavaScript может выглядеть так:
function add(x, y)
Эта сигнатура содержит имя функции «add», два параметра, «x» и «y», и возвращаемое значение – сумма двух параметров.
Сигнатура функции на C++ может выглядеть следующим образом:
Сигнатура содержит имя функции «swap», которая меняет местами два указателя, «a» и «b», и меняет местами значения объектов, на которые указывают эти указатели.
Сигнатура нужно, чтобы разработчики понимали, как называются функция или метод, и что они возвращают, без необходимости их внедрять и проверять. Это позволяет проще читать, понимать и корректировать код, а также вылавливать ошибки в коде в процессе разработки.
Типы сигнатур в программировании
В программировании существуют несколько типов сигнатур.
Сигнатура функции
Сигнатура содержит информацию о том, какие аргументы принимает функция и какое значение она возвращает. Например, приведенная выше JavaScript-функция «add» принимает два аргумента «x» и «y» и возвращает их сумму. Это очевидно из сигнатуры.
Сигнатура класса
Сигнатура класса содержит информацию о конструкторе, методах и свойствах класса. Например, в C++ класс «Stack» сообщает:
В ней указано, что у класса есть конструктор «Stack()», деструктор «~Stack()», методы push(int x) и pop(). Так же указано, что у класса есть приватное поле «arr».
Сигнатура метода
Сигнатура метода содержит информацию о том, какие аргументы принимает метод и какое значение он возвращает. Например, у метода «swap» в Java сигнатура сообщает:
Тут указано, что метод swap принимает два аргумента int a и int b и возвращает их же, поменяв местами.
Сигнатура интерфейса
Сигнатура интерфейса содержит информацию о методах и свойствах классов, связанных со взаимодействием интерфейса. Например, в Java сигнатура интерфейса «Comparable» сообщает:
Тут сообщается, что указанный класс должен применить метод compareTo.
Разные типы сигнатур нужны разработчикам, чтобы понимать структуру и поведение объектов и методов и избегать ошибок и непоследовательностей в коде.
Сигнатура в разных языках программирования
В языке С++ сигнатура метода или класса определяет его тип и количество параметров, передаваемых в метод при вызове. Сигнатура метода или класса в С++ содержит:
- имя метода/класса;
- список имен параметров;
- список типов параметров;
- список ключевых слов доступности (public, private, protected, friend);
- список ключевых слов наследства (public, private, protected);
- список ключевых слов параметров (in, out, constant).
Пример сигнатуры метода:
В этой сигнатуре метода есть имя метода add, а также два параметра int a и int b. Также есть ключевое слово `int` в конце, которое указывает на возвращаемый тип данных int. Ключевое слово `in` указывает на то, что параметры не могут быть изменены внутри метода, а параметры `out` и `constant` указывают на то, что параметры могут быть изменены как внутри, так и снаружи метода. Ключевое слово `private` указывает на то, что метод может быть вызван только из класса, в котором он был объявлен.
Сигнатура в языке Java
В языке Java сигнатура содержит следующую информацию:
- имя метода, конструктора или поля;
- список типов параметров, которое указывает на тип данных, которые метод, конструктор или поле принимает в качестве параметров;
- список типов возвращаемого значения, который указывает на тип данных, который метод, конструктор или поле возвращает;
- модификаторы доступа (public, private, protected, static, final, volatile и.т.д.), которые указывают на доступность метода, конструктора или поля;
- ключевые слова (abstract, static, final) для наследования.
Пример сигнатуры метода:
В этой сигнатуре метода есть имя метода sum, а также два параметра int a и int b. Также есть ключевое слово `int` в конце, которое указывает на возвращаемый тип данных int.
Особенности применения сигнатуры в JavaScript
JavaScript не является языком строгой типизации. Типизация в нем динамическая, свободная от ограничений типов. Именно поэтому в JavaScript сигнатуры особенно важны. В коде они могут выглядеть как стрелки над функциями с указанием типов.
Курс JavaScript Start — это прекрасная возможность изучить один из самых востребованных языков программирования в вашем темпе и в удобное время. Уже записанные лекции позволят вам гибко планировать свое время и обучаться в удобном для вас темпе. На курсе вы освоите все основы языка Javascript, а также научитесь создавать интерактивные веб-приложения и сайты. Присоединяйтесь к JavaScript Start и начните свой путь в освоении JS.
Компилятор в JavaScript может самостоятельно вывести тип для всякого выражения, используя систему Хиндли-Миленар. Но иногда, особенно в случаях использования параметрического полиморфизма, возникают сложности с определением типа выражения. Поэтому тип выражения рекомендуется указывать в сигнатуре, что позволяет отслеживать работу функции.
Один из возможных примеров использования сигнатуры:
// length :: String → Number
const length = s => s.length;
В этом примере интересно то, что перед стрелкой записан входящий тип length, а после стрелки – возвращаемый тип s.length. Если освоить навык чтения таких сигнатур, это сделает работу с кодом на JavaScript заметно проще.
Вместо заключения
Умение понимать signature полезно как в JavaScript, так и в прочих функциональных языках. И если нам нужно заимствовать любую чистую функцию, мы можем всего лишь обратиться к её signature, чтобы понять, с каким участком кода нам надо работать.
Похожие материалы
Сергей Немчинский: Что такое преждевременная оптимизация? Почему это плохо?
Как начинающему программисту оценить качество своего кода?
Сергей Немчинский: Почему ты не развиваешься как программист: причины и что с этим делать?
Сергей Немчинский: Как решать задачи как программист?
Сергей Немчинский: Какие проекты делать начинающему программисту?
Зачем использовать сигнатуры в программировании?
Использование сигнатур позволяет уменьшить количество ошибок и облегчить поддержку кода. Я столкнулся с ситуациями, когда отсутствие сигнатур приводило к непредсказуемым ошибкам и затрудняло отладку кода.
Как правильно написать сигнатуру функции?
Сигнатура функции должна содержать имя функции, тип возвращаемого значения и типы параметров. Например, def my_function(param1: int, param2: str) -> bool:
Какие инструменты и языки программирования поддерживают использование сигнатур?
Многие языки программирования, такие как Python, TypeScript, Java, C# и Kotlin, поддерживают использование сигнатур. Я работал с Python и Java и использовал сигнатуры в обоих языках.
Может ли использование сигнатур привести к увеличению объема кода?
Да, использование сигнатур может привести к увеличению объема кода, но это может сократить количество ошибок и упростить поддержку кода. Опираясь на личный опыт, я заметил, что использование сигнатур может сделать код более читабельным и понятным для других разработчиков.
Как сигнатуры связаны с тестированием кода?
Использование сигнатур может упростить тестирование кода, так как они помогают определить ожидаемый тип возвращаемого значения и типы параметров. Я использовал сигнатуры вместе с фреймворками тестирования, такими как Jest и Pytest, чтобы создавать тесты для функций.
Какие инструменты и ресурсы помогут мне улучшить свои навыки написания сигнатур?
Существует множество онлайн-курсов и ресурсов для изучения сигнатур в программировании. Я рекомендую менторинг на FoxmindED, а также официальную документацию языков программирования, которые вы используете. Также полезно изучить код других разработчиков и практиковаться в написании сигнатур на практике.