跳到內容

合約

簡介

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 中的許多類別型別都透過 服務容器 解析,包括控制器、事件監聽器、中介層、佇列任務,甚至路由閉包。因此,要獲得合約的實作,您只需在正在解析的類別的建構子中「類型提示」介面即可。

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

1<?php
2 
3namespace App\Listeners;
4 
5use App\Events\OrderWasPlaced;
6use App\Models\User;
7use Illuminate\Contracts\Redis\Factory;
8 
9class CacheOrderInformation
10{
11 /**
12 * Create a new event handler instance.
13 */
14 public function __construct(
15 protected Factory $redis,
16 ) {}
17 
18 /**
19 * Handle the event.
20 */
21 public function handle(OrderWasPlaced $event): void
22 {
23 // ...
24 }
25}

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

合約參考

下表快速參考了所有 Laravel 合約及其等效的 Facades(外觀模式)

合約 參考 Facade(外觀模式)
Illuminate\Contracts\Auth\Access\Authorizable  
Illuminate\Contracts\Auth\Access\Gate Gate
Illuminate\Contracts\Auth\Authenticatable  
Illuminate\Contracts\Auth\CanResetPassword  
Illuminate\Contracts\Auth\Factory Auth
Illuminate\Contracts\Auth\Guard Auth::guard()
Illuminate\Contracts\Auth\PasswordBroker Password::broker()
Illuminate\Contracts\Auth\PasswordBrokerFactory Password
Illuminate\Contracts\Auth\StatefulGuard  
Illuminate\Contracts\Auth\SupportsBasicAuth  
Illuminate\Contracts\Auth\UserProvider  
Illuminate\Contracts\Broadcasting\Broadcaster Broadcast::connection()
Illuminate\Contracts\Broadcasting\Factory Broadcast
Illuminate\Contracts\Broadcasting\ShouldBroadcast  
Illuminate\Contracts\Broadcasting\ShouldBroadcastNow  
Illuminate\Contracts\Bus\Dispatcher Bus
Illuminate\Contracts\Bus\QueueingDispatcher Bus::dispatchToQueue()
Illuminate\Contracts\Cache\Factory 快取
Illuminate\Contracts\Cache\Lock  
Illuminate\Contracts\Cache\LockProvider  
Illuminate\Contracts\Cache\Repository Cache::driver()
Illuminate\Contracts\Cache\Store  
Illuminate\Contracts\Config\Repository Config
Illuminate\Contracts\Console\Application  
Illuminate\Contracts\Console\Kernel Artisan
Illuminate\Contracts\Container\Container App
Illuminate\Contracts\Cookie\Factory Cookie
Illuminate\Contracts\Cookie\QueueingFactory Cookie::queue()
Illuminate\Contracts\Database\ModelIdentifier  
Illuminate\Contracts\Debug\ExceptionHandler  
Illuminate\Contracts\Encryption\Encrypter Crypt
Illuminate\Contracts\Events\Dispatcher Event
Illuminate\Contracts\Filesystem\Cloud Storage::cloud()
Illuminate\Contracts\Filesystem\Factory Storage
Illuminate\Contracts\Filesystem\Filesystem Storage::disk()
Illuminate\Contracts\Foundation\Application App
Illuminate\Contracts\Hashing\Hasher Hash
Illuminate\Contracts\Http\Kernel  
Illuminate\Contracts\Mail\Mailable  
Illuminate\Contracts\Mail\Mailer Mail(郵件)
Illuminate\Contracts\Mail\MailQueue Mail::queue()
Illuminate\Contracts\Notifications\Dispatcher Notification
Illuminate\Contracts\Notifications\Factory Notification
Illuminate\Contracts\Pagination\LengthAwarePaginator  
Illuminate\Contracts\Pagination\Paginator  
Illuminate\Contracts\Pipeline\Hub  
Illuminate\Contracts\Pipeline\Pipeline Pipeline
Illuminate\Contracts\Queue\EntityResolver  
Illuminate\Contracts\Queue\Factory Queue
Illuminate\Contracts\Queue\Job  
Illuminate\Contracts\Queue\Monitor Queue
Illuminate\Contracts\Queue\Queue Queue::connection()
Illuminate\Contracts\Queue\QueueableCollection  
Illuminate\Contracts\Queue\QueueableEntity  
Illuminate\Contracts\Queue\ShouldQueue  
Illuminate\Contracts\Redis\Factory Redis
Illuminate\Contracts\Routing\BindingRegistrar Route
Illuminate\Contracts\Routing\Registrar Route
Illuminate\Contracts\Routing\ResponseFactory Response
Illuminate\Contracts\Routing\UrlGenerator URL
Illuminate\Contracts\Routing\UrlRoutable  
Illuminate\Contracts\Session\Session Session::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\Translator Lang
Illuminate\Contracts\Validation\Factory Validator
Illuminate\Contracts\Validation\ValidatesWhenResolved  
Illuminate\Contracts\Validation\ValidationRule  
Illuminate\Contracts\Validation\Validator Validator::make()
Illuminate\Contracts\View\Engine  
Illuminate\Contracts\View\Factory View
Illuminate\Contracts\View\View View::make()