主题
契约
简介
Laravel 的「契约(able)」是一组定义了框架提供的核心服务的接口。例如,Illuminate\Contracts\Queue\Queue 契约定义了队列任务所需的方法,而 Illuminate\Contracts\Mail\Mailer 契约定义了发送电子邮件所需的方法。
每个契约都有框架提供的相应实现。例如,Laravel 提供了支持多种驱动的队列实现,以及由 Symfony Mailer 驱动的邮件发送实现。
所有 Laravel 契约都存放在它们自己的 GitHub 仓库中。这为所有可用的契约提供了一个快速参考点,同时也是一个独立的、解耦的包,可以在构建与 Laravel 服务交互的扩展包时使用。
契约 vs. Facade
Laravel 的 facade 和辅助函数提供了一种简单的方式来使用 Laravel 的服务,而无需类型提示并从服务容器中解析契约。在大多数情况下,每个 facade 都有一个等效的契约。
与 facade 不同——facade 不需要你在类的构造函数中引入它们——契约允许你为类定义明确的依赖关系。一些开发者喜欢以这种方式明确定义依赖关系,因此更倾向于使用契约,而其他开发者则喜欢 facade 的便利性。一般来说,大多数应用程序在开发过程中使用 facade 完全没有问题。
何时使用契约
使用契约还是 facade 取决于个人品味和你的开发团队的偏好。契约和 facade 都可以用来创建健壮的、经过良好测试的 Laravel 应用程序。契约和 facade 并不是互斥的。你的应用程序的某些部分可以使用 facade,而其他部分则依赖契约。只要你保持类的职责集中,你会发现使用契约和 facade 之间的实际差异非常小。
一般来说,大多数应用程序在开发过程中使用 facade 完全没有问题。如果你正在构建一个需要与多个 PHP 框架集成的扩展包,你可能希望使用 illuminate/contracts 包来定义与 Laravel 服务的集成,而无需在扩展包的 composer.json 文件中引入 Laravel 的具体实现。
如何使用契约
那么,如何获取一个契约的实现呢?实际上非常简单。
Laravel 中的许多类型的类都是通过服务容器解析的,包括控制器、事件监听器、middleware、队列任务,甚至路由闭包。因此,要获取一个契约的实现,你只需在被解析的类的构造函数中对接口进行「类型提示」即可。
例如,看看这个事件监听器:
php
<?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
{
// ...
}
}当事件监听器被解析时,服务容器将读取类构造函数上的类型提示,并注入适当的值。要了解更多关于在服务容器中注册内容的信息,请查看其文档。
契约参考
下表提供了所有 Laravel 契约及其对应 facade 的快速参考: