關於Laravel Service Provider開發設定消極式載入時遇到的問題詳解

這篇文章主要給大家介紹了關於Laravel Service Provider開發設定消極式載入時遇到的問題，文中通過範例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起看看吧。

前言

本文主要介紹了關於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 也是不會消極式載入的。

總結

謹慎使用消極式載入 ServiceProvider

更改 defer 屬性值後，需要執行 php artisan clear-compiled 和 php artisan optimize 以更新 ServiceProvider 緩衝。

嚴禁在消極式載入的 ServiceProvider 註冊 middleware 和 route 。

您可能感興趣的文章:

PHP實現排序堆排序演算法

PHP簡單選擇排序演算法學習

跳一跳php代碼實現詳解