Laravel 13 中文文档Contracts
契约
简介
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 契约及其对应门面的快速参考：
本译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。
关于 LearnKu
粤公网安备 44030502004330号