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新手常见的一些不好习惯(抄的 有待理解)
- How to make a not-so-boring speech?
- .NET web开发之WebApi初试水
- ibatis动态多条件查询及模糊查询(oracle,mysql,sql)
- [剑指OFFER] 斐波那契数列- 跳台阶 变态跳台阶 矩形覆盖
- windows下搭建及配置mantis缺陷管理工具
- .Net程序员学用Oracle系列(9):系统函数(上)
- .Net Core Session使用
- Linux如何让进程在后台运行的三种方法详解
- java环境搭建 windows
- Postman 使用详解
- JS学习笔记Day17
- JAVA Scanner的简单运用
- 【转】js程序中美元符号$是什么
- 川普和习G-20会面为缓和中美贸易战提供了很大的机会
- 人工智能-调百度AI接口+图灵机器人
- XML文档的生成和解析操作方法
- ELM:ELM实现鸢尾花种类测试集预测识别正确率(better)结果对比—Jason niu
- 第30节:Java基础-内部类
- protobuf中的编码规则