简介
Laravel 的“契约(contracts)”是一组用于定义框架所提供核心服务的接口。例如,Illuminate\Contracts\Queue\Queue 契约定义了队列任务所需的方法,而 Illuminate\Contracts\Mail\Mailer 契约则定义了发送电子邮件所需的方法。
每个契约都有框架提供的对应实现。例如,Laravel 提供了多种驱动的队列实现,以及由Symfony Mailer支持的邮件发送实现。
所有 Laravel 契约都存放在它们专属的 GitHub 仓库中。这为所有可用契约提供了快速参考,同时提供了一个独立的、松耦合的包,在构建与 Laravel 服务交互的包时可以使用该包。
契约与门面
Laravel 的门面(facades)和辅助函数提供了一种使用 Laravel 服务的简便方式,无需从服务容器中对契约进行类型提示(type-hint)和解析。在大多数情况下,每个门面都有一个等效的契约。
与无需在类的构造函数中引入的门面不同,契约允许你为类明确定义依赖关系。有些开发者倾向于以这种方式明确定义依赖,因此更偏好使用契约;而另一些开发者则喜欢门面的便捷性。总的来说,在开发过程中,大多数应用都可以毫无问题地使用门面。
何时使用契约
选择使用契约还是门面,主要取决于个人喜好以及开发团队的偏好。契约和门面都可用于构建健壮且经过充分测试的 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
{
/**
* Create the event listener.
*/
public function __construct(
protected Factory $redis,
) {}
/**
* Handle the event.
*/
public function handle(OrderWasPlaced $event): void
{
// ...
}
}当解析事件监听器时,服务容器会读取该类构造函数上的类型提示,并注入相应的值。要了解有关在服务容器中注册内容的更多信息,请查看其文档。
契约参考
下表提供了所有 Laravel 契约及其对应门面的快速参考: