Laravelサービスプロバイダーの開発中に遅延読み込みを設定するときに発生した問題の解決策

最近、laravel-database-logger パッケージを開発しているときに、ServiceProvider の defer 属性を true に設定すると、register メソッドが実行されることがわかりました。登録された ミドルウェア が無効です。この記事では主に、Laravel Service Provider の開発中に遅延読み込みを設定するときに発生する問題の解決策を紹介します。これが皆さんのお役に立てれば幸いです。 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 中注册有效，说明是其他问题。

通过研究 IlluminateFoundationApplication 源码找到 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 和 routerrreee

   この問題が発生したとき、私は defer 属性を true に設定したことが原因ではないかと考え、すぐにソース コードを変更して protected $defer を設定しました。 = true; コードはコメントアウトされていますが、結果は依然としてプロンプト databaselogger class not found. であり、Laravel がこの ServiceProvder を登録していないことを示しています。次のステップは、この問題を解決する方法です。次の方法を試しました。

1. 独自のコードに問題があるかどうかを確認します

独自の ServiceProvider を通常は AppServiceProvider を登録しました

rrreee

登録後、すべてがうまくいきました。 2. ソース コードを検討します

config/app.php 内の providers の登録は無効ですが、他の ServiceProvider では無効です。 登録が有効な場合は、別の問題があることを意味します。

IlluminateFoundationApplication ソース コードを調べて、registerConfiguredProviders メソッドを見つけます。

Laravel は、このメソッド code>providers の config/app.php を読み取ります。 コンテンツを読み込み、ProviderRepository に load します。

rrreee 焦点は $this->getCachedServicesPath() にあります。ソース コードを通じて、Laravel が bootstrap/cache に基づいて <code>ServiceProvider を登録する方法を決定していることがわかりました。 /services.php ファイル。

このとき、以前にコメントした //protected $defer = true; コードが依然として無効である理由を考えました。

そのため、コメントされた //protected $defer = true; コードを有効にするためには、それを実行する必要があります

rrreee🎜 その後、問題は解決され、ServiceProvider の原理はさらに改善されました。深く理解しました。 🎜

覚えておいてください: 遅延読み込み ServiceProvider を使用する予定がある場合、ミドルウェア、ルート、およびその他の一連の操作を登録することは固く禁じられています。同時に、defer 属性値を変更した後、phpArtisanClear-compiledとphpArtisanOptimizeを実行してServiceProviderを更新する必要があります。キャッシュ。

🎜3. AppServiceProvider への登録が有効なのはなぜですか? 🎜🎜これは非常に簡単です。AppServiceProvider は読み込みを遅延させないため、AppServiceProvider の register メソッドが実行されて、新しい ServiceProvider も遅延ロードされません。 🎜

概要

1. 🎜遅延読み込みは注意して使用してください ServiceProvider🎜🎜
2. 🎜変更 defer 属性値の後に、<code>phpArtisanClear-compiledとphpArtisanOptimizeを実行してServiceProviderキャッシュを更新する必要があります。 🎜🎜
3. 🎜遅延ロードされる ServiceProvider に middleware と route を登録することは固く禁止されています。 🎜🎜🎜🎜関連する推奨事項: 🎜🎜🎜🎜laravel5のサービスプロバイダーとファサードの作成方法の詳細な説明🎜🎜🎜🎜Laravelサービスプロバイダーの問題🎜🎜🎜🎜laravel5がサービスプロバイダーとファサードを作成する方法🎜🎜🎜🎜 🎜

以上がLaravelサービスプロバイダーの開発中に遅延読み込みを設定するときに発生した問題の解決策の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。