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 。 ######相關推薦：#########Laravel Service Providers問題############Laravel Service Providers 綁定多個實現，在依賴注入的時候，怎麼確定是實例化的哪一個類別？ ############Laravel Service Provider 開發時設定延遲載入時遇到的問題決絕辦法######

以上是Laravel Service Provider開發設定延遲載入時遇到的問題的詳細內容。更多資訊請關注PHP中文網其他相關文章！