合约

介绍
- 合约 vs. Facades
何时使用合约
如何使用合约
合约参考

介绍

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

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

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

合约 vs. Facades

Laravel 的 facades 和辅助函数提供了一种简单的方法来利用 Laravel 的服务，而无需在服务容器中进行类型提示和解析合约。在大多数情况下，每个 facade 都有一个等效的合约。

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

何时使用合约

使用合约还是 facades 的决定将取决于个人品味和开发团队的品味。合约和 facades 都可以用来创建健壮、经过良好测试的 Laravel 应用程序。合约和 facades 并不互斥。应用程序的某些部分可能使用 facades，而其他部分依赖于合约。只要您保持类的职责集中，您将很少注意到使用合约和 facades 之间的实际差异。

通常，大多数应用程序在开发过程中可以毫无问题地使用 facades。如果您正在构建一个与多个 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 合约及其等效 facades 的快速参考：

合约	参考 Facade
[Illuminate\Contracts\Auth\Access\Authorizable](https://github.com/illuminate/contracts/blob/10.x/Auth/Access/Authorizable.php)
[Illuminate\Contracts\Auth\Access\Gate](https://github.com/illuminate/contracts/blob/10.x/Auth/Access/Gate.php)	`Gate`
[Illuminate\Contracts\Auth\Authenticatable](https://github.com/illuminate/contracts/blob/10.x/Auth/Authenticatable.php)
[Illuminate\Contracts\Auth\CanResetPassword](https://github.com/illuminate/contracts/blob/10.x/Auth/CanResetPassword.php)
[Illuminate\Contracts\Auth\Factory](https://github.com/illuminate/contracts/blob/10.x/Auth/Factory.php)	`Auth`
[Illuminate\Contracts\Auth\Guard](https://github.com/illuminate/contracts/blob/10.x/Auth/Guard.php)	`Auth::guard()`
[Illuminate\Contracts\Auth\PasswordBroker](https://github.com/illuminate/contracts/blob/10.x/Auth/PasswordBroker.php)	`Password::broker()`
[Illuminate\Contracts\Auth\PasswordBrokerFactory](https://github.com/illuminate/contracts/blob/10.x/Auth/PasswordBrokerFactory.php)	`Password`
[Illuminate\Contracts\Auth\StatefulGuard](https://github.com/illuminate/contracts/blob/10.x/Auth/StatefulGuard.php)
[Illuminate\Contracts\Auth\SupportsBasicAuth](https://github.com/illuminate/contracts/blob/10.x/Auth/SupportsBasicAuth.php)
[Illuminate\Contracts\Auth\UserProvider](https://github.com/illuminate/contracts/blob/10.x/Auth/UserProvider.php)
[Illuminate\Contracts\Bus\Dispatcher](https://github.com/illuminate/contracts/blob/10.x/Bus/Dispatcher.php)	`Bus`
[Illuminate\Contracts\Bus\QueueingDispatcher](https://github.com/illuminate/contracts/blob/10.x/Bus/QueueingDispatcher.php)	`Bus::dispatchToQueue()`
[Illuminate\Contracts\Broadcasting\Factory](https://github.com/illuminate/contracts/blob/10.x/Broadcasting/Factory.php)	`Broadcast`
[Illuminate\Contracts\Broadcasting\Broadcaster](https://github.com/illuminate/contracts/blob/10.x/Broadcasting/Broadcaster.php)	`Broadcast::connection()`
[Illuminate\Contracts\Broadcasting\ShouldBroadcast](https://github.com/illuminate/contracts/blob/10.x/Broadcasting/ShouldBroadcast.php)
[Illuminate\Contracts\Broadcasting\ShouldBroadcastNow](https://github.com/illuminate/contracts/blob/10.x/Broadcasting/ShouldBroadcastNow.php)
[Illuminate\Contracts\Cache\Factory](https://github.com/illuminate/contracts/blob/10.x/Cache/Factory.php)	`Cache`
[Illuminate\Contracts\Cache\Lock](https://github.com/illuminate/contracts/blob/10.x/Cache/Lock.php)
[Illuminate\Contracts\Cache\LockProvider](https://github.com/illuminate/contracts/blob/10.x/Cache/LockProvider.php)
[Illuminate\Contracts\Cache\Repository](https://github.com/illuminate/contracts/blob/10.x/Cache/Repository.php)	`Cache::driver()`
[Illuminate\Contracts\Cache\Store](https://github.com/illuminate/contracts/blob/10.x/Cache/Store.php)
[Illuminate\Contracts\Config\Repository](https://github.com/illuminate/contracts/blob/10.x/Config/Repository.php)	`Config`
[Illuminate\Contracts\Console\Application](https://github.com/illuminate/contracts/blob/10.x/Console/Application.php)
[Illuminate\Contracts\Console\Kernel](https://github.com/illuminate/contracts/blob/10.x/Console/Kernel.php)	`Artisan`
[Illuminate\Contracts\Container\Container](https://github.com/illuminate/contracts/blob/10.x/Container/Container.php)	`App`
[Illuminate\Contracts\Cookie\Factory](https://github.com/illuminate/contracts/blob/10.x/Cookie/Factory.php)	`Cookie`
[Illuminate\Contracts\Cookie\QueueingFactory](https://github.com/illuminate/contracts/blob/10.x/Cookie/QueueingFactory.php)	`Cookie::queue()`
[Illuminate\Contracts\Database\ModelIdentifier](https://github.com/illuminate/contracts/blob/10.x/Database/ModelIdentifier.php)
[Illuminate\Contracts\Debug\ExceptionHandler](https://github.com/illuminate/contracts/blob/10.x/Debug/ExceptionHandler.php)
[Illuminate\Contracts\Encryption\Encrypter](https://github.com/illuminate/contracts/blob/10.x/Encryption/Encrypter.php)	`Crypt`
[Illuminate\Contracts\Events\Dispatcher](https://github.com/illuminate/contracts/blob/10.x/Events/Dispatcher.php)	`Event`
[Illuminate\Contracts\Filesystem\Cloud](https://github.com/illuminate/contracts/blob/10.x/Filesystem/Cloud.php)	`Storage::cloud()`
[Illuminate\Contracts\Filesystem\Factory](https://github.com/illuminate/contracts/blob/10.x/Filesystem/Factory.php)	`Storage`
[Illuminate\Contracts\Filesystem\Filesystem](https://github.com/illuminate/contracts/blob/10.x/Filesystem/Filesystem.php)	`Storage::disk()`
[Illuminate\Contracts\Foundation\Application](https://github.com/illuminate/contracts/blob/10.x/Foundation/Application.php)	`App`
[Illuminate\Contracts\Hashing\Hasher](https://github.com/illuminate/contracts/blob/10.x/Hashing/Hasher.php)	`Hash`
[Illuminate\Contracts\Http\Kernel](https://github.com/illuminate/contracts/blob/10.x/Http/Kernel.php)
[Illuminate\Contracts\Mail\MailQueue](https://github.com/illuminate/contracts/blob/10.x/Mail/MailQueue.php)	`Mail::queue()`
[Illuminate\Contracts\Mail\Mailable](https://github.com/illuminate/contracts/blob/10.x/Mail/Mailable.php)
[Illuminate\Contracts\Mail\Mailer](https://github.com/illuminate/contracts/blob/10.x/Mail/Mailer.php)	`Mail`
[Illuminate\Contracts\Notifications\Dispatcher](https://github.com/illuminate/contracts/blob/10.x/Notifications/Dispatcher.php)	`Notification`
[Illuminate\Contracts\Notifications\Factory](https://github.com/illuminate/contracts/blob/10.x/Notifications/Factory.php)	`Notification`
[Illuminate\Contracts\Pagination\LengthAwarePaginator](https://github.com/illuminate/contracts/blob/10.x/Pagination/LengthAwarePaginator.php)
[Illuminate\Contracts\Pagination\Paginator](https://github.com/illuminate/contracts/blob/10.x/Pagination/Paginator.php)
[Illuminate\Contracts\Pipeline\Hub](https://github.com/illuminate/contracts/blob/10.x/Pipeline/Hub.php)
[Illuminate\Contracts\Pipeline\Pipeline](https://github.com/illuminate/contracts/blob/10.x/Pipeline/Pipeline.php)	`Pipeline`;
[Illuminate\Contracts\Queue\EntityResolver](https://github.com/illuminate/contracts/blob/10.x/Queue/EntityResolver.php)
[Illuminate\Contracts\Queue\Factory](https://github.com/illuminate/contracts/blob/10.x/Queue/Factory.php)	`Queue`
[Illuminate\Contracts\Queue\Job](https://github.com/illuminate/contracts/blob/10.x/Queue/Job.php)
[Illuminate\Contracts\Queue\Monitor](https://github.com/illuminate/contracts/blob/10.x/Queue/Monitor.php)	`Queue`
[Illuminate\Contracts\Queue\Queue](https://github.com/illuminate/contracts/blob/10.x/Queue/Queue.php)	`Queue::connection()`
[Illuminate\Contracts\Queue\QueueableCollection](https://github.com/illuminate/contracts/blob/10.x/Queue/QueueableCollection.php)
[Illuminate\Contracts\Queue\QueueableEntity](https://github.com/illuminate/contracts/blob/10.x/Queue/QueueableEntity.php)
[Illuminate\Contracts\Queue\ShouldQueue](https://github.com/illuminate/contracts/blob/10.x/Queue/ShouldQueue.php)
[Illuminate\Contracts\Redis\Factory](https://github.com/illuminate/contracts/blob/10.x/Redis/Factory.php)	`Redis`
[Illuminate\Contracts\Routing\BindingRegistrar](https://github.com/illuminate/contracts/blob/10.x/Routing/BindingRegistrar.php)	`Route`
[Illuminate\Contracts\Routing\Registrar](https://github.com/illuminate/contracts/blob/10.x/Routing/Registrar.php)	`Route`
[Illuminate\Contracts\Routing\ResponseFactory](https://github.com/illuminate/contracts/blob/10.x/Routing/ResponseFactory.php)	`Response`
[Illuminate\Contracts\Routing\UrlGenerator](https://github.com/illuminate/contracts/blob/10.x/Routing/UrlGenerator.php)	`URL`
[Illuminate\Contracts\Routing\UrlRoutable](https://github.com/illuminate/contracts/blob/10.x/Routing/UrlRoutable.php)
[Illuminate\Contracts\Session\Session](https://github.com/illuminate/contracts/blob/10.x/Session/Session.php)	`Session::driver()`
[Illuminate\Contracts\Support\Arrayable](https://github.com/illuminate/contracts/blob/10.x/Support/Arrayable.php)
[Illuminate\Contracts\Support\Htmlable](https://github.com/illuminate/contracts/blob/10.x/Support/Htmlable.php)
[Illuminate\Contracts\Support\Jsonable](https://github.com/illuminate/contracts/blob/10.x/Support/Jsonable.php)
[Illuminate\Contracts\Support\MessageBag](https://github.com/illuminate/contracts/blob/10.x/Support/MessageBag.php)
[Illuminate\Contracts\Support\MessageProvider](https://github.com/illuminate/contracts/blob/10.x/Support/MessageProvider.php)
[Illuminate\Contracts\Support\Renderable](https://github.com/illuminate/contracts/blob/10.x/Support/Renderable.php)
[Illuminate\Contracts\Support\Responsable](https://github.com/illuminate/contracts/blob/10.x/Support/Responsable.php)
[Illuminate\Contracts\Translation\Loader](https://github.com/illuminate/contracts/blob/10.x/Translation/Loader.php)
[Illuminate\Contracts\Translation\Translator](https://github.com/illuminate/contracts/blob/10.x/Translation/Translator.php)	`Lang`
[Illuminate\Contracts\Validation\Factory](https://github.com/illuminate/contracts/blob/10.x/Validation/Factory.php)	`Validator`
[Illuminate\Contracts\Validation\ImplicitRule](https://github.com/illuminate/contracts/blob/10.x/Validation/ImplicitRule.php)
[Illuminate\Contracts\Validation\Rule](https://github.com/illuminate/contracts/blob/10.x/Validation/Rule.php)
[Illuminate\Contracts\Validation\ValidatesWhenResolved](https://github.com/illuminate/contracts/blob/10.x/Validation/ValidatesWhenResolved.php)
[Illuminate\Contracts\Validation\Validator](https://github.com/illuminate/contracts/blob/10.x/Validation/Validator.php)	`Validator::make()`
[Illuminate\Contracts\View\Engine](https://github.com/illuminate/contracts/blob/10.x/View/Engine.php)
[Illuminate\Contracts\View\Factory](https://github.com/illuminate/contracts/blob/10.x/View/Factory.php)	`View`
[Illuminate\Contracts\View\View](https://github.com/illuminate/contracts/blob/10.x/View/View.php)	`View::make()`

合约 ​ ​

介绍 ​ ​

合约 vs. Facades ​ ​

何时使用合约 ​ ​

如何使用合约 ​ ​

合约参考 ​ ​

合约

介绍

合约 vs. Facades

何时使用合约

如何使用合约

合约参考