契约

• 介绍
  • 契约与门面
• 何时使用契约
• 如何使用契约
• 契约参考

介绍

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
{
    /**
     * Create a new event handler instance.
     */
    public function __construct(
        protected Factory $redis,
    ) {}
 
    /**
     * Handle the event.
     */
    public function handle(OrderWasPlaced $event): void
    {
        // ...
    }
}

当事件监听器被解析时，服务容器将读取类构造函数上的类型提示，并注入相应的值。要了解有关在服务容器中注册内容的更多信息，请查看 其文档。

契约参考

此表提供所有 Laravel 契约及其等效门面的快速参考