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対応版】

blog-page_footer_336




blog-page_footer_336




-BackEnd
-,

執筆者:


comment

メールアドレスが公開されることはありません。

CAPTCHA


関連記事

Pythonで書かれたスクレイピングのコードをRubyで書いてみる

1 はじめに2 仕様3 ソースコード4 使用したモジュール、Gem5 対象ページを取得6 XPATHから目的のものを抜き出す7 次のページのリンクを取得する8 さいごに はじめに 以前、技術評論社さん ...

laravel logo

Laravelで画像アップロード実装が楽になるかもしれないlaravel-imageup

1 はじめに2 環境3 導入4 実装5 個人的にハマったこと5.1 配列はダメ5.2 PHPStanで引っかかる6 さいごに7 おすすめ書籍 はじめに こんにちは。webアプリケーションを作る際にファ ...

laravel logo

LaravelのArtisanコマンドを自作する

1 はじめに2 コマンドの作成方法3 コマンドの実装3.1 文字列出力3.2 引数3.3 オプション3.4 入力を使用した対話型3.4.1 ask()メソッド3.4.2 secret()メソッド3.4 ...

rails

RailsでERBからJavaScriptにhashを渡す方法

1 はじめに2 カスタムデータ属性とは3 実装例3.1 コントローラの実装3.2 ビューの実装3.3 実行結果4 さいごに はじめに 以前、選択したプルダウンメニューに応じて別のプルダウンメニューの内 ...

laravel logo

Laravelでテストコードを書くには? Featureテスト/Unitテスト

1 はじめに2 FeatureとUnitの使い分け3 テスト用データベースの準備4 Featureテスト4.1 テスト対象のコード4.2 テストコードの実装4.3 テスト結果の検証4.3.1 ステータ ...

フォロー

blog-page_side_responsive

2020年5月
 12
3456789
10111213141516
17181920212223
24252627282930
31  

アプリ情報

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