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

Zhuxy 发布于2019-06-28 14:36 / 2910人阅读

摘要：因实际项目需求，近日在开发包的时候，发现设置属性设置为时，会导致在方法中注册的无效。研究源码在中注册无效，但是在其他中注册有效，说明是其他问题。所以切记如果准备采用延迟加载时，严禁进行注册等系列操作。严禁在延迟加载的注册和。

因实际项目需求，近日在开发 laravel-database-logger 包的时候，发现设置 ServiceProvider defer 属性设置为 true 时，会导致在 register 方法中注册的 middleware 无效。

class ServiceProvider extends IlluminateSupportServiceProvider
{
     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[IlluminateRoutingRouter::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(IbrandDatabaseLoggerServiceProvider::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 也是不会延迟加载的。

总结

谨慎使用延迟加载 ServiceProvider

更改 defer 属性值后，需要执行 php artisan clear-compiled 和 php artisan optimize 以更新 ServiceProvider 缓存。

严禁在延迟加载的 ServiceProvider 注册 middleware 和 route 。

讨论交流

混合云 idc机房托管解析jpeg数据时的问题 winform?开发遇到问题支付时常见问题布局遇到的问题

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/26285.html

Laravel核心解读--服务提供器(ServiceProvider)

摘要：调用了的可以看出，所有服务提供器都在配置文件文件的数组中。启动的启动由类负责引导应用的属性中记录的所有服务提供器，就是依次调用这些服务提供器的方法，引导完成后就代表应用正式启动了，可以开始处理请求了。服务提供器是所有 Laravel 应用程序引导中心。你的应用程序自定义的服务、第三方资源包提供的服务以及 Laravel 的所有核心服务都是通过服务提供器进行注册(register)和引...

Richard_Gao 2019-06-28 18:18 评论0 收藏0
Laravel学习笔记之bootstrap源码解析

摘要：总结本文主要学习了启动时做的七步准备工作环境检测配置加载日志配置异常处理注册注册启动。说明：Laravel在把Request通过管道Pipeline送入中间件Middleware和路由Router之前，还做了程序的启动Bootstrap工作，本文主要学习相关源码，看看Laravel启动程序做了哪些具体工作，并将个人的研究心得分享出来，希望对别人有所帮助。Laravel在入口index...

xiaoxiaozi 2019-07-01 12:19 评论0 收藏0
Laravel Kernel引导流程分析

摘要：实例化各服务提供者，根据其属性将服务进行分类延迟服务即时服务，从而得到一个数组格式如，延迟处理注册延迟的服务，以后再进行调用注册延迟的事件即时处理直接进行注册调用等，并重新写入到，然后根据此文件进行相应的处理。 Laravel Kernel引导流程分析代码展示 protected function sendRequestThroughRouter($request) { # ...

yagami 2019-06-27 15:53 评论0 收藏0
一次 Laravel 性能分析全程笔记

摘要：大家都知道项目写起来是挺爽，但是在生产环境性能不高，我们来抽丝剥茧分析我自己项目的运行时间消耗耗时步骤耗时观察初步结论在调用和的方法时，消耗时间是大头。类是用于注册服务提供者的。但此优化在下无效。我们进一步分析。大家都知道 laravel 项目写起来是挺爽，但是在生产环境性能不高，我们来抽丝剥茧分析我自己项目的运行时间消耗： Bootstrap 耗时步骤耗时 Illum...

Cruise_Chan 2019-07-01 12:31 评论0 收藏0
Laravel学习笔记之IoC Container实例化源码解析

摘要：说明本文主要学习容器的实例化过程，主要包括等四个过程。看下的源码如果是数组，抽取别名并且注册到中，上文已经讨论实际上就是的。说明：本文主要学习Laravel容器的实例化过程，主要包括Register Base Bindings, Register Base Service Providers , Register Core Container Aliases and Set the ...

ningwang 2019-07-01 12:18 评论0 收藏0