契约
简介
Laravel 的「契约」是一组接口,用于定义框架所提供的核心服务。例如,Illuminate\Contracts\Queue\Queue 契约定义了队列任务所需的方法,而 Illuminate\Contracts\Mail\Mailer 契约则定义了发送邮件所需的方法。
每个契约都有框架提供的对应实现。例如,Laravel 提供了支持多种驱动的队列实现,以及由 Symfony Mailer 驱动的邮件发送实现。
所有 Laravel 契约都位于独立的 GitHub 仓库中。这既可作为所有可用契约的快速参考,也可作为一个解耦的独立包,便于在构建与 Laravel 服务交互的包时使用。
契约与 Facade
Laravel 的 Facade 与辅助函数提供了一种简便方式来使用 Laravel 服务,而无需在服务容器中对契约进行类型提示并解析。在大多数情况下,每个 Facade 都有对应的契约。
与不必在类构造函数中注入的 Facade 不同,契约允许你为类定义显式依赖。有些开发者更喜欢以这种方式明确声明依赖,因此倾向使用契约;另一些开发者则更喜欢 Facade 的便捷性。总的来说,大多数应用在开发中使用 Facade 不会有问题。
何时使用契约
使用契约还是 Facade,最终取决于个人与团队的偏好。契约与 Facade 都能用来构建稳健、可充分测试的 Laravel 应用。二者并不互斥:应用的某些部分可以用 Facade,另一些部分可以依赖契约。只要类的职责保持聚焦,你会发现使用契约与 Facade 在实践中几乎没有差别。
总的来说,大多数应用在开发中使用 Facade 不会有问题。如果你正在构建可集成多个 PHP 框架的包,可能希望使用 illuminate/contracts 包来定义与 Laravel 服务的集成,而无需在包的 composer.json 中依赖 Laravel 的具体实现。
如何使用契约
那么,如何获取契约的实现呢?其实很简单。
Laravel 中许多类型的类都通过服务容器解析,包括控制器、事件监听器、中间件、队列任务,甚至路由闭包。因此,要获取契约的实现,只需在被解析类的构造函数中对该接口进行「类型提示」即可。
例如,看看这个事件监听器:
<?php
namespace App\Listeners;
use App\Events\OrderWasPlaced;
use App\Models\User;
use Illuminate\Contracts\Redis\Factory;
class CacheOrderInformation
{
/**
* Create a new event handler instance.
*/
public function __construct(
protected Factory $redis,
) {}
/**
* Handle the event.
*/
public function handle(OrderWasPlaced $event): void
{
// ...
}
}当事件监听器被解析时,服务容器会读取该类构造函数上的类型提示,并注入相应的值。要了解更多关于在服务容器中注册内容的信息,请参阅其文档。
契约参考
下表提供了所有 Laravel 契约及其对应 Facade 的快速参考: