BackEnd

LaravelのFacade(ファサード)とは? 何気なく使用していた裏側の仕組みを解説!

投稿日:

はじめに

Laravelで開発を行なっていると、use文で Illuminate\Support\Facades\ の中を指定する場合があります。しかし、実態は振る舞いを持たないクラスがほとんどです。これが、実際はどのような動きをしているのか、説明したいと思います。

Facadeを使用しているクラス

Laravel単体で使用頻度の高いものとしては、以下が挙げられます。

  • Auth
  • DB
  • Config
  • Log
  • Storage
  • Route

どれも、staticメソッドで利用できるクラスばかりだと思います。この中の Log クラスを例に、どのような仕組みになっているか、次節で説明します。
また、Laravelだけでも、この他にFacadeを使用しているクラスがあります。ドキュメントにまとまっているので、こちらを参照してください。

Facadeの仕組み

Facadeは、サービスコンテナに結合されたサービスのインタンスにアクセスする方法の一つです。他の方法は、こちらの記事で紹介しているような、 make() メソッドを使用する方法や、コンストラクタインジェクション、メソッドインジェクションを使用した方法です。
他の方法と比較し、Facadeはどこでも気軽にサービスコンテナのインスタンスにアクセスし、機能を呼び出せることが特徴です。
例えば、Logクラスも、Facadeです。 LogServiceProvider によって LogManager クラスがシングルトンでバインドされています。
実際に、 Log::info('Hello') を呼び出した時の、流れを見てみましょう。
順を追うと以下のようになります。

  1. Log のスーパークラスであるFacadeの __callStatic() が呼び出される。この際、第1引数にメソッド名、第2引数に配列で引数が渡されます。
  2. getFacadeRoot() が呼び出され、サービスコンテナにインスタンスを取りに行きます。このメソッド内では、以下のように処理されるます。
    2-1. getFacadeAccessor() が呼び出される。このメソッドは、 Log によってオーバーライドされており、サービスプロバイダに設定されている結合名が返却されます。
    2-2. resolveFacadeInstance() が呼び出され、取得した結合名でサービスコンテナからサービスのインスタンスを取得します。(この例では、 LogManager が取得できます)
  3. 取得したサービスに対して、引数で渡ってきたメソッド名と引数を、可変関数として呼び出し、結果をそのまま返却します。

Facadeの作成

Facadeを作成する方法を説明します。今回は、図書館システムの貸し出し機能を想定したサンプルコードです。「本を借りる」機能をFacadeを使用して呼び出せるようにします。

サンプルコードに必要な実装

以下のマイグレーションと実装をベースに、ServiceとFacadeを作成します。

マイグレーション:

モデル:

Serviceの作成

FacadeがアクセスするServiceを、 app/Services/ ディレクトリの中に作成します。

次に、サービスプロバイダにバインドします。今回は、 AppServiceProvidor を使用します。

bind() メソッドの第1引数で、サービスコンテナの結合名を指定しています。後ほど、Facadeの実装時に、この結合名を使用します。

サービスコンテナ・サービスプロバイダについては、以前の記事も参考にしてみてください。

Facadeクラスの作成

先ほど作成した Services\Library クラス用のFacadeを作成します。 app/Facades ディレクトリに作成してください。

getFacadeAccessor() メソッドで、先ほどのサービスプロバイダで設定した結合名を指定します。

Facadeの呼び出し

コントローラーから呼び出してみます。

staticメソッドの呼び出し方で、Serviceに定義したメソッド checkOut() を呼び出しています。また、use文では、Facadeを指定する点がポイントです。

さいごに

サービスを使用する方法の1つとして、Facadeは便利な機能です。コンストラクタインジェクションやメソッドインジェクションで済む場合も多いと思いますが、複数のレイヤーから共通の機能を使用したい場合に、活用できると思います。
サービスへのアクセスは、コンストラクタインジェクションやメソッドインジェクションなどもありますが、実際に開発する機能に応じて、Facadeも合わせて検討したいと思いました。

おすすめ書籍

PHPフレームワークLaravel入門 第2版 PHPフレームワーク Laravel実践開発 PHPフレームワーク Laravel Webアプリケーション開発 バージョン5.5 LTS対応 よくわかるPHPの教科書 【PHP7対応版】

page_footer_responsive




-BackEnd
-,

執筆者:

免責事項

このブログは、記事上部に記載のある投稿日時点の一般的な情報を提供するものであり、投資等の勧誘・法的・税務上の助言を提供するものではありません。仮想通貨の投資・損益計算は複雑であり、個々の取引状況や法律の変更によって異なる可能性があります。ブログに記載された情報は参考程度のものであり、特定の状況に基づいた行動の決定には専門家の助言を求めることをお勧めします。当ブログの情報に基づいた行動に関連して生じた損失やリスクについて、筆者は責任を負いかねます。最新の法律や税務情報を確認し、必要に応じて専門家に相談することをお勧めします。


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

CAPTCHA


関連記事

Go言語

Go 1.16でのgo getとgo installの変更点

1 はじめに2 go getとgo installの役割2.1 go getの役割2.2 go installの役割3 この変更で何が改善されたのか3.1 go:generateと併用する4 その他の ...

aws

Amazon ECSのタスク定義について

1 はじめに1.1 Amazon ECSのタスク定義についておさらい2 タスク定義3 アプリケーションのアーキテクチャ3.1 Fargate起動タイプ3.2 EC2起動タイプ4 タスク定義パラメータ4 ...

[Dialogflow + CF] アクア様が罵倒してくれたり天気を教えてくれるSlackボットを作る

1 はじめに2 Dialogflowの準備2.1 プロジェクトを作る2.2 Intentを作る2.3 試してみる2.4 WELCOME Intentを作る3 Slackボットを作る4 名前を答える5 ...

laravel logo

Laravelの認可機能Gateを使ってみた

1 はじめに2 やる事3 Gate3.1 登録3.2 利用4 Policy5 ミドルウェアでの使用6 さいごに7 おすすめ書籍 はじめに Laravelには認可機能を簡単に実装出来るGateという機能 ...

Go言語

Go言語のエラーハンドリングとログローテーション

1 はじめに2 エラーハンドリング2.1 error インターフェース2.2 pkg/errors パッケージ3 独自のエラータイプ付き errorsパッケージを作成4 log パッケージ4.1 lo ...

フォロー

blog-page_side_responsive

2020年5月
 12
3456789
10111213141516
17181920212223
24252627282930
31  

アプリ情報

私たちは無料アプリもリリースしています、ぜひご覧ください。 下記のアイコンから無料でダウンロードできます。