Contracts

• Introduction
  • 合同与。立面
• 何时使用合约
• 如何使用合约
• 合同参考

#Introduction

Laravel 的“契约”是一组定义框架提供的核心服务的接口。例如，一个Illuminate\Contracts\Queue\Queue 合同定义排队作业所需的方法，而Illuminate\Contracts\Mail\Mailer contract 定义发送电子邮件所需的方法。

每个合约都有框架提供的相应实现。例如，Laravel 提供了一个带有各种驱动程序的队列实现，以及一个由Symfony 邮件程序.

所有 Laravel 合约都位于他们自己的 GitHub 仓库.这为所有可用的合约提供了一个快速参考点，以及一个单独的、解耦的包，可以在构建与 Laravel 服务交互的包时使用。

#合同与。立面

Laravel 的facades 和辅助函数提供了一种使用 Laravel 服务的简单方法，无需类型提示和解析服务容器外的契约。在大多数情况下，每个外观都有一个等效的契约。

与不需要您在类的构造函数中要求它们的外观不同，契约允许您为类定义显式依赖项。一些开发人员更喜欢以这种方式显式定义他们的依赖关系，因此更喜欢使用契约，而其他开发人员则享受外观的便利。通常，大多数应用程序在开发过程中都可以毫无问题地使用外观。

#何时使用合约

使用契约或门面的决定将归结为个人品味和您的开发团队的品味。契约和门面都可以用来创建健壮的、经过良好测试的 Laravel 应用程序。契约和门面并不相互排斥。您的应用程序的某些部分可能使用外观，而其他部分则依赖于契约。只要您专注于班级的职责，您就会注意到使用契约和外观之间几乎没有实际差异。

通常，大多数应用程序在开发过程中都可以毫无问题地使用外观。如果您正在构建一个与多个 PHP 框架集成的包，您可能希望使用illuminate/contracts 包来定义你与 Laravel 服务的集成，而不需要在你的包中要求 Laravel 的具体实现composer.json 文件。

#如何使用合约

那么，您如何获得合约的实施呢？其实很简单。

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 契约及其等效外观的快速参考：