深入解析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
我的群发邮件程序
Oct 09 PHP
Uchome1.2 1.5 代码学习 common.php
Apr 24 PHP
使用PHP实现密保卡功能实现代码&amp;lt;打包下载直接运行&amp;gt;
Oct 09 PHP
ThinkPHP3.1新特性之动态设置自动完成及自动验证示例代码
Jun 23 PHP
2个比较经典的PHP加密解密函数分享
Jul 01 PHP
作为程序员必知的16个最佳PHP库
Dec 09 PHP
Symfony2创建页面实例详解
Mar 18 PHP
Yii2实现上下联动下拉框功能的方法
Aug 10 PHP
ThinkPHP 整合Bootstrap Ajax分页样式
Dec 23 PHP
Yii框架分页技术实例分析
Aug 30 PHP
php变量与字符串的增删改查操作示例
May 07 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
加强版phplib的DB类
2008/03/31 PHP
php miniBB中文乱码问题解决方法
2008/11/25 PHP
一个不易被发现的PHP后门代码解析
2014/07/05 PHP
利用php输出不同的心形图案
2016/04/22 PHP
PHP实现的贪婪算法实例
2017/10/17 PHP
扩展String功能方法
2006/09/22 Javascript
Javascript和Ajax中文乱码吐血版解决方案
2009/12/21 Javascript
IE8中使用javascript动态加载CSS的解决方法
2014/06/17 Javascript
使用JavaScript刷新网页的方法
2015/06/04 Javascript
AngularJS中过滤器的使用与自定义实例代码
2016/09/17 Javascript
vue.js异步上传文件前后端实现代码
2017/08/22 Javascript
vue移动端轻量级的轮播组件实现代码
2018/07/12 Javascript
vue 对象添加或删除成员时无法实时更新的解决方法
2019/05/01 Javascript
js实现自动播放匀速轮播图
2020/02/06 Javascript
详解javascript void(0)
2020/07/13 Javascript
Javascript如何实现扩充基本类型
2020/08/26 Javascript
Vue中ref和$refs的介绍以及使用方法示例
2021/01/11 Vue.js
[01:06]DOTA2小知识课堂 Ep.02 吹风竟可解梦境缠绕
2019/12/05 DOTA
11个并不被常用但对开发非常有帮助的Python库
2015/03/31 Python
python通过ssh-powershell监控windows的方法
2015/06/02 Python
点球小游戏python脚本
2018/05/22 Python
Python单元和文档测试实例详解
2019/04/11 Python
python爬虫实例之获取动漫截图
2020/05/31 Python
Python+OpenCV图像处理——打印图片属性、设置存储路径、调用摄像头
2020/10/22 Python
matplotlib bar()实现百分比堆积柱状图
2021/02/24 Python
使用HTML5 Canvas API绘制弧线的教程
2016/03/22 HTML / CSS
导出HTML5 Canvas图片并上传服务器功能
2019/08/16 HTML / CSS
香港个人化生活购物网站:Ballyhoo Limited
2016/09/10 全球购物
ParcelABC西班牙:包裹运送和快递服务
2019/12/24 全球购物
德国消费电子产品购物网站:Guter Kauf
2020/09/15 全球购物
阿迪达斯越南官网:adidas越南
2020/07/19 全球购物
什么是makefile? 如何编写makefile?
2012/08/08 面试题
中层干部岗位职责
2013/12/18 职场文书
贵阳市党的群众路线教育实践活动党(工)委领导班子整改方案
2014/10/26 职场文书
2014年政务公开工作总结
2014/12/09 职场文书
Netty结合Protobuf进行编解码的方法
2021/06/26 Java/Android