契约
简介
Laravel 的"契约"是一组定义框架提供的核心服务的接口。例如,Illuminate\Contracts\Queue\Queue 契约定义了队列任务所需的方法,而 Illuminate\Contracts\Mail\Mailer 契约定义了发送电子邮件所需的方法。
每个契约都有框架提供的相应实现。例如,Laravel 提供了具有各种驱动程序的队列实现,以及由 Symfony Mailer 驱动的邮件程序实现。
所有 Laravel 契约都位于 它们自己的 GitHub 存储库 中。这为所有可用契约提供了一个快速参考点,以及一个单独的、解耦的包,在构建与 Laravel 服务交互的包时可以使用。
契约与门面
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 契约及其等效门面的快速参考: