深入解析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 相关文章推荐
Access数据库导入Mysql的方法之一
Oct 09 PHP
解析php中static,const与define的使用区别
Jun 18 PHP
PHP SPL使用方法和他的威力
Nov 12 PHP
php获取淘宝分类id示例
Jan 16 PHP
实现获取http内容的php函数分享
Feb 16 PHP
php实现建立多层级目录的方法
Jul 19 PHP
从零开始学YII2框架(五)快速生成代码工具 Gii 的使用
Aug 20 PHP
php过滤表单提交的html等危险代码
Nov 03 PHP
PHP类的声明与实例化及构造方法与析构方法详解
Jan 26 PHP
示例详解Laravel的注册重构
Aug 14 PHP
PHP中register_shutdown_function函数的基础介绍与用法详解
Nov 28 PHP
PHP echo()函数讲解
Feb 15 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
Yii中创建自己的Widget实例
2016/01/05 PHP
php_pdo 预处理语句详解
2016/11/21 PHP
有一段有意思的代码-javascript现实多行信息
2007/08/26 Javascript
JavaScript Event学习第三章 早期的事件处理程序
2010/02/07 Javascript
jQuery 美元符冲突的解决方法
2010/03/28 Javascript
jquery.pagination.js 无刷新分页实现步骤分享
2012/05/23 Javascript
瀑布流布局并自动加载实现代码
2013/03/12 Javascript
JavaScript实现数据类型的相互转换
2016/03/06 Javascript
javascript实现根据汉字获取简拼
2016/09/25 Javascript
jQuery+ajax实现局部刷新的两种方法
2017/06/08 jQuery
vue弹窗消息组件的使用方法
2020/09/24 Javascript
深入浅析Vue.js 中的 v-for 列表渲染指令
2018/11/19 Javascript
JavaScript实现邮箱后缀提示功能的示例代码
2018/12/13 Javascript
JavaScript原型对象原理与应用分析
2018/12/27 Javascript
VUE接入腾讯验证码功能(滑块验证)备忘
2019/05/07 Javascript
bootstrap table插件动态加载表头
2019/07/19 Javascript
如何阻止小程序遮罩层下方图层滚动
2019/09/05 Javascript
微信小程序使用 vant Dialog组件的正确方式
2020/02/21 Javascript
JS判断数组是否包含某元素实现方法汇总
2020/06/24 Javascript
Python实现抓取百度搜索结果页的网站标题信息
2015/01/22 Python
在Python程序中操作MySQL的基本方法
2015/07/29 Python
简介二分查找算法与相关的Python实现示例
2015/08/26 Python
Python实现新浪博客备份的方法
2016/04/27 Python
python 列表递归求和、计数、求最大元素的实例
2018/11/28 Python
pandas中的数据去重处理的实现方法
2020/02/10 Python
python实现Oracle查询分组的方法示例
2020/04/30 Python
竞选班长演讲稿
2013/12/30 职场文书
优秀电子工程系毕业生求职信
2014/05/24 职场文书
银行授权委托书样本
2014/10/13 职场文书
个人存款证明书
2014/10/18 职场文书
简单的辞职信范文(2016最新版)
2015/05/12 职场文书
离婚起诉书怎么写
2015/05/19 职场文书
安全守法证明
2015/06/23 职场文书
大学军训心得体会800字
2016/01/11 职场文书
mysql批量新增和存储的方法实例
2021/04/07 MySQL
浅谈Python实现opencv之图片色素的数值运算和逻辑运算
2021/06/23 Python