git 4deba2bfca6636d5cdcede3f2068eff3b59c15ce
Контракты в Laravel - это набор классов-интерфейсов, определяющий некий функционал ядра фреймворка. Например, контракт Queue определяет
методы работы с очередями, Mailer - методы для отправки мейлов.
Каждый контракт имеет свою реализацию (implementation) во фреймворке. Например, есть реализация Queue с различными драйверами
очередей и реализация Mailer с использованием SwiftMailer.
Для удобства, контракты находятся в отдельном репозитории на гитхабе - https://github.com/illuminate/contracts.
Вы можете спросить - а для чего нужны контракты? Зачем вообще нужны интерфейсы?
Ответ - слабая связность и упрощение кода.
Сначала давайте рассмотрим пример кода с сильной связностью.
<?php namespace App\Orders;
class Repository {
/**
* The cache.
*/
protected $cache;
/**
* Create a new repository instance.
*
* @param \Package\Cache\Memcached $cache
* @return void
*/
public function __construct(\SomePackage\Cache\Memcached $cache)
{
$this->cache = $cache;
}
/**
* Retrieve an Order by ID.
*
* @param int $id
* @return Order
*/
public function find($id)
{
if ($this->cache->has($id))
{
//
}
}
}
Код этого класса тесно связан с реализацией кэширования \SomePackage\Cache\Memcached. Мы зависим и от способа кэширования (memcached),
и от API данной библиотеки. Если мы хотим сменить кэширование с memcached на redis, нам придется вносить изменения в код класса Repository.
Чтобы такого не происходило, класс Repository не должен задумываться, кто именно предоставляет данные и как именно осуществляется запись.
Давайте изменим наш класс, чтобы отвязаться от конкретной реализации и сделать его более универсальным. Для этого добавим зависимость
от интерфейса кэширования.
<?php namespace App\Orders;
use Illuminate\Contracts\Cache\Repository as Cache;
class Repository {
/**
* Create a new repository instance.
*
* @param Cache $cache
* @return void
*/
public function __construct(Cache $cache)
{
$this->cache = $cache;
}
}
Этот код не связан ни с одной внешней библиотекой, в том числе с ядром фреймворка! Контракт не содержит никакой конкретной реализации
кэширования, только интерфейс, и вы можете написать любую свою реализацию кэширования - используя внешние библиотеки или нет. Кроме того,
теперь вы можете в любой момент легко изменить способ кэширования, просто подав другую реализацию в конструктор класса при регистрации
его в сервис-контейнере в методе register() вашего сервис-провайдера.
Когда все сервисы ядра фреймворка аккуратно определены в простых интерфейсах, очень легко определить, что именно делает тот или иной сервис. Фактически, контракты являются краткой документацией к API Laravel.
Кроме того, когда вы у себя в приложении внедряете в классы зависимости от простых интерфейсов, в вашем коде легче разобраться и его проще поддерживать. Вместо того, чтобы заставлять коллег разбираться, какие методы вашего большого и сложного класса можно использовать извне, вы адресуете их к простому и понятному интерфейсу.
Вот таблица соответствий контрактов Laravel 5 фасадам Laravel 4 :
Как получить в своем классе реализацию заданного контракта? Очень просто. Достаточно в аргументах конструктора явно указать в качестве типа аргумента название соответствующего контракта - и при его создании там окажется реализация этого интерфейса. Это происходит за счет того, что почти все классы Laravel (контроллеры, слушатели событий и очередей, роуты, фильтры роутов) регистрируются в сервис-контейнере и в процессе создания экземпляра класса из контейнера в него встраиваются все определенные таким образом зависимости. Фактически все происходит автоматически, вам не приходится задумываться об этом механизме.
Например, взглянем на слушателя событий:
<?php namespace App\Events;
use App\User;
use Illuminate\Contracts\Queue\Queue;
class NewUserRegistered {
/**
* The queue implementation.
*/
protected $queue;
/**
* Create a new event listener instance.
*
* @param Queue $queue
* @return void
*/
public function __construct(Queue $queue)
{
$this->queue = $queue;
}
/**
* Handle the event.
*
* @param User $user
* @return void
*/
public function fire(User $user)
{
// Queue an e-mail to the user...
}
}
Если вы хотите больше узнать о сервис-контейнере, прочтите соответствующий раздел документации.