主题
契约
介绍
Laravel 的“契约”是一组定义框架提供的核心服务的接口。例如,Illuminate\Contracts\Queue\Queue
契约定义了队列作业所需的方法,而 Illuminate\Contracts\Mail\Mailer
契约定义了发送电子邮件所需的方法。
每个契约都有框架提供的相应实现。例如,Laravel 提供了一个具有多种驱动程序的队列实现,以及一个由 Symfony Mailer 驱动的邮件发送实现。
所有 Laravel 契约都存在于它们自己的 GitHub 仓库中。这为所有可用的契约提供了一个快速参考点,以及一个单一的、解耦的包,可以在构建与 Laravel 服务交互的包时使用。
契约与 Facades
Laravel 的 facades 和辅助函数提供了一种简单的方式,无需类型提示并从服务容器中解析契约,就可以使用 Laravel 的服务。在大多数情况下,每个 facade 都有一个等效的契约。
与不需要你在类的构造函数中要求它们的 facades 不同,契约允许你为你的类定义显式依赖关系。有些开发者更喜欢以这种方式明确定义他们的依赖关系,因此更喜欢使用契约,而其他开发者则欣赏 facades 的便利性。一般来说,大多数应用在开发过程中都可以无问题地使用 facades。
何时使用契约
使用契约或 facades 的决定将取决于个人口味和你的开发团队的口味。契约和 facades 都可以用来创建健壮、经过良好测试的 Laravel 应用程序。契约和 facades 并不是相互排斥的。你的应用的某些部分可能使用 facades,而其他部分依赖于契约。只要你保持你的类职责集中,你会发现使用契约和 facades 之间的实际区别很少。
一般来说,大多数应用在开发过程中都可以无问题地使用 facades。如果你正在构建一个与多个 PHP 框架集成的包,你可能希望使用 illuminate/contracts
包来定义你与 Laravel 服务的集成,而不需要在你包的 composer.json
文件中要求 Laravel 的具体实现。
如何使用契约
那么,你如何获得一个契约的实现呢?实际上很简单。
Laravel 中的许多类型的类都是通过服务容器解析的,包括控制器、事件监听器、中间件、队列作业,甚至路由闭包。所以,要获得契约的实现,你只需要在解析类的构造函数中“类型提示”该接口。
例如,看看这个事件监听器:
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 契约及其等效 facades 的快速参考: