契約¶
はじめに¶
Laravelの「契約」は、フレームワークが提供するコアサービスを定義する一連のインターフェースです。例えば、Illuminate\Contracts\Queue\Queue契約はジョブをキューに入れるために必要なメソッドを定義し、Illuminate\Contracts\Mail\Mailer契約は電子メールを送信するために必要なメソッドを定義します。
各契約には、フレームワークによって提供される対応する実装があります。例えば、Laravelはさまざまなドライバーを持つキュー実装と、Symfony Mailerを利用したメーラー実装を提供します。
すべてのLaravel契約は独自のGitHubリポジトリに存在します。これにより、利用可能なすべての契約へのクイックリファレンスが提供され、Laravelサービスと対話するパッケージを構築する際に使用できる単一の分離されたパッケージが提供されます。
契約 vs. ファサード¶
Laravelのファサードとヘルパー関数は、サービスコンテナから契約をタイプヒントして解決する必要なく、Laravelのサービスを利用するための簡単な方法を提供します。ほとんどの場合、各ファサードには対応する契約があります。
ファサードとは異なり、クラスのコンストラクタでそれらを要求する必要がないため、契約を使用するとクラスの明示的な依存関係を定義できます。一部の開発者は依存関係をこのように明示的に定義することを好み、そのため契約を使用することを好みますが、他の開発者はファサードの便利さを楽しんでいます。一般的に、ほとんどのアプリケーションは開発中に問題なくファサードを使用できます。
契約をいつ使うか¶
契約とファサードのどちらを使用するかの決定は、個人的な好みと開発チームの好みに帰着します。契約とファサードの両方を使用して、堅牢で十分にテストされたLaravelアプリケーションを作成できます。契約とファサードは相互排他的ではありません。アプリケーションの一部はファサードを使用し、他の部分は契約に依存することがあります。クラスの責任を集中させている限り、契約とファサードの使用において実際的な違いはほとんどありません。
一般的に、ほとんどのアプリケーションは開発中に問題なくファサードを使用できます。複数のPHPフレームワークと統合するパッケージを構築している場合は、パッケージのcomposer.jsonファイルでLaravelの具体的な実装を要求する必要なく、Laravelのサービスとの統合を定義するためにilluminate/contractsパッケージを使用することを希望するかもしれません。
契約の使い方¶
では、契約の実装をどのように取得するのでしょうか？実際には非常に簡単です。
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契約とそれに対応するファサードへのクイックリファレンスを提供します：