composer的原理和使用（上）--phar的相关

2018-10-21 本文已影响0人橙知

简书markdown不支持目录.png

什么是composer

在之前的PHP开发中，我也仅仅是使用composer来进行依赖的管理，没有深度去理解到底什么是composer，今天有时间就开始深入的研究一下。

Composer 不是一个包管理器。是的，它涉及 "packages" 和 "libraries"，但它在每个项目的基础上进行管理，在你项目的某个目录中（例如 vendor）进行安装。默认情况下它不会在全局安装任何东西。因此，这仅仅是一个依赖管理。 --来自composer的官方文档

其实上面的文案在一开始接触composer的时候我是能明白他说什么的，但是今天仔细分析又发现对其中的很多表述还是比较模糊。首先是包管理器的理解。

包管理器又称软件包管理系统，它是在电脑中自动安装、配制、卸载和升级软件包的工具组合，在各种系统软件和应用软件的安装管理中均有广泛应用。 --百度百科

软件包(SoftWare Package)是指具有特定的功能，用来完成特定任务的一个程序或一组程序。可分为应用软件包和系统软件包两大类。应用软件包与特定的应用领域有关，又可分为通用包及专用包两类。通用软件包根据社会的一些共同需求开发，专用软件包则是生产者根据用户的具体需求定制的，可以为适合其特殊需要进行修改或变更

通过软件包管理器能理解，包管理器更多的管理的能直接执行的应用程序，像rpm，apt，brew，yum都是指定的类Unix系统的包管理器。而对于PHP脚本语言，在开发者编写的脚本一般依赖的是各种库的脚本。所以在composer定义中先说明composer不是一个包管理器。

终于后面它涉及 "packages" 和 "libraries" ，我一直想接着查询 "packages" 和 "libraries"区别，但是没有找到相关描述。但是定义最后一句明确说明了，他是一个依赖管理工具。

phar 文件

在我们下载composer的时候都可以看到是下载一个composer.phar 文件。那么phar 文件是什么类型的文件，他和PHP的关系是什么？所以要深入了解composer应该先从phar开始

phar打包PHP程序

PHAR (“Php ARchive”) 是PHP里类似于JAR的一种打包文件。如果你使用的是 PHP 5.3 或更高版本，那么Phar后缀文件是默认开启支持的，你不需要任何其他的安装就可以使用它。phar归档文件有三种格式：tar归档、zip归档、phar归档，前两种执行需要php安装Phar 扩展支持，用的也比较少，这里主要讲phar归档格式。

我们为什么需要phar呢，是因为PHP的脚本语言的特性，如果你开发的一个项目担心在部署的时候被修改，那么可以通过将项目中的多个文件打包成一个文件，并且这个文件默认是只读的方式。这样就可以封装上线了。
简单的理解一下：项目文件的打包可以通过zip，tar，只不过phar打包后的文件不需要显示的再解压，可以直接被PHP使用。

Rather than using the ZIP file format the simpler tar format was used, and the first PHAR was created using the tar command line utility[1] as a proof of concept. On June 14, 2004[2] the initial PHP_Archive package was proposed to PEAR and on December 13, 2004 it was accepted unanimously.[3] 来自 wiki百科
可以看到第一个phar就是tar格式打包的文件，而且是直接用tar命令行工具生成。

phar 文件是文本文件还是二进制

通过上文的理解，既然我们将项目文件整合到一个文件了，所以理所当然的就会考虑重写整理文件格式以达到节省空间提高效率的目的。所以打包后的phar是一个二进制文件（想想第一个tar打包的phar文件）。只不过随后phar开始自己的打包的文件格式。下图是phar打包文件格式。

phar manifest format.png

phar 文件是支持权限和分组的。

The Phar manifest is a highly optimized format that allows per-file specification of file compression, file permissions, and even user-defined meta-data such as file user or group. All values greater than 1 byte are stored in little-endian byte order, with the exception of the API version, which for historical reasons is stored as 3 nibbles in big-endian order.

phar 日常使用例子

新建项目目录如下

myapp.png

其中的 build 目录里将放置 PHAR 文件，这样能避免它跟源码程序混合到一起。src 放的就是我们的PHP源码。

index.php 会成为我们的应用的入口程序，common.php 可以放置应用需要的一些共有代码，config.ini 是我们的配置文件。

index.php 大概是这样样子：

<?php
require_once "phar://myapp.phar/common.php";
$config = parse_ini_file("config.ini");
AppManager::run($config);

common.php 大概是这样的：

<?php
class AppManager
{
    public static function run($config) {
         echo "Application is now running with the following configuration... ";
         var_dump($config);
     }
}

在我们的PHP应用目录里，需要有一个创建Phar文件的脚本，我们给它起名叫 create-phar.php，放置到 myapp 的跟目录下，里面添加如下代码：



<?php

/**
 * 目的 ：将PHP框架项目，打包成一个 .phar 文件
 * 常用 ：这个打包，一般是用PHP语言来做 linux 系统软件的，如composer.phar
 *
 * 
 * 方法：
 * 
 * 压缩myaoo 目录下的(php,可选)文件
 *
 * 1、将 php.ini 的 `;phar.readonly = On` 改为 `phar.readonly = Off`
 *
 * 2、运行 create-phar.php（本文件），会在当前目录下生成 myapp.phar
 *
 * 3、在git-bash里，运行 php ./myapp.phar
 *
 * 4、在git-bash里（网页也可以），运行php ./myapp/index.php。输出结果  等同于 第3步输出结果
 */


## 压缩的包名
$phar = new Phar($buildRoot . "/myapp.phar", 
        FilesystemIterator::CURRENT_AS_FILEINFO |
        FilesystemIterator::KEY_AS_FILENAME, "myapp.phar");
// 可以简写 $phar = new Phar('myphar.phar');

## 压缩的路径 【可选参数，压缩文件类型】
/*
$phar["index.php"] = file_get_contents($srcRoot . "/index.php");
$phar["common.php"] = file_get_contents($srcRoot . "/common.php");
*/

$phar->buildFromDirectory(__DIR__ . '/myphar', '/\.php$/');


## 压缩方式，这里用 gzip 方式
$phar->compressFiles(Phar::GZ);

$phar->stopBuffering();

## 默认自动加载 test_phar 目录下的哪个文件。|  等同于 nginx 配置 sever {listen 80; …… index index.php; }
$phar->setStub($phar->createDefaultStub('index.php'));

一个新 Phar 对象的创建通常需要三个参数。第一个参数是Phar文件的路径。你不仅可以通过它创建Phar文件，还可以对现存的Phar文件进行操作。

第二个参数是设定 Phar 对象如何处理文件。Phar 对象继承了 PHP RecursiveDirectoryIterator 对象，这个参数是直接传递到父类里。这里提供的值是RecursiveDirectoryIterator 的缺省值，能满足目前的要求。

第三个参数是Phar文件的别名，在内部引用这个Phar文件时都要使用这个别名。也就是说，Phar内部文件的相互include都需要显式的使用这个别名。例如，之前的index.php 对 common.php 的引用就是这种方式。

在Phar对象创建之后， index.php 和 common.php 就被加入了Phar文件里了。Phar 对象是一个数组，file_get_contents() 方法将各个文件的内容读到数组里。你可以向里面添加很多的文件，但如果你考虑添加大量的文件，比如说整个目录下的文件，你可以考虑使用更方便的 buildFromDirectory() 方法。

打开命令行窗口，切换到 myapp 目录下，运行命令：

aabouzekry@platinum:~/myapp$ php create-phar.php

我们可以直接访问Phar打包的应用，但这需要额外配置web server来将Phar文件发送给正确PHP解析器。另外一个办法是创建一个run脚本，include 这个Phar文件
在web server的根目录创建一个叫 run.php 的PHP脚本：

<?php
require "myapp.phar";

这段代码的作用就是可以让你免去了去配置web server来直接解析Phar文件。如果你的应用使用的是一个共享的虚拟主机，没有权限来配置web server，那么，这种方式是一个完美的解决方案。

创建了run.php后，我们的web server的根目录会变成这样：

run.png

为什么composer命令可以不依赖类php命令而直接运行

如果composer.phar是一个包，那么正常使用composer应该全部是php composer.phar ** 这样的形式，为什么我们在日常使用中缺可以

comoser install

这样的形式来使用呢？
想弄明白为什么，我们先从composer的安装开始过程开始研究

curl -sS https://getcomposer.org/installer | php

从命令上我们可以看书，这个安装命令其实就是从网上下载了installer的PHP文件，然后在本地执行。这个执行过程就类似于上面的打包phar包。最终生成了composer.phar 文件。

linux系统中全局安装,其原理就是: linux系统中文件后缀名并不代表可执行类型，所以将composer.phar移动到bin目录后修改文件名就可以

mv composer.phar /usr/local/bin/composer

windows系统中composer setup.exe 通过bat文件来实现调用composer.phar bat文件类似于

@echo off 
php53\php %D:\phpStudy\tools\composer.phar %*

在这里有个疑问，就是为什么linux的composer.phar文件就可以直接执行，难道comopser.phar是一个可执行的二进制文件不需要PHP解释器吗? 这个问题思考了许久，后来从网上偶然看到一些人在解压缩phar文件，所以我尝试用文本编辑工具打开composer.phar ，就找到了答案

composer.phar.png

原来在在composer.phar的文件头部，内嵌了一段shell代码。至此了解了composer的运行前的必要知识。

如果想了解composer的运行原理，建议可以通过阅读composer来了解
composer

后面一篇再开始讲讲怎么使用composer!

【参考资料】

http://php.net/manual/en/book.phar.php phar 官方文档
https://en.wikipedia.org/wiki/PHAR_(file_format) phar wiki
http://www.webhek.com/post/packaging-your-php-apps-with-phar.html PHP开发常识：什么是Phar?