#Введение
«Контракты» Laravel — это набор интерфейсов, определяющих основные сервисы, предоставляемые фреймворком. Например, контракт Illuminate\Contracts\Queue\Queue описывает методы, необходимые для работы с очередями заданий, а контракт Illuminate\Contracts\Mail\Mailer — методы для отправки электронной почты.
Каждому контракту соответствует реализация, предоставляемая самим фреймворком. Например, Laravel включает реализацию очередей с разными драйверами и реализацию почтового сервиса на базе Symfony Mailer.
Все контракты Laravel находятся в отдельном репозитории на GitHub. Это удобная точка доступа ко всем доступным контрактам, а также отдельный, независимый пакет, который можно использовать при создании пакетов, взаимодействующих с сервисами Laravel.
#Контракты и фасады
Фасады Laravel (facades) и вспомогательные функции предоставляют простой способ использования сервисов Laravel без необходимости указывать типы и разрешать контракты из сервис-контейнера. В большинстве случаев у каждого фасада есть соответствующий контракт.
В отличие от фасадов, которые не требуют явного указания в конструкторе класса, контракты позволяют явно определить зависимости класса. Некоторые разработчики предпочитают такой явный подход и используют контракты, тогда как другие ценят удобство фасадов. В целом, большинство приложений могут использовать фасады без проблем во время разработки.
#Когда использовать контракты
Выбор между контрактами и фасадами зависит от личных предпочтений и предпочтений вашей команды. И контракты, и фасады позволяют создавать надёжные и хорошо протестированные приложения на Laravel. Контракты и фасады не исключают друг друга: в одних частях приложения можно использовать фасады, в других — контракты. При условии, что вы сохраняете чёткую ответственность классов, вы практически не заметите разницы между использованием контрактов и фасадов.
В общем случае большинство приложений могут использовать фасады без проблем во время разработки. Если вы создаёте пакет, который интегрируется с несколькими PHP-фреймворками, возможно, вам захочется использовать пакет illuminate/contracts для определения интеграции с сервисами Laravel без необходимости указывать конкретные реализации Laravel в composer.json вашего пакета.
#Как использовать контракты
Итак, как получить реализацию контракта? На самом деле это довольно просто.
Многие типы классов в Laravel разрешаются через сервис-контейнер, включая контроллеры, слушатели событий, middleware, задания в очереди и даже замыкания маршрутов. Чтобы получить реализацию контракта, достаточно указать интерфейс в качестве type-hint в конструкторе класса, который разрешается.
Например, рассмотрим этот слушатель события:
<?php
namespace App\Listeners;
use App\Events\OrderWasPlaced;
use App\Models\User;
use Illuminate\Contracts\Redis\Factory;
class CacheOrderInformation
{
/**
* Создать новый экземпляр обработчика события.
*/
public function __construct(
protected Factory $redis,
) {}
/**
* Обработать событие.
*/
public function handle(OrderWasPlaced $event): void
{
// ...
}
}
Когда слушатель события разрешается, сервис-контейнер читает type-hint в конструкторе класса и внедряет соответствующее значение. Чтобы узнать больше о регистрации в сервис-контейнере, ознакомьтесь с его документацией.
#Справочник по контрактам
В этой таблице приведён быстрый справочник по всем контрактам Laravel и их соответствующим фасадам: