Laravel的「合約」是一組介面,定義了框架提供的核心服務。例如,Illuminate\Contracts\Queue\Queue
合約定義了排程工作所需的方法,而Illuminate\Contracts\Mail\Mailer
合約定義了發送電子郵件所需的方法。
每個合約都有框架提供的相應實現。例如,Laravel提供了具有各種驅動程式的排程實現,以及由Symfony Mailer提供動力的郵件實現。
所有Laravel合約都存放在它們自己的 GitHub 存儲庫中。這提供了所有可用合約的快速參考點,以及一個可以在與 Laravel 服務互動的套件構建時使用的單一、解耦的套件。
Laravel的facades和輔助函式提供了一種簡單的方式來使用 Laravel 的服務,而無需對服務容器進行型別提示和解析合約。在大多數情況下,每個 facade 都有一個對應的合約。
與不需要在類別的建構子中引入它們不同,合約允許您為類別定義明確的依賴關係。一些開發人員喜歡以這種方式明確定義他們的依賴關係,因此更喜歡使用合約,而其他開發人員則喜歡使用 facades 的便利性。一般來說,在開發過程中,大多數應用程式可以無問題地使用 facades。
使用合約或 facades 的決定將取決於個人口味和您的開發團隊的口味。合約和 facades 都可以用於創建堅固、經過良好測試的 Laravel 應用程式。合約和 facades 不是互斥的。應用程式的某些部分可能使用 facades,而其他部分依賴於合約。只要保持類別的責任專注,您將會注意到在使用合約和 facades 之間幾乎沒有實際差異。
一般來說,大多數應用程式在開發過程中可以毫無問題地使用 Facedes。如果您正在建立一個與多個 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 合約及其對應 Facedes 的快速參考: