Что такое декоратор в программировании

Готовимся к собеседованию: что такое декораторы в Python

На собеседованиях только и разговоров, что о декораторах. Разбираемся на пальцах, что это.

Итак, вы на собеседовании на вакансию джуна-пайтониста. Всё идёт хорошо: вы объяснили про кортежи и списки, про принципы ООП и структуры данных, даже решили небольшую задачку, и вдруг:

— Расскажите, пожалуйста, про декораторы в Python.

Простой ответ

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

— Декоратор, если в двух словах, это функция, которая добавляет новую функциональность к другой функции без изменения её кода. Он как бы оборачивает, декорирует функцию, тем самым расширяя её возможности.

Функция say_hi (пример отсюда), которую мы «обернём» в декоратор, возвращает строку «всем привет». Обратите внимание: не печатает, а возвращает.

С некоторых пор утверждает, что он data scientist. В предыдущих сезонах выдавал себя за математика, звукорежиссёра, радиоведущего, переводчика, писателя. Кандидат наук, но не точных. Бесстрашно пишет о Data Science и программировании на Python.

А наш декоратор превратит символы этой строки из строчных в прописные. Этой возможности у функции say_hi раньше не было, а теперь будет.

Что здесь происходит — разбираем код построчно:

Больше локальных переменных богу локальных переменных! Конечно, всё это ради понятности и читаемости.

Как это запустить? Пишем символ @, за ним название декоратора, а объявление функции say_hi переносим на строку под ней:

Источник

Декораторы в JavaScript

Учитывая введение стандарта ES2015+, и то, что транспиляция в наше время — обычное дело, многие программисты сталкиваются с новыми возможностями JavaScript в реальном коде и в учебных материалах. Одна из таких возможностей — декораторы. Во всех этих новшествах немудрено и запутаться, поэтому сегодня поговорим о том, что такое декораторы, и о том, как их использовать для того, чтобы сделать код чище и понятнее.

Декораторы обрели популярность благодаря их применению в Angular 2+. В Angular этот функционал реализуется средствами TypeScript. Сейчас предложение по введению декораторов в JavaScript находится в состоянии Stage 2 Draft. Это означает, что работа над ними, в основном, завершена, но они всё ещё могут подвергаться изменениям. Декораторы должны стать частью следующего обновления языка.

Что такое декоратор?

В простейшем виде декоратор — это способ оборачивания одного фрагмента кода в другой. Буквально — «декорирование» фрагмента кода.

Об этой концепции вы, возможно, слышали ранее, как о «Функциональной композиции» или о «Функциях высшего порядка».

Подобное вполне реализуемо стандартными средствами JavaScript. Выглядит это как вызов некоей функции, которая оборачивает другую:

Как применять декораторы в JavaScript?

К одному фрагменту кода можно применять столько декораторов, сколько нужно, они будут задействованы в порядке их следования в коде.

Здесь показано объявление класса и применение трёх декораторов. Два из них относятся к самому классу, и один — к свойству класса. Вот каковы роли этих декораторов:

Если вы используете Babel, для работы с декораторами можно обратиться к плагину transform-decorators-legacy.

Обратите внимание на то, что в названии этого плагина используется слово «legacy», которое можно трактовать как указание на некую устаревшую технологию. Дело тут в том, что здесь поддерживается то, как декораторы обрабатывает Babel 5. Этот подход может отличаться от той формы, которая, в итоге, будет стандартизирована.

Зачем нужны декораторы?

Функциональная композиция в JavaScript без особых проблем реализуется и стандартными средствами. Однако, тот же подход либо очень сложно, либо невозможно применить к другим программным конструкциям, например — к классам и их свойствам. Предложенные нововведения позволяют использовать декораторы и с классами, и с их свойствами. Вероятно, в будущих версиях JavaScript можно ожидать дальнейшего развития декораторов.

Использование декораторов, помимо прочих возможностей, означает более чёткий синтаксис, это ведёт к более ясному выражению намерений программиста, использующего эту технику.

Разные типы декораторов

Сейчас поддерживаемые типы декораторов — это декораторы классов и членов классов — свойств, методов, геттеров и сеттеров. На самом деле, декораторы — это всего лишь функции, которые вызываются с некоторыми сведениями о декорируемых элементах и возвращают другие функции.

Декораторы выполняются один раз при запуске программы, декорируемый код заменяется возвращаемым значением.

▍Декораторы членов класса

Декораторы членов класса применяются к свойствам, методам, геттерам и сеттерам.

Эти функции-декораторы вызываются с тремя параметрами:

Затем этот декоратор используется с членами класса следующим образом:

Как видно по сообщению об ошибке, декоратор сработал так, как ожидается. Мы можем пойти и дальше, например, изменив поведение декорируемой функции, фактически, заменив её новой функцией. Давайте, с помощью декоратора, выведем в лог аргументы функции, и то, что она возвращает:

Эта конструкция заменяет метод новым, который логирует аргументы, вызывает исходный метод, а затем логирует то, что он возвращает.

Посмотрим на всё это в действии:

Можно заметить, что в тексте функции-декоратора приходится использовать необычный синтаксис для исполнения декорируемого метода. Об этом, на самом деле, можно написать целую статью, но, если кратко, то метод apply позволяет вызывать функцию, задавая значение this и аргументы, которые будут ей переданы.

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

Код усложнился, но если с ним разобраться, окажется, что происходит тут следующее:

Пользоваться всем этим можно так:

Сразу видно, что такой подход позволяет различать строки логов благодаря назначенному тегу.

▍Декораторы классов

Декораторы классов применяются ко всему определению класса. Функция-декоратор вызывается с единственным параметром, которым является декорируемая функция-конструктор класса.

Обратите внимание на то, что декоратор применяется к функции-конструктору, а не к каждому экземпляру класса в момент его создания. Поэтому для того, чтобы по-разному декорировать разные экземпляры одного и того же класса, понадобится, перед их созданием, самостоятельно заботиться о декорировании конструктора.

В целом, декораторы классов менее полезны, чем декораторы членов классов, так как всё, что тут можно сделать, сводится к замене конструктора класса.

Возвращаясь к примеру с логированием, напишем декоратор, который будет выводить параметры конструктора:

Тут, в качестве аргумента, принимается класс и возвращается новая функция, которая будет действовать как конструктор. В нашем случае она просто логирует аргументы и возвращает новый экземпляр класса, созданного с этими аргументами.

Как видно, при выполнении конструктора класса Example будет выполнено логирование аргументов конструктора, которые используются при создании экземпляра этого класса. Это — именно то, чего мы добивались.

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

Декораторы в реальных проектах

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

▍Библиотека Core Decorators

Есть отличная библиотека Core Decorators, которая предоставляет готовые к использованию декораторы общего назначения. Среди поддерживаемой ими функциональности — тайминг вызовов методов, уведомления об устаревших конструкциях, проверка того, является ли некий объект неизменяемым.

▍Библиотека React

В React найдено хорошее применение концепции компонентов высшего порядка. Это — компоненты React, написанные как функции и служащие обёртками для других компонентов.

Если же переписать это с использованием декораторов, получится следующее:

Функционал получился тот же, но выглядит всё это гораздо симпатичнее.

▍Библиотека MobX

Итоги

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

Уважаемые читатели! А вы уже пользуетесь декораторами в своих JS-проектах?

Источник

Декоратор

Декоратор — это структурный паттерн проектирования, который позволяет динамически добавлять объектам новую функциональность, оборачивая их в полезные «обёртки».

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

Сторонние программы используют главный класс оповещений.

В какой-то момент стало понятно, что одних email-оповещений пользователям мало. Некоторые из них хотели бы получать извещения о критических проблемах через SMS. Другие хотели бы получать их в виде сообщений Facebook. Корпоративные пользователи хотели бы видеть сообщения в Slack.

Каждый тип оповещения живёт в собственном подклассе.

Но затем кто-то резонно спросил, почему нельзя выбрать несколько типов оповещений сразу? Ведь если вдруг в вашем доме начался пожар, вы бы хотели получить оповещения по всем каналам, не так ли?

Вы попытались реализовать все возможные комбинации подклассов оповещений. Но после того как вы добавили первый десяток классов, стало ясно, что такой подход невероятно раздувает код программы.

Итак, нужен какой-то другой способ комбинирования поведения объектов, который не приводит к взрыву количества подклассов.

Наследование — это первое, что приходит в голову многим программистам, когда нужно расширить какое-то существующее поведение. Но механизм наследования имеет несколько досадных проблем.

Наследование против Агрегации.

Декоратор имеет альтернативное название — обёртка. Оно более точно описывает суть паттерна: вы помещаете целевой объект в другой объект-обёртку, который запускает базовое поведение объекта, а затем добавляет к результату что-то своё.

Оба объекта имеют общий интерфейс, поэтому для пользователя нет никакой разницы, с каким объектом работать — чистым или обёрнутым. Вы можете использовать несколько разных обёрток одновременно — результат будет иметь объединённое поведение всех обёрток сразу.

В примере с оповещениями мы оставим в базовом классе простую отправку по электронной почте, а расширенные способы отправки сделаем декораторами.

Расширенные способы оповещения становятся декораторами.

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

Программа может составлять составные объекты из декораторов.

Последняя обёртка в списке и будет тем объектом, с которым клиент будет работать в остальное время. Для остального клиентского кода, по сути, ничего не изменится, ведь все обёртки имеют точно такой же интерфейс, что и базовый класс оповещений.

Таким же образом можно изменять не только способ доставки оповещений, но и форматирование, список адресатов и так далее. К тому же клиент может «дообернуть» объект любыми другими обёртками, когда ему захочется.

Одежду можно надевать слоями, получая комбинированный эффект.

Любая одежда — это аналог Декоратора. Применяя Декоратор, вы не меняете первоначальный класс и не создаёте дочерних классов. Так и с одеждой — надевая свитер, вы не перестаёте быть собой, но получаете новое свойство — защиту от холода. Вы можете пойти дальше и надеть сверху ещё один декоратор — плащ, чтобы защититься и от дождя.

Компонент задаёт общий интерфейс обёрток и оборачиваемых объектов.

Конкретный компонент определяет класс оборачиваемых объектов. Он содержит какое-то базовое поведение, которое потом изменяют декораторы.

Базовый декоратор хранит ссылку на вложенный объект-компонент. Им может быть как конкретный компонент, так и один из конкретных декораторов. Базовый декоратор делегирует все свои операции вложенному объекту. Дополнительное поведение будет жить в конкретных декораторах.

Конкретные декораторы — это различные вариации декораторов, которые содержат добавочное поведение. Оно выполняется до или после вызова аналогичного поведения обёрнутого объекта.

Клиент может оборачивать простые компоненты и декораторы в другие декораторы, работая со всеми объектами через общий интерфейс компонентов.

В этом примере Декоратор защищает финансовые данные дополнительными уровнями безопасности прозрачно для кода, который их использует.

Пример шифрования и компрессии данных с помощью обёрток.

Приложение оборачивает класс данных в шифрующую и сжимающую обёртки, которые при чтении выдают оригинальные данные, а при записи — зашифрованные и сжатые.

Декораторы, как и сам класс данных, имеют общий интерфейс. Поэтому клиентскому коду не важно, с чем работать — c «чистым» объектом данных или с «обёрнутым».

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

Объекты помещают в обёртки, имеющие дополнительные поведения. Обёртки и сами объекты имеют одинаковый интерфейс, поэтому клиентам без разницы, с чем работать — с обычным объектом данных или с обёрнутым.

Когда нельзя расширить обязанности объекта с помощью наследования.

Убедитесь, что в вашей задаче есть один основной компонент и несколько опциональных дополнений или надстроек над ним.

Создайте интерфейс компонента, который описывал бы общие методы как для основного компонента, так и для его дополнений.

Создайте класс конкретного компонента и поместите в него основную бизнес-логику.

Создайте базовый класс декораторов. Он должен иметь поле для хранения ссылки на вложенный объект-компонент. Все методы базового декоратора должны делегировать действие вложенному объекту.

И конкретный компонент, и базовый декоратор должны следовать одному и тому же интерфейсу компонента.

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

Клиент берёт на себя ответственность за конфигурацию и порядок обёртывания объектов.

Большая гибкость, чем у наследования. Позволяет добавлять обязанности на лету. Можно добавлять несколько новых обязанностей сразу. Позволяет иметь несколько мелких объектов вместо одного объекта на все случаи жизни.

Трудно конфигурировать многократно обёрнутые объекты. Обилие крошечных классов.

Адаптер меняет интерфейс существующего объекта. Декоратор улучшает другой объект без изменения его интерфейса. Причём Декоратор поддерживает рекурсивную вложенность, чего не скажешь об Адаптере.

Адаптер предоставляет классу альтернативный интерфейс. Декоратор предоставляет расширенный интерфейс. Заместитель предоставляет тот же интерфейс.

Цепочка обязанностей и Декоратор имеют очень похожие структуры. Оба паттерна базируются на принципе рекурсивного выполнения операции через серию связанных объектов. Но есть и несколько важных отличий.

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

Компоновщик и Декоратор имеют похожие структуры классов из-за того, что оба построены на рекурсивной вложенности. Она позволяет связать в одну структуру бесконечное количество объектов.

Декоратор оборачивает только один объект, а узел Компоновщика может иметь много детей. Декоратор добавляет вложенному объекту новую функциональность, а Компоновщик не добавляет ничего нового, но «суммирует» результаты всех своих детей.

Но они могут и сотрудничать: Компоновщик может использовать Декоратор, чтобы переопределить функции отдельных частей дерева компонентов.

Архитектура, построенная на Компоновщиках и Декораторах, часто может быть улучшена за счёт внедрения Прототипа. Он позволяет клонировать сложные структуры объектов, а не собирать их заново.

Стратегия меняет поведение объекта «изнутри», а Декоратор изменяет его «снаружи».

Декоратор и Заместитель имеют схожие структуры, но разные назначения. Они похожи тем, что оба построены на принципе композиции и делегируют работу другим объектам. Паттерны отличаются тем, что Заместитель сам управляет жизнью сервисного объекта, а обёртывание Декораторов контролируется клиентом.

Не втыкай в транспорте

Лучше почитай нашу книгу о паттернах проектирования.

Теперь это удобно делать даже во время поездок в общественном транспорте.

Эта статья является частью нашей электронной книги Погружение в Паттерны Проектирования.

Источник

Декораторы в JavaScript

May 20, 2020 · 5 min read

Декораторы — это объекты, которые используются для динамического добавления дополнительной функциональности к другому объекту без изменения реализации этого объекта.

Декораторы — это синтаксический сахар. Если вы работали с JavaScript, то, вероятно, уже сталкивались с их реализацией. Они просты в написании, но эффективны в использовании.

Рассмотрим несколько примеров декораторов в JavaScript и узнаем, как можно применять их в коде.

Когда нужно использовать декоратор?

Существует несколько случаев применения:

Добавление динамического поведения к существующим объектам

Как было сказано ранее, один из сценариев использования декораторов — динамическое добавление дополнительной логики к объектам без необходимости использовать такие альтернативы, как наследование.

Примечание: д е кораторы могут вводить функции в объекты не заметно для остальных частей кода.

Реализация может выглядеть следующим образом:

В реальности существуют и другие разновидности лягушек, например жаба. Жаба относится к лягушкам, но лягушка не является жабой. Это означает, что между ними должны быть отличительные особенности, которые нельзя смешивать.

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

Реализация декоратора withToad выглядит довольно просто:

Достичь той же цели можно с помощью метода subclass с наследованием, как показано ниже:

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

Теперь переходим к более интересным примерам.

Допустим, мы создаем приложение, которое поддерживает различные предварительно определенные пользовательские темы, с помощью которых можно изменять стиль панели управления.

Мы реализуем Theme с помощью метода createStylesheet для создания совместимой таблицы стилей, а также applyStyles для анализа и применения этой таблицы к DOM:

Мы определили API Theme и теперь можем создать таблицу стилей следующим образом:

На данный момент stylesheet выглядит так:

Теперь ее можно использовать для преображения веб-страницы:

Предоставление открытых возможностей для поддержки разработки плагинов

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

Назовем этот декоратор bloodTheme :

Теперь нужно добавить в theme только одну строку:

Теперь тема предоставляет таблицу стилей blood по умолчанию:

Как видите, код/реализация theme не изменились. Применение пользовательской таблицы стилей также не изменилось:

Теперь веб-страница раскрашена красным цветом:

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

Применение временного поведения

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

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

Наследование

Еще один пример использования декораторов — при создании подклассов в большом коде.

Однако этот случай не является большой проблемой в JavaScript (если только вы не используете реализации наследования классов), в отличие от статических языков, таких как Java.

Режимы отладки

Теперь консоль предоставляет полезную информацию при запуске приложения в режиме development :

Источник

Паттерн проектирования «Декоратор» / «Decorator»

Почитать описание других паттернов.

Проблема

Возложить дополнительные обязанности (прозрачные для клиентов) на отдельный объект, а не на класс в целом.

Описание

Практическая задача

Используя паттерн «Декоратор», реализуем каркас редактора блок-схем. Будем использовать «Декоратор» для наложения особенностей отрисовки отдельных элементов схем. Рассмотрим два типа блоков — терминальный блок (начало/конец) и блок процессов (описывает одно или несколько действий) и будем их декорировать рамкой и надписью.

Диаграмма классов

Рассмотрим диаграмму классов. AbstractBlock — интерфейс любого блока блок-схемы, имеющий единственный метод — draw(), вызываемый клиентом. Является одновременно и интерфейсом декорируемого объекта и интерфейсом декоратора. TerminatorBlock и ProcessBlock — уточнения абстрактного блока. AbstractBlockDectorator — абстрактный класс декоратора блоков. Обратите внимание, что это именно абстрактный класс, а не интерфейс. Дело в том, что AbstractBlockDecorator, по умолчанию, в методе draw() делегирует соответствующий метод декорируемого объекта. LabelBlockDecorator и BorderBlockDecorator — уточнения декораторов блока, в качестве декоратора меток и рамок. Данные классы переопределяют метод draw() базового класса, добавляя декорируемому объекту новые обязанности (методы drawLabel(), drawBorder()).

Реализация на Python

По поводу реализации, хотелось бы сделать небольшое замечание. Ввиду того, что Python не поддерживает описание интерфейсов, рекомендуется описывать их как классы, но с обязательным напоминанием программисту, что это именно интерфейс а не абстрактный класс. Напоминание можно сделать в виде исключения NotImplementedError().

def draw(self):
self._decoratee.draw()

class LabelBlockDecorator(AbstractBlockDecorator):
«» » Декорирует блок текстовой меткой
» «»
def __init__(self, decoratee, label):
self._decoratee = decoratee
self._label = label

def draw(self):
AbstractBlockDecorator.draw(self)
self._drawLabel()

class BorderBlockDecorator(AbstractBlockDecorator):
«» » Декорирует блок специальной рамкой
» «»
def __init__(self, decoratee, borderWidth):
self._decoratee = decoratee
self._borderWidth = borderWidth

def draw(self):
AbstractBlockDecorator.draw(self)
self._drawBorder()

# Применим LabelDecorator к терминальному блоку
labelDecorator = LabelBlockDecorator(tBlock, «Label222» )

# Применим BorderDecorator к терминальному блоку, после применения LabelDecorator
borderDecorator1 = BorderBlockDecorator(labelDecorator, 22)

Кто-то, наконец-то дождался примеров на питоне.

Источник