Skip to content

契約

簡介

Laravel 的「契約」(contracts) 是一組介面,定義了框架提供的核心服務。例如,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 中的許多類別都是透過 服務容器 解析的,包括控制器、事件監聽器、中介層 (middleware)、佇列任務,甚至是路由閉包。因此,要取得契約的實作,你只需在被解析類別的建構子中「型別提示」該介面即可。

例如,看看這個事件監聽器:

php
<?php

namespace App\Listeners;

use App\Events\OrderWasPlaced;
use App\Models\User;
use Illuminate\Contracts\Redis\Factory;

class CacheOrderInformation
{
    /**
     * Create the event listener.
     */
    public function __construct(
        protected Factory $redis,
    ) {}

    /**
     * Handle the event.
     */
    public function handle(OrderWasPlaced $event): void
    {
        // ...
    }
}

當事件監聽器被解析時,服務容器將讀取類別建構子上的型別提示,並注入適當的值。要了解更多關於在服務容器中註冊內容的資訊,請查看 其文件

契約參考

此表格提供了所有 Laravel 契約及其對應 Facades 的快速參考:

契約對應 Facade
Illuminate\Contracts\Auth\Access\Authorizable 
Illuminate\Contracts\Auth\Access\GateGate
Illuminate\Contracts\Auth\Authenticatable 
Illuminate\Contracts\Auth\CanResetPassword 
Illuminate\Contracts\Auth\FactoryAuth
Illuminate\Contracts\Auth\GuardAuth::guard()
Illuminate\Contracts\Auth\PasswordBrokerPassword::broker()
Illuminate\Contracts\Auth\PasswordBrokerFactoryPassword
Illuminate\Contracts\Auth\StatefulGuard 
Illuminate\Contracts\Auth\SupportsBasicAuth 
Illuminate\Contracts\Auth\UserProvider 
Illuminate\Contracts\Broadcasting\BroadcasterBroadcast::connection()
Illuminate\Contracts\Broadcasting\FactoryBroadcast
Illuminate\Contracts\Broadcasting\ShouldBroadcast 
Illuminate\Contracts\Broadcasting\ShouldBroadcastNow 
Illuminate\Contracts\Bus\DispatcherBus
Illuminate\Contracts\Bus\QueueingDispatcherBus::dispatchToQueue()
Illuminate\Contracts\Cache\FactoryCache
Illuminate\Contracts\Cache\Lock 
Illuminate\Contracts\Cache\LockProvider 
Illuminate\Contracts\Cache\RepositoryCache::driver()
Illuminate\Contracts\Cache\Store 
Illuminate\Contracts\Config\RepositoryConfig
Illuminate\Contracts\Console\Application 
Illuminate\Contracts\Console\KernelArtisan
Illuminate\Contracts\Container\ContainerApp
Illuminate\Contracts\Cookie\FactoryCookie
Illuminate\Contracts\Cookie\QueueingFactoryCookie::queue()
Illuminate\Contracts\Database\ModelIdentifier 
Illuminate\Contracts\Debug\ExceptionHandler 
Illuminate\Contracts\Encryption\EncrypterCrypt
Illuminate\Contracts\Events\DispatcherEvent
Illuminate\Contracts\Filesystem\CloudStorage::cloud()
Illuminate\Contracts\Filesystem\FactoryStorage
Illuminate\Contracts\Filesystem\FilesystemStorage::disk()
Illuminate\Contracts\Foundation\ApplicationApp
Illuminate\Contracts\Hashing\HasherHash
Illuminate\Contracts\Http\Kernel 
Illuminate\Contracts\Mail\Mailable 
Illuminate\Contracts\Mail\MailerMail
Illuminate\Contracts\Mail\MailQueueMail::queue()
Illuminate\Contracts\Notifications\DispatcherNotification
Illuminate\Contracts\Notifications\FactoryNotification
Illuminate\Contracts\Pagination\LengthAwarePaginator 
Illuminate\Contracts\Pagination\Paginator 
Illuminate\Contracts\Pipeline\Hub 
Illuminate\Contracts\Pipeline\PipelinePipeline
Illuminate\Contracts\Queue\EntityResolver 
Illuminate\Contracts\Queue\FactoryQueue
Illuminate\Contracts\Queue\Job 
Illuminate\Contracts\Queue\MonitorQueue
Illuminate\Contracts\Queue\QueueQueue::connection()
Illuminate\Contracts\Queue\QueueableCollection 
Illuminate\Contracts\Queue\QueueableEntity 
Illuminate\Contracts\Queue\ShouldQueue 
Illuminate\Contracts\Redis\FactoryRedis
Illuminate\Contracts\Routing\BindingRegistrarRoute
Illuminate\Contracts\Routing\RegistrarRoute
Illuminate\Contracts\Routing\ResponseFactoryResponse
Illuminate\Contracts\Routing\UrlGeneratorURL
Illuminate\Contracts\Routing\UrlRoutable 
Illuminate\Contracts\Session\SessionSession::driver()
Illuminate\Contracts\Support\Arrayable 
Illuminate\Contracts\Support\Htmlable 
Illuminate\Contracts\Support\Jsonable 
Illuminate\Contracts\Support\MessageBag 
Illuminate\Contracts\Support\MessageProvider 
Illuminate\Contracts\Support\Renderable 
Illuminate\Contracts\Support\Responsable 
Illuminate\Contracts\Translation\Loader 
Illuminate\Contracts\Translation\TranslatorLang
Illuminate\Contracts\Validation\FactoryValidator
Illuminate\Contracts\Validation\ValidatesWhenResolved 
Illuminate\Contracts\Validation\ValidationRule 
Illuminate\Contracts\Validation\ValidatorValidator::make()
Illuminate\Contracts\View\Engine 
Illuminate\Contracts\View\FactoryView
Illuminate\Contracts\View\ViewView::make()