深入解析Laravel5.5中的包自动发现Package Auto Discovery


Posted in PHP onSeptember 13, 2017

前言

在之前的 Laravel 版本中,安装包通常需要几个步骤,例如添加服务提供器到 app 配置文件并注册相关的 facades。现在,从 Laravel 5.5 开始,Laravel 可以自动检测并注册服务提供器和 facades。

本文不是聚焦于他是怎么用的,而是看看它的源码,是怎么实现Package Auto Discovery的。

composer.json

一切的起源都是来自 composer.json ,在使用 composer 的时候,你可以在 post-autoload-dump 部分指定你想执行的脚本,比如在 Laravel 5.5 的时候,我们可以看到这样的定义:

"scripts": { 
 "post-autoload-dump": [  
  "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",  
  "@php artisan package:discover"
 ]
}

对于 postAutoloadDump 是很熟悉了,Laravel 之前的版本基本都有,它的工作是清理一些缓存,删除一些旧的文件。

我们的关注重点是@php artisan package:discover ,也就是会执行@php artisan package:discover 这个命令。

这个命令是干嘛的呢?它其实是位于Illuminate\Foundation\Console\PackageDiscoverCommand 中,主要是通过执行Illuminate\Foundation\PackageManifest 的 build() 方法来达到 发现 package 的目的。

而 PackageManifest 早就注册在 Laravel 的 Container 中,那么它可以保证每次在启动 Laravel 的时候都能使用 PackageManifest 的 build() 方法,这个 build() 方法主要的逻辑就是:

找寻 vendor/composer/installed.json 这个文件,这个文件是 composer 自己生成的,记录着每一次的 composer autoload 的 class map。

而此时,Laravel 又将这些内容映射到 extra.laravel 的部分,比如:

"extra": { 
 "laravel": {  
  "providers": [   
  "Barryvdh\\Debugbar\\ServiceProvider"
  ],  
 "aliases": {   
  "Debugbar": "Barryvdh\\Debugbar\\Facade"
  }
 }
}

Laravel 首先将以上内容直接读取下来放到一个 collection 中,然后在去检查下面这个部分的定义,在决定是否需要执行 Package Discover 动作:

"extra": { 
 "laravel": {  
  "dont-discover": [   
  "barryvdh/laravel-debugbar"
  ]
 }
}

如果你不想执行 @php artisan package:discover 的发现效果,可以直接在 dont-discover 的数组里面填上 *。

这样判断完成之后,Laravel 将 collection 中需要发现的 Package 内容保存到一个缓存文件中bootstrap/cache/packages.php:

<?php return array (
 'barryvdh/laravel-debugbar' => array (
 'providers' => array (
  0 => 'Barryvdh\\Debugbar\\ServiceProvider',
 ),
 'aliases' => array (
  'Debugbar' => 'Barryvdh\\Debugbar\\Facade',
 ),
 ),
);

Laravel 怎么拿到 Package 信息?

这个时候,我们又需要看看 Laravel 项目启动的时候,主要启动下面的两个服务:

  • \Illuminate\Foundation\Bootstrap\RegisterFacades
  • \Illuminate\Foundation\Bootstrap\RegisterProvider

而 上面的第一个服务会使用 Illuminate\Foundation\AliasLoader 加载所有的 alias ,在 AliasLoader 中:

// in RegisterFacades::bootstrap()

AliasLoader::getInstance(array_merge(
 $app->make('config')->get('app.aliases', []),
 $app->make(PackageManifest::class)->aliases()
))->register();

你可以看到,它首先读取 app.php 的 aliases 数组,然后与 bootstrap/cache/packages.php 的 packages 数组合并,这个时候,就可以获取到所有的 packages 信息进行发现和自带加载了。这样合并的好处就是,你还是可以直接在 app.php中定义你的 alias 来覆盖自动发现的 package,从而保证你的项目还是可以运行得很流畅。

总结

本文将 Laravel 5.5 Package Auto Discovery 原理和源码梳理的一遍,希望对你了解 Laravel 5.5 Package Auto Discovery 有所帮助。

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

PHP 相关文章推荐
如何获得PHP相关资料
Oct 09 PHP
php URL编码解码函数代码
Mar 10 PHP
snoopy 强大的PHP采集类使用实例代码
Dec 09 PHP
有关PHP中MVC的开发经验分享
May 17 PHP
php全局变量和类配合使用深刻理解
Jun 05 PHP
php根据操作系统转换文件名大小写的方法
Feb 24 PHP
页面利用渐进式JPEG来提升用户体验度
Dec 01 PHP
PHP解压tar.gz格式文件的方法
Feb 14 PHP
详解PHP的Yii框架中扩展的安装与使用
Apr 01 PHP
PHP命名空间namespace用法实例分析
Sep 27 PHP
详细解读php的命名空间(二)
Feb 21 PHP
PHP中使用mpdf 导出PDF文件的实现方法
Oct 22 PHP
PHP 实现公历日期与农历日期的互转换
Sep 13 #PHP
php生成条形码的图片的实例详解
Sep 13 #PHP
php之可变函数的实例详解
Sep 13 #PHP
PHP实现一个多功能购物网站的案例
Sep 13 #PHP
php之可变变量的实例详解
Sep 12 #PHP
PHP清除缓存的几种方法总结
Sep 12 #PHP
PHP 传输会话curl函数的实例详解
Sep 12 #PHP
You might like
利用ThinkPHP内置的ThinkAjax实现异步传输技术的实现方法
2011/12/19 PHP
thinkPHP下ueditor的使用方法详解
2015/12/26 PHP
PDO操作MySQL的基础教程(推荐)
2017/08/18 PHP
七种PHP开发环境搭建工具
2020/06/28 PHP
PHP基于ip2long实现IP转换整形
2020/12/11 PHP
利用了jquery的ajax实现二级联互动菜单
2013/12/02 Javascript
javascript移出节点removeChild()使用介绍
2014/04/03 Javascript
用js模拟struts2的多action调用示例
2014/05/19 Javascript
JSON.parse()和JSON.stringify()使用介绍
2014/06/20 Javascript
上传文件返回的json数据会被提示下载问题解决方案
2014/12/03 Javascript
JavaScript中的函数嵌套使用
2015/06/04 Javascript
Bootstrap按钮组件详解
2016/04/26 Javascript
深入剖析JavaScript面向对象编程
2016/07/12 Javascript
基于jQuery实现多标签页切换的效果(web前端开发)
2016/07/24 Javascript
js浏览器滚动条卷去的高度scrolltop(实例讲解)
2017/07/07 Javascript
微信小程序“摇一摇”的实例代码
2017/07/20 Javascript
vue获取当前点击的元素并传值的实例
2018/03/09 Javascript
Angularjs中date过滤器失效的问题及解决方法
2018/07/06 Javascript
Vue组件的使用及个人理解与介绍
2019/02/09 Javascript
Vue动态组件与异步组件实例详解
2019/02/23 Javascript
Vue 无限滚动加载指令实现方法
2019/05/28 Javascript
微信小程序开发打开另一个小程序的实现方法
2020/05/17 Javascript
微信小程序语音同步智能识别的实现案例代码解析
2020/05/29 Javascript
[02:39]我与DAC之Newbee.Moogy:从论坛到TI
2018/03/26 DOTA
python difflib模块示例讲解
2017/09/13 Python
Python实现破解猜数游戏算法示例
2017/09/25 Python
python设置值及NaN值处理方法
2018/07/03 Python
opencv python 基于KNN的手写体识别的实例
2018/08/03 Python
Pytorch 多块GPU的使用详解
2019/12/31 Python
关于python 跨域处理方式详解
2020/03/28 Python
python 弧度与角度互转实例
2020/04/15 Python
Python3 selenium 实现QQ群接龙自动化功能
2020/04/17 Python
创建文明学校实施方案
2014/03/11 职场文书
房产协议书范本
2014/10/18 职场文书
家庭财产分割协议范文
2014/11/24 职场文书
导游词之张家口
2019/12/13 职场文书