編碼的世界 / 優質文選 / 文明

php歸檔格式：phar文件詳解（創建、使用、解包還原提取）

2022年7月03日
-   

一個php應用程序往往是由多個文件構成的，如果能把他們集中為一個文件來分發和運行是很方便的，這樣的列子有很多，比如在window操作系統上面的安裝程序、一個jquery庫等等，為了做到這點php采用了phar文檔文件格式，這個概念源自java的jar，但是在設計時主要針對 PHP 的 Web 環境，與 JAR 歸檔不同的是Phar 歸檔可由 PHP 本身處理，因此不需要使用額外的工具來創建或使用，使用php腳本就能創建或提取它。phar是一個合成詞，由PHP 和 Archive構成，可以看出它是php歸檔文件的意思。
 
關於phar的官網文檔請見http://php.net/manual/en/book.phar.php，本文檔可以看做和官網文檔互為補充
 
phar歸檔文件有三種格式：tar歸檔、zip歸檔、phar歸檔，前兩種執行需要php安裝Phar 擴展支持，用的也比較少，這裏主要講phar歸檔格式。
 
phar格式歸檔文件可以直接執行，它的產生依賴於Phar擴展，由自己編寫的php腳本產生。
 
Phar 擴展對 PHP 來說並不是一個新鮮的概念，在php5.3已經內建於php中，它最初使用 PHP 編寫並被命名為 PHP_Archive，然後在 2005 年被添加到 PEAR 庫。由於在實際中，解決這一問題的純 PHP 解決方案非常緩慢，因此 2007 年重新編寫為純 C 語言擴展，同時添加了使用 SPL 的 ArrayAccess 對象遍歷 Phar 歸檔的支持。自那時起，人們做了大量工作來改善 Phar 歸檔的性能。
 
Phar 擴展依賴於php流包裝器，關於此可訪問筆者的另外一篇帖子：
http://blog.csdn.net/u011474028/article/details/52814049
 
很多php應用都是以phar格式分發並運行的，著名的有依賴管理：composer、單元測試：phpunit，下面我們來看一看如何創建、運行、提取還原。
 
phar文件的創建：首先在php.ini中修改phar.readonly這個選項，去掉前面的分號，並改值為off，由於安全原因該選項默認是on，如果在php.ini中是禁用的（值為0或off），那麼在用戶腳本中可以開啟或關閉，如果在php.ini中是開啟的，那麼用戶腳本是無法關閉的，所以這裏設置為off來展示示例。
我們來建立一個項目，在服務器根目錄中建立項目文件夾為project，目錄內的結構如下：
 
file
	-yunek.js
	-yunke.css
lib
	-lib_a.php
template
	-msg.html
index.php
Lib.php
 

 
 
 
其中file文件夾有兩個內容為空的js和css文件，僅僅演示phar可以包含多種文件格式
lib_a.php內容如下：
<?php
/**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:23
 */
function show(){
 echo "l am show()";
}

msg.html內容如下：
<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>phar</title>
</head>
<body>
<?=$str; ?>
</body>
</html>

 
index.php內容如下：
 
<?php
/**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:17
 */
require "lib/lib_a.php";
show();
$str = isset($_GET["str"]) ? $_GET["str"] : "hello world";
include "template/msg.html";

 
Lib.php內容如下：
 
<?php
/**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:20
 */
function yunke()
{
 echo "l am yunke()";
}

 
項目文件准備好了，開始創建，現在在project文件夾同級目錄建立一個yunkeBuild.php，用於產生phar格式文件，內容如下：
 
 
<?php
/**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:36
 */
//產生一個yunke.phar文件
$phar = new Phar('yunke.phar', 0, 'yunke.phar');
// 添加project裏面的所有文件到yunke.phar歸檔文件
$phar->buildFromDirectory(dirname(__FILE__) . '/project');
//設置執行時的入口文件，第一個用於命令行，第二個用於瀏覽器訪問，這裏都設置為index.php
$phar->setDefaultStub('index.php', 'index.php');

 
然後在瀏覽器中訪問這個yunkeBuild.php文件，將產生一個yunke.phar文件，此時服務器根目錄結構如下：
 
project
yunkeBuild.php
yunke.phar

 
這就是產生一個phar歸檔文件最簡單的過程了，更多內容請看官網，這裏需要注意的是如果項目不具備單一執行入口則不宜使用phar歸檔文件
 
phar歸檔文件的使用：我們在服務器根目錄建立一個index.php文件來演示如何使用上面創建的phar文件，內容如下：
<?php
/**
 * Created by yunke.





 * User: yunke
 * Date: 2017/2/8
 * Time: 9:33
 */
require "yunke.phar";
require "phar://yunke.phar/Lib.php";
yunke();

如果index.php文件中只有第一行，那麼和不使用歸檔文件時，添加如下代碼完全相同：
 
require "project/index.php";

 
 
 
如果沒有第二行，那麼第三行的yunke()將提示未定義，所以可見require一個phar文件時並不是導入了裏面所有的文件，而只是導入了入口執行文件而已，但在實際項目中往往在這個入口文件裏導入其他需要使用的文件，在本例中入口執行文件為project/index.php
 
phar文件的提取還原：我們有時候會好奇phar裏面包含的文件源碼，這個時候就需要將phar文件還原，如果只是看一看的話可以使用一些ide工具，比如phpstorm 10就能直接打開它，如果需要修改那麼就需要提取操作了，為了演示，我們下載一個composer.phar放在服務器目錄，在根目錄建立一個get.php文件，內容如下：
<?php
/**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/9
 * Time: 19:02
 */
$phar = new Phar('composer.phar');
$phar->extractTo('composer'); //提取一份原項目文件
$phar->convertToData(Phar::ZIP); //另外再提取一份，和上行二選一即可

 
用瀏覽器訪問這個文件，即可提取出來，以上列子展示了兩種提取方式：第二行將建立一個composer目錄，並將提取出來的內容放入，第三行將產生一個composer.zip文件，解壓即可得到提取還原的項目文件。
 
 
補充：1、在部署phar文件到生產服務器時需要調整服務器的配置，避免當訪問時瀏覽器直接下載phar文件
2、可以為歸檔設置別名，別名保存在歸檔文件中永久保存，它可以用一個簡短的名字引用歸檔，而不管歸檔文件在文件系統中存儲在那裏，設置別名：
 
$phar = new Phar('lib/yunke.phar', 0);
$phar->setAlias ( "yun.phar");

設置別名後可以如下使用：
 
 
<?php
require "lib/yunke.phar";
require "phar://yun.phar/Lib.php"; //使用別名訪問歸檔文件
require "phar://lib/yunke.phar/Lib.php"; //當然仍然可以使用這樣的方式去引用

如果在制作phar文件時沒有指定別名，也可以在存根文件裏面使用Phar::mapPhar('yunke.phar');指定
3、歸檔文件中有一個存根文件，其實就是一段php執行代碼，在制作歸檔時可以設置，直接執行歸檔文件時，其實就是執行它，所以它是啟動文件；在腳本中包含歸檔文件時就像包含普通php文件一樣包含它並運行，但直接以phar://的方式包含歸檔中某一個文件時不會執行存根代碼， 往往在存根文件裏面require包含要運行的其他文件，對存根文件的限制僅為以__HALT_COMPILER();結束，默認的存根設計是為在沒有phar擴展時能夠運行，它提取phar文件內容到一個臨時目錄再執行，不過從php5.3開始該擴展默認內置啟用了
4、制作的phar文件不能被改動，因此配置文件之類的文件需要另外放置在歸檔文件外面
5、mapPhar函數：這個函數只應該在stub存根代碼中調用，在沒有設置歸檔別名的時候可以用來設置別名，打開一個引用映射到phar流
 
 
我是雲客,雲遊天下，做客四方,聯系方式見主頁，歡迎轉載，但須注明出處
 
 
 
 
 

熱門文章