近日在開發laravel-database-logger 套件的時候,發現設定ServiceProvider defer
屬性設定為true
時,會導致在register
方法中註冊的middleware
無效。本文主要和大家分享Laravel Service Provider 開發時設定延遲載入時遇到的問題決絕辦法,希望能幫助大家。
class ServiceProvider extends \Illuminate\Support\ServiceProvider { protected $defer = true; public function register() { $this->mergeConfigFrom( __DIR__ . '/../config/config.php', 'ibrand.dblogger' ); $this->app->singleton(DbLogger::class, function ($app) { return new DbLogger(); }); //当 $defer 设置为 true 时,在路由中引用 databaselogger middleware 会报错,提示 databaselogger class not found. $this->app[\Illuminate\Routing\Router::class]->middleware('databaselogger', Middleware::class); } public function provides() { return [DbLogger::class]; } }
當問題出現的時候就懷疑是因為設定了defer
屬性設定為true
導致的,立刻就修改原始碼把protected $defer = true;
的程式碼註解掉,結果仍然是提示databaselogger class not found.
,說明Laravel 並沒有註冊此ServiceProvder
#接下來就是想如何解決此問題,嘗試了下面的方法:
1. 驗證本身程式碼是否存在問題
在正常註冊的AppServiceProvider
中註冊自己的ServiceProvider
public function register() { // $this->app->register(\Ibrand\DatabaseLogger\ServiceProvider::class); }
註冊後結果一切正常。
2. 研究原始碼
在config/app.php
providers
註冊無效,但在其他ServiceProvider
中註冊有效,說明是其他問題。
透過研究Illuminate\Foundation\Application
原始碼找到registerConfiguredProviders
方法:
Laravel 是在這個方法中去讀取config/ app.php
中的providers
內容並load
到ProviderRepository
中。
(new ProviderRepository($this, new Filesystem, $this->getCachedServicesPath())) ->load($providers->collapse()->toArray());
重點在$this->getCachedServicesPath()
,透過原始碼發現Laravel 是根據bootstrap/cache/services.php
檔案去決定如何註冊ServiceProvider
。
此時想到了為什麼之前註解了 //protected $defer = true;
程式碼後仍然無效的原因。
所以為了讓註解後的//protected $defer = true;
程式碼有效需要執行
php artisan clear-compiled php artisan optimize
之後問題就解決了,也更加深入理解了ServiceProvider 的原理。
所以切記:如果準備採用延遲載入ServiceProvider
時,嚴禁進行註冊 middleware, route 等系列作業。同時,在變更defer
屬性值後,需要執行php artisan clear-compiled
和php artisan optimize
以更新 ServiceProvider 快取。
3. 為什麼 AppServiceProvider 中註冊有效?
願意很簡單,因為AppServiceProvider
並沒有延遲加載,因此在執行AppServiceProvider
中register
方法去註冊新的ServiceProvider
也是不會延遲載入的。
謹慎使用延遲載入ServiceProvider
更改defer
屬性值後,需要執行php artisan clear-compiled
和php artisan optimize
以更新ServiceProvider 快取。
嚴禁在延遲載入的 ServiceProvider
註冊 middleware
和 route
。
相關推薦:
laravel5建立service provider和facade的方法詳解
laravel5如何建立service provider和facade
以上是Laravel Service Provider 開發時設定延遲載入時遇到的問題決絕辦法的詳細內容。更多資訊請關注PHP中文網其他相關文章!