Laravel Service Provider 開發時設置延遲加載時遇到的問題

因實際項目需求，近日在開發 laravel-database-logger 包的時候，發現設置 ServiceProvider defer 屬性設置爲 true 時，會致使在register 方法中註冊的 middleware 無效。

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 也是不會延遲加載的。

總結

1. 謹慎使用延遲加載 ServiceProvider
2. 更改 defer 屬性值後，須要執行 php artisan clear-compiled 和 php artisan optimize 以更新 ServiceProvider 緩存。
3. 嚴禁在延遲加載的 ServiceProvider 註冊 middleware 和 route 。