契约
简介
Laravel 的“契约”是一组接口,它们定义了框架提供的核心服务。例如,Illuminate\Contracts\Queue\Queue 契约定义了队列任务所需的方法,而 Illuminate\Contracts\Mail\Mailer 契约定义了发送电子邮件所需的方法。
每个契约都有框架提供的相应实现。例如,Laravel 提供了一个支持多种驱动的队列实现,以及一个由 Symfony Mailer 提供支持的邮件实现。
所有 Laravel 契约都存放在它们自己的 GitHub 仓库中。这为所有可用的契约提供了一个快速参考点,同时也提供了一个独立的、解耦的包,在构建与 Laravel 服务交互的包时可以使用。
契约 vs. 门面
Laravel 的门面和辅助函数提供了一种简单的方式来使用 Laravel 的服务,无需在构造函数中类型提示并从服务容器中解析契约。在大多数情况下,每个门面都有一个等效的契约。
与门面不同(门面不需要你在类的构造函数中显式引入),契约允许你为类定义显式的依赖关系。一些开发者喜欢以这种方式显式定义依赖,因此更倾向于使用契约,而另一些开发者则享受门面带来的便利。总的来说,大多数应用在开发过程中使用门面是没有问题的。
何时使用契约
决定使用契约还是门面将取决于个人喜好和你的开发团队的喜好。契约和门面都可以用来创建健壮、经过良好测试的 Laravel 应用。契约和门面并不是互斥的。你应用的某些部分可能使用门面,而其他部分可能依赖契约。只要你保持类的职责清晰,你会发现使用契约和门面之间几乎没有实际区别。
一般来说,大多数应用在开发过程中使用门面是没有问题的。如果你正在构建一个需要与多个 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
{
/**
* 创建事件监听器。
*/
public function __construct(
protected Factory $redis,
) {}
/**
* 处理事件。
*/
public function handle(OrderWasPlaced $event): void
{
// ...
}
}当事件监听器被解析时,服务容器会读取类构造函数中的类型提示,并注入相应的值。要了解有关在服务容器中注册内容的更多信息,请查看其文档。
契约参考
下表提供了所有 Laravel 契约及其等效门面的快速参考: