欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

关于Laravel Service Provider开发设置延迟加载时遇到的问题详解

程序员文章站 2022-09-02 11:51:32
前言 本文主要介绍了关于laravel service provider设置延迟加载时遇到的一些问题,之所有这篇文章,是因实际项目需求,近日在开发 包的时候,发现设置...

前言

本文主要介绍了关于laravel service provider设置延迟加载时遇到的一些问题,之所有这篇文章,是因实际项目需求,近日在开发 包的时候,发现设置 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 。

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。