<rmcreative>

Когда я стартовал кампанию на Patreon, то пообещал отвечать на вопросы. Первый вопрос задал Daniel и он о трейтах PHP:

Что думаете о трейтах в PHP? Зло ли они? Стоит ли их избегать? Если их использовать, какие особенности? Когда их лучше не использовать? Может был отрицательный или положительный опыт?

Что такое трейты?

В документации PHP трейты описываются так:

Трейт (англ. trait) — это механизм обеспечения повторного использования кода в языках с поддержкой единого наследования, таких как PHP. Трейт предназначен для уменьшения некоторых ограничений единого наследования, позволяя разработчику повторно использовать наборы методов свободно, в нескольких независимых классах и реализованных с использованием разных архитектур построения классов. Семантика комбинации трейтов и классов определена таким образом, чтобы снизить уровень сложности, а также избежать типичных проблем, связанных с множественным наследованием и смешиванием (mixins). > Трейт очень похож на класс, но предназначен для группирования функционала хорошо структурированым и последовательным образом. Невозможно создать самостоятельный экземпляр трейта. Это дополнение к обычному наследованию и позволяет сделать горизонтальную композицию поведения, то есть применение членов класса без необходимости наследования.

Описание длинное. Если по-простому, не затрагивая вопросы наследования, то трейты — такой умный копипаст.

<?php
trait Dumper
{
    public function dump($var)
    {
        echo '<pre>' . print_r($var, true) . '</pre>';
    }
}
 
class MyClass
{
    use Dumper;
}
 
$myClass = new MyClass();
$myClass->dump('test');

Код выше будет работать так же, как и следующий код:

<?php
class MyClass
{
    public function dump($var)
    {
        echo '<pre>' . print_r($var, true) . '</pre>';
    }
}

Трейты и Yii

Yii использует трейты для низкоуровневых штук и общего кода из слоя работы с базами данных. Трейты рассматривались как альтернатива поведениям в 2.0 и будут ещё раз рассматриваться для релиза 2.1.

Поведения

Я начал присматриваться к трейтам в августе 2010 когда их смёржили в trunk PHP (так зовётся master в CVS и SVN). К тому времени в Yii 1.x уже были поведения. Они похожи на mixin в Ruby и полезны для придания дополнительных возможностей, таких как SoftDeleteable или Versionable, существующим объектам или классам. Главное отличие в том, что у поведений есть своё состояние и они могут быть присоединены к объекту или отключены во время исполнения. У трейтов своего состояния нет.

Трейты ушли в релиз до выхода Yii 2.0, поэтому мы рассматривали их как альтернативу поведениям из Yii 1.1. Было решено оставить поведения. В то время не было хороших идей как сделать трейты настраиваемыми и как реализовать подключение и отключение их во время выполнения.

При формировании планов на версию 2.1 идея всплыла повторно. Мы нашли как реализовать настраиваемость трейта через использования абстрактных методов. Подключение и отключение во время выполнения оказалось невозможным, но нашёлся способ включать и выключать обработчики подписываясь на события или отписываясь от них. Финальное решение пока ещё не принято...

Низкоуровневая функциональность

Yii использует трейты для общей низкоуровневой функциональности: - ArrayableTrait - ArrayAccessTrait

Это самое очевидное и правильное использование трейтов.

Общий код слоя для работы с базами данных

Менее очевидно использование трейтов в слое для работы с базами данных: - ActiveQueryTrait - ActiveRelationTrait - QueryTrait - SchemaBuilderTrait - ViewFinderTrait

Интерфейс этого слоя в Yii 2.0 одинаков как для реляционных баз, так и для noSQL. Общие части реализации вынесены в трейты для того, чтобы не раздувать дерево наследования и не перекрывать слишком много методов для noSQL, значительно отличающихся от методов для традиционных баз данных. Лично я не очень доволен этой реализацией, если смотреть только на верность ООП. Можно было использовать композицию и обычные классы. Код был бы более тестируемым и читать его было бы проще. Тем не менее, использование трейтов оправдано так как оно значительно сокращает количество вызываемых методов и делает слой работы с базами данных производительней. С тестированием мы также разобрались несмотря на то, что это было не тривиально.

Особенности

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

Отсутствие инкапсуляции

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

Идеально использовать трейты для небольшого количества относительно простого кода.

Состояние

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

Приватные поля трейта копируются в класс, так что возможны как конфликты имён, так и случайная модификация полей. Так как во время выполнения всё копируется в класс, класс имеет доступ даже к приватным полям.

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

Так зло ли трейты?

Зависит от того, как вы их используете.

Как и в случае с копи-пейстом, зло относительно. Нет ничего абсолютно злого или абсолютно хорошего.

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

Почитать

• Using Traits in PHP 5.4
• PHP Traits: Good or Bad?
• How I Use Traits
• Комментарии к англоязычной версии этого поста