深入解析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 mysql_query执行超时(Fatal error: Maximum execution time …)
Jul 03 PHP
PHP实现货币换算的方法
Nov 29 PHP
PHP答题类应用接口实例
Feb 09 PHP
开启PHP的伪静态模式
Dec 31 PHP
Yii2使用$this-&gt;context获取当前的Module、Controller(控制器)、Action等
Mar 29 PHP
yii2使用gridView实现下拉列表筛选数据
Apr 10 PHP
Thinkphp开发--集成极光推送
Sep 15 PHP
php 数据结构之链表队列
Oct 17 PHP
PHP中Static(静态)关键字功能与用法实例分析
Apr 05 PHP
php中目录操作opendir()、readdir()及scandir()用法示例
Jun 08 PHP
关于Yii2框架跑脚本时内存泄漏问题的分析与解决
Dec 01 PHP
基于PHP实现解密或加密Cloudflar邮箱保护
Jun 24 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
php页面缓存ob系列函数介绍
2012/10/18 PHP
PHP+Mysql+jQuery查询和列表框选择操作实例讲解
2015/10/22 PHP
PHP实现的分页类定义与用法示例
2017/07/05 PHP
JavaScript事件列表解说
2006/12/22 Javascript
ajaxControlToolkit AutoCompleteExtender的用法
2008/10/30 Javascript
Javascript 八进制转义字符(8进制)
2011/04/08 Javascript
javascript分页代码实例分享(js分页)
2013/12/13 Javascript
我的Node.js学习之路(二)NPM模块管理
2014/07/06 Javascript
jQuery遍历json中多个map的方法
2015/02/12 Javascript
js淡入淡出的图片轮播效果代码分享
2015/08/24 Javascript
Jquery实现纵向横向菜单
2016/01/24 Javascript
JQuery和HTML5 Canvas实现弹幕效果
2017/01/04 Javascript
详解JavaScript中return的用法
2017/05/08 Javascript
Vue页面骨架屏注入方法
2018/05/13 Javascript
npm 常用命令详解(小结)
2019/01/17 Javascript
vue.js高德地图实现热点图代码实例
2019/04/18 Javascript
vue3 源码解读之 time slicing的使用方法
2019/10/31 Javascript
加速vue组件渲染之性能优化
2020/04/09 Javascript
[36:17]DOTA2上海特级锦标赛 - VGL音乐会全集
2016/03/06 DOTA
python基础教程之实现石头剪刀布游戏示例
2014/02/11 Python
python3.5仿微软计算器程序
2020/03/30 Python
Python通过OpenCV的findContours获取轮廓并切割实例
2018/01/05 Python
怎么使用pipenv管理你的python项目
2018/03/12 Python
浅谈python写入大量文件的问题
2018/11/09 Python
Python 元组操作总结
2019/09/18 Python
Django实现任意文件上传(最简单的方法)
2020/06/03 Python
python画图时设置分辨率和画布大小的实现(plt.figure())
2021/01/08 Python
html5中audio支持音频格式的解决方法
2018/08/24 HTML / CSS
凯撒娱乐:Caesars Entertainment
2018/02/23 全球购物
lookfantastic荷兰:在线购买奢华护肤、护发和化妆品
2018/11/27 全球购物
初中三好学生自我鉴定
2014/04/07 职场文书
商务日语专业自荐信
2014/04/17 职场文书
廉政教育的心得体会
2014/09/01 职场文书
北京故宫导游词
2015/01/31 职场文书
毕业生对母校寄语
2015/02/26 职场文书
2016党员发展对象培训心得体会
2016/01/08 职场文书