ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

『PHP』phar文件详解_phar文件格式_调用phar类方法生成phar文件

2021-09-04 21:06:12  阅读:416  来源: 互联网

标签:文件 phar Phar stub 文件格式 test php


phar简介

phar,全称为PHP Archive,phar扩展提供了一种将整个PHP应用程序放入.phar文件中的方法,以方便移动、安装。.phar文件的最大特点是将几个文件组合成一个文件的便捷方式,.phar文件提供了一种将完整的PHP程序分布在一个文件中并从该文件中运行的方法。

可以将phar文件类比为一个压缩文件

phar demo

注意:默认phar扩展是只读模式,需要手动配置php.ini中phar.readonly= Off

无法用ini_set修改
『踩坑记录』PHP-使用ini_set()无法修改phar.readonly

<?php
    $phar = new Phar('demo.phar');
    $phar['demo.php'] = '<?php echo 1;?>';
    include('phar://./demo.phar/demo.php'); //1
?>

使用phar://伪协议可以读取phar文件

源码如下:
在这里插入图片描述

phar文件格式

PHP: Ingredients of all Phar archives, independent of file format - Manual
在这里插入图片描述

stub

stub是phar文件的文件头,格式为...<?php ...;__HALT_COMPILER();?>,…可以是任意字符,包括留空,且php闭合符与最后一个分号之间不能有多于一个的空格符。另外php闭合符也可省略。

包含在php代码块中的语句在phar文件被包含时被执行

<?php
	$phar = new Phar('demo.phar');
	$phar->setStub('<?php echo \'in stub!\';__HALT_COMPILER();?>');
	include('phar://demo.phar');	// in stub!
?>

最短不省略闭合符stub是<?php __HALT_COMPILER();?>

manifest describing the contents

该区域存放phar包的属性信息,允许每个文件指定文件压缩、文件权限,甚至是用户定义的元数据,如文件用户或组。

PHP: Phar File Format - Manual
在这里插入图片描述

file contents

被压缩的用户添加的文件内容

[可选]signature

可选,phar文件的签名,允许的有MD5, SHA1, SHA256, SHA512和OPENSSL

如何生成phar文件?

实例化phar类

phar类提供对phar文件的操作
在这里插入图片描述
通常只需传入文件名

<?php
	$phar = new Phar('demo.phar');
?>

创建stub

创建stub主要有2种方法:

自定义创建

调用类方法Phar::setStub($string)为实例创建自定义stub

<?php
	$phar = new Phar('demo.phar');
	$phar->setStub('<?php echo \'in stub!\';__HALT_COMPILER();?>');
	include('phar://demo.phar');	// in stub!
?>

使用默认stub

调用类方法Phar::setDefaultStub()为实例设置默认stub,使用方法Phar::getStub()获取实例的stub

<?php
    $phar = new Phar('demo.phar');
    $phar->setDefaultStub();
    print_r($phar->getStub()); // 2, 'c' => 'text/plain', 'cc' => 'text/plain', ...
?>

如果缺省创建stub,PHP会使用默认stub
<?php
	$phar = new Phar('demo.phar');
	$phar['demo.txt'] = 'demo';
	print_r($phar->getStub()); // 2, 'c' => 'text/plain', 'cc' => 'text/plain', ...
?>

[可选]添加自定义元数据

manifest数据会根据配置信息自动生成,此步骤在于添加自定义元数据(meta-data),因此是可选的

过大的元数据会引起性能问题

调用类方法Phar::setMetadata()为实例设置默认stub,使用方法Phar::getMetadata()获取实例的stub

<?php
    $phar = new Phar('demo.phar');
    $metadata = array('demo'=>1);
    $phar->setMetadata($metadata);
    print_r($phar->getMetadata()); // Array ( [demo] => 1 )
?>

[可选]添加文件

添加文件有几种方法:

手动选择添加已有文件

调用类方法Phar::addFile($filepath,$localpath=?)添加文件,参数是文件绝对路径和(可选)存储到phar的相对路径

<?php
	$phar = new Phar('demo.phar');
	$phar->addFile('test.php');
	include('phar://demo.phar/test.php') // in test.php
?>

以字符串添加文件内容

调用类方法Phar::addFromString($localpath,$contents)以字符串形式添加文件

<?php
	$phar = new Phar('demo.phar');
	$phar->addFromString('test.php','<?php echo \'in test.php\'?>');
	include('phar://demo.phar/test.php'); // in test.php
?>

添加空目录

调用类方法Phar::addEmptyDir($dirname)添加空目录,使用方法Phar::getContent()获取文件结构

<?php
	$phar = new Phar('demo.phar');
	$phar->addEmptyDir('test'); // demo.phar/test/
?>

手动选择添加已有目录

调用类方法Phar::buildFromDirectory($dir,$pattern = "")添加整个目录

<?php
	$phar = new Phar('demo.phar');
	$phar->buildFromDirectory('test'); // test.php in test/
	include('phar://demo.phar/test/test.php'); // in test/test.php
?>

从迭代器添加

调用类方法Phar::buildFromIterator($iterator, ?$baseDirectory = null)从迭代器添加

PHP: Phar::buildFromIterator - Manual在这里插入图片描述

[可选]手动添加支持的签名

缺省会自动签名,基于SHA-1算法

<?php
	$phar = new Phar('demo.phar');
	$phar->addFromString('test.php',1);
print_r($phar->getSignature()); // Array ( [hash] => F... [hash_type] => SHA-1 )
?>

调用类方法Phar::setSignatureAlgorithm(int $algo, ?string $privateKey = null)添加签名

PHP: Phar::setSignatureAlgorithm - Manual
在这里插入图片描述

[可选]提高性能

由于每次对phar文件的操作都会引起物理存储上的整个phar文件的重新创建,对于处理包含大量文件的phar文件会带来性能问题。因此,使用缓冲区进行修改,完毕后一并写入物理存储能够减少对物理存储上文件的重新创建,一次性写入从而达到提高性能的效果

PHP: Phar::startBuffering - Manual这里是引用

在实例化phar类后,调用方法Phar::startBuffering()Phar::stopBuffering创建缓冲区,并在缓冲区进行创建、添加等操作

<?php
	$phar = new Phar('phar.phar');
	$phar->startBuffering();
	$phar->setStub('<? __HALT__COMPILER();?>');
	$phar->addFromString('test.php','<?php echo \'in test.php\'?>');
	$phar->stopBuffering();
?>

参考

PHP: Phar - Manual

标签:文件,phar,Phar,stub,文件格式,test,php
来源: https://blog.csdn.net/Xxy605/article/details/120101090

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有