Laravel容器延遲載入以及Auth擴充套件詳解

codeceo發表於2015-03-03

昨天按照手冊教程,動手寫一個Auth擴充套件,按照包獨立性的原則,我不希望將Auth::extend()這種方法寫在 start.php 中,毫無疑問,我選擇了在服務提供器register()方法中註冊擴充套件驅動。然而,事與願違……

發現問題

當我在 LoauthServiceProvider 中這樣寫的時候:

public function register()
{
    //
    \Auth::extend('loauth',function($app){});
}

報錯

Call to undefined method Illuminate\Support\Facades\Auth::extend()

尋找原因

當時就納悶了,找原因,懷疑是Auth沒註冊?檢查發現註冊了,因為在路由中可以使用;php artisan clear-compiled 沒用;百思不得其解,甚至懷疑是我不小心修改了核心類,還重新下載了一次laravel包,問題依舊。

折騰了一晚上,最終我把目光鎖定在 AuthServiceProvider 的 $defer 屬性。

根據手冊以及註釋,我們得知 $defer 屬性是用來延遲載入該服務提供器,說直白點就是延遲執行 register() 方法,只需要配合provides()方法即可實現。舉個例子:

public function provides()
{
    return array('auth');
}

這個是 AuthServiceProvider 裡的方法,當框架初始化的時候,會依次載入服務提供器,如果發現這個服務提供器protected $defer=true 那麼就會呼叫它的 provides() 方法,其返回的陣列包含需要延遲載入的服務名稱,這樣當我們在路由、控制器或者其他地方呼叫 Auth::METHOD() 的時候,才會去呼叫提供器的 register() 方法。

確定癥結

那麼問題來了,既然是被動延遲載入,也就是說當我呼叫Auth類方法時應該會自動例項化Auth類啊,為什麼我在LoauthServiceProvider中呼叫的時候卻提示方法不存在,但是在路由中卻可以呢。

我猜測是因為優先順序的問題,可能在框架註冊 LoauthServiceProvider::register() 的時候,Auth 還沒有標記為延遲載入,這就造成了一個先後問題,任何即時載入的服務提供器都無法在register方法中呼叫延遲載入的服務。

經過研究,順利在核心程式碼中找到證據 Illuminate\Foundation\ProviderRepository

public function load(Application $app, array $providers)
{
    //...省略
    // We will go ahead and register all of the eagerly loaded providers with the
    // application so their services can be registered with the application as
    // a provided service. Then we will set the deferred service list on it.
    foreach ($manifest['eager'] as $provider)
    {
        $app->register($this->createProvider($app, $provider));
    }
    //延遲載入標記在即時載入服務之後
    $app->setDeferredServices($manifest['deferred']);
}

解決之道

雖然發現了問題所在,但並不代表問題就解決了,修改核心程式碼不是個明智的選擇,所以只能在我們自己的包裡想辦法咯,一個解決方案如下:

public function register()
{
    //
    $authProvider = new \Illuminate\Auth\AuthServiceProvider($this->app);
    $authProvider->register();
    \Auth::extend('loauth',function($app){});
}

既然auth還未註冊,那麼我們手動呼叫它的register方法幫它註冊。

相關文章