如何使用 Laravel Facades ?

Facade 布局是在面向對象編程中經常使用的一種軟件設計布局方式。Facade 實際上是一種包括復雜函數庫的類,提供了更加簡潔易讀的接口。Facade 布局還能為一組結構復雜、設計簡陋的 API 提供統一、設計周到的 API。

如何使用 Laravel Facades ?

Laravel 框架與該布局的特點相似,也稱為 Facades。在本教程中,我們會學習如何在其他框架應用 Laravel 的 “Facades”。在繼續學習之前,讓我們簡單了解一下 Ioc 容器

首先,我們了解 Laravel 的 facades 內部工作結構。之后再討論如何將之改造并用于其他環境。

Laravel 中的 Facades

Laravel facade 是一種為容器內部服務提供類似靜態接口的類。據其文檔描述,Facades 是可觸及容器服務底層實現方式的代理。

不過,在 PHP 社區,有關其名稱的爭論一直不斷。一些人堅持修改此名稱以避免開發者的困惑,因為其并未完全實現 Facade 布局。如果你也受此名稱困擾,大可以為其取個別名。但是,請注意,下文將會用到的 Laravel 框架基類(base class)將會稱為 Facade。

How Facades Are implemented in Laravel

Facades 在 Laravel 中如何實現

你可能也知道,容器內的每個服務都有個唯一名稱。在 laravel 應用中,可使用 App::make() 方法或 app() 輔助函數從容器中直接獲取服務。

<?php

App::make('some_service')->methodName();

前面已經提過,Laravel 使用 facade 類的好處是讓開發者使用服務時更加便捷。使用 facade 類之后,下面的代碼就能達到相同的效果:

// ...
someService::methodName();
// ...

在 Laravel 中,所有服務都包含一個 facade 類。這些 facade 類繼承自 Illuminate/Support 包中的 Facade 基類。它們只需實現 getFacadeAccessor 方法即可,后者會返回容器內的服務名。

在上面的示例中,someService 代表 facade 類。methodName 其實是容器內原服務的一個方法。如果跳出 Laravel 的語境查看上面的示例,則表示一個名為 someService 的類引出名為 methodName() 的靜態方法。但 Laravel 并不是這樣實現接口的。在下一節,我們將介紹 Laravel 的 Facade 基類在幕后的運作方式。

Base Facade

Facade 類包含一個名為 $app 的私有屬性,其值為服務容器的引用。如果要在 Laravel 之外使用 facades,必須使容器明確使用 setFacadeApplication() 方法。

在 facade 基類內部,__callStatic 魔術方法用于處理實際并不存在的靜態方法的調用。如果調用 Laravel facade 類的靜態方法, __callStatic 方法便會激活,因為 facade 類并未實現該方法。因此,__callStatic 會從容器獲取各自的服務,進而調用之。

以下是 facade 基類中 __callStatic 方法的實現方式:

<?php
// ...
/**
     * Handle dynamic, static calls to the object.
     *
     * @param  string  $method
     * @param  array   $args
     * @return mixed
     */
    public static function __callStatic($method, $args)
    {
        $instance = static::getFacadeRoot();

        switch (count($args)) {
            case 0:
                return $instance->$method();

            case 1:
                return $instance->$method($args[0]);

            case 2:
                return $instance->$method($args[0], $args[1]);

            case 3:
                return $instance->$method($args[0], $args[1], $args[2]);

            case 4:
                return $instance->$method($args[0], $args[1], $args[2], $args[3]);

            default:
                return call_user_func_array([$instance, $method], $args);
        }
    }

在上面的方法中,getFacadeRoot() 會從容器獲取服務。

Facade 類解析

每個 facade 類均繼承自基類。我們只需實現 getFacadeAccessor() 方法,該方法用于返回容器中的服務名。

<?php namespace App\Facades;

use Illuminate\Support\Facades\Facade as BaseFacade;

class SomeServiceFacade extends BaseFacade {

    /**
     * Get the registered name of the component.
     *
     * @return string
     */
    protected static function getFacadeAccessor() { return 'some.service'; }

}

別名

由于 Laravel facades 是 PHP 類,在使用之前我們得導入它們。PHP 支持命名空間與自動導入,因此只要調用全限定名,即可自動載入這些類。PHP 還支持使用 use 指令給類取別名:

use App\Facades\SomeServiceFacade

SomeServiceFacade:SomeMethod();

然而,在需要某個特定的 facade 類時,我們必須在每個腳本文件都寫一遍上面的代碼。Laravel 在處理 facade 別名時有其獨特的方法——別名載入器(alias loader)。

Laravel 如何給 Facades 加別名

所有的別名都保存在 app.php 配置文件的 aliases 數組中,該文件保存在 /config 目錄下。

查看該數組,會發現每個別名都與一個全限定類名對應。這意味著我們可以給 facade 類選定任意的名字。

// ..
'aliases' => [
    // ...
    'FancyName' => 'App\Facades\SomeServiceFacade',
],

現在,讓我們看看 Laravel 如何使用該數組給 facade 類取別名。在引導階段,Laravel 會使用來自 Illuminate\Foundation 包的 AliasLoader 服務。AliasLoader 以該別名數組為參數,遍歷其所有元素,使用 PHP 的 spl_autoload_register 創建一個 __autoload 函數隊列。各個 __autoload 函數會用 PHP 的 class_alias 函數為各個 facade 類創建別名。

因此,我們無需像使用 use 指令時那樣在使用類前導入之并為其創建別名。當我們試圖使用一個不存在的類時,PHP 會檢查 __autoload 隊列以得到合適的 autoloader。這時,AliasLoader 已經記下所有的 __autoload 函數。各個 autoloader 會選定一個類名并根據別名數組推導出對應的初始類名。最后,它會為其創建別名。請參考下面的方法調用:

<?php

// FancyName is resolved to App\Facades\SomeServiceFacade according to the aliases array

FancyName::someMethod()

在幕后,FancyName 會對應至 App\Facades\SomeServiceFacade

在其他框架使用 Facades

現在,我們已經了解 Laravel 如何處理 facades 與別名,我們可以將 Laravel 的 facade 方法運用到其他環境中。接下來,我們會在 Silex 框架使用 facades。然而,只要遵循同樣的理念,你也可以將之用在別的框架。

Silex 擁有繼承自 Pimple 的容器。使用 $app 對象即可調用容器內的服務:

<?php
$app['some.service']->someMethod()

有了 facade 類,我們可以為 Silex 服務提供一個類似靜態的接口。此外,我們也可以使用 AliasLoader 服務為這些 facades 創建有意義的別名。因此,我們可以重組上面的代碼:

<?php
SomeService::someMethod();

必備條件

為了使用 facade 基類,我們要使用 composer 指令安裝 Illuminate\Support 包:

composer require illuminate\support

此包還包含其他服務。但目前我們只需要 facade 基類。

創建 Facades

只需繼承 Facade 基類并實現 getFacadeAccessor 方法,即可為服務創建 facade。

在本文中,所有 facades 都會保存在 src/Facades 路徑下。例如:名為 some.service 的服務,其 facade 類如下:

<?php
namespace App\Facades

use Illuminate\Support\Facades\Facade;

class SomeServiceFacade extends Facade {

    /**
     * Get the registered name of the component.
     *
     * @return string
     */
    protected static function getFacadeAccessor() { return 'some.service'; }

}

請注意,此類位于 app\facades 命名空間下。

現在只剩下設定 facade 類的應用容器。如前所述,在靜態語境下調用 facade 類的方法,會觸發 __callStatic 方法。該方法會用 getFacadeAccessor() 返回的數據識別容器內的服務,并試圖獲取之。在 Laravel 之外使用 facade 基類時,容器對象并不是自動設定的,需要手動設定。

為此,使用 facade 基類的 setFacadeApplication 方法,可以設定 facade 類的應用容器。

app.php 文件,添加以下代碼:

<?php
Illumiante\Support\Facade::setFacadeApplication($app);

這會給繼承自 facade 基類的所有 facades 設定容器。

現在,無需直接從容器獲取服務,我們可以使用剛剛創建的 facade 類來獲取,該類還允許我們調用靜態語境下的所有方法。

實現別名

為了給 facade 類創建別名,我們將使用之前介紹過的 AliasLoaderAliasLoader 類由 illuminate\foundation 包提供,可以下載整個包,也可以拷貝部分代碼保持為文件。

如果你想拷貝源文件,建議將其保存在 src/Facades 目錄下。你可以根據項目的結構為 AliasLoader 類創建命名空間。

在本例中,我們將拷貝代碼并將其保存在 app/facades 命名空間下。

創建別名數組

config 目錄下創建 aliases.php 文件,并填入 alias-facade 綁定:

<?php
return [
    'FancyName' => 'App\Facades\SomeService',
];

FancyName 是我們給 App\Facades\SomeService 建立的別名。

注冊別名

AliasLoader 是一種單例服務。要創建或得到別名載入器(alias loader)的實例,需調用 getInstance 方法并以別名數組為參數。最后,為了注冊這些別名,需調用其 register 方法。

再次打開 app.php 文件,加入以下代碼:

<?php

// ...

$aliases = require __DIR__ . '/../../config/aliases.php';
App\Facades\AliasLoader::getInstance($aliases)->register();

現在,大功告成了!我們可以這樣使用該服務:

<?php
FancyName::methodName();

進行包裝

一個 Facade 類只需實現 getFacadeAccessor 方法即可,后者會返回容器內的服務名。若要在 Laravel 環境外使用 facade,必須使用 setFacadeApplication() 方法明確設定服務容器。

要引用 facade 類,我們可以使用全限定類名或使用 PHP 的 use 指令導入之。或者,遵循 Laravel 給 facades 創建別名的方法,使用 alias loader。

原文鏈接:http://www.sitepoint.com/how-laravel-facades-work-and-how-to-use-them-elsewhere/ (作者:Reza Lavaryan)本文系 OneAPM 工程師編譯整理。

OneAPM for PHP 能夠深入到所有 PHP 應用內部完成應用性能管理 能夠深入到所有 PHP 應用內部完成應用性能管理和監控,包括代碼級別性能問題的可見性、性能瓶頸的快速識別與追溯、真實用戶體驗監控、服務器監控和端到端的應用性能管理。想閱讀更多技術文章,請訪問 OneAPM 官方技術博客

本文轉自 OneAPM 官方博客

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,197評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,415評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,104評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,884評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,647評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,130評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,208評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,366評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,887評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,737評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,939評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,478評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,174評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,586評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,827評論 1 283
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,608評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,914評論 2 372

推薦閱讀更多精彩內容