1. 程式人生 > >php歸檔格式:phar字尾檔案詳解(建立、使用、解包還原提取)

php歸檔格式:phar字尾檔案詳解(建立、使用、解包還原提取)

 PHP交流群:294088839

Python交流群:652376983

優點:

可單個phar檔案部署專案

參考:https://segmentfault.com/a/1190000002166235

缺點:

打包後,速度肯定比引入原始碼慢了

參考:http://blog.csdn.net/ugg/article/details/25335079

一個php應用程式往往是由多個檔案構成的,如果能把他們集中為一個檔案來分發和執行是很方便的,這樣的列子有很多,比如在window作業系統上面的安裝程式、一個jquery庫等等,為了做到這點php採用了phar文件檔案格式,這個概念源自java的jar,但是在設計時主要針對 PHP 的 Web 環境,與 JAR 歸檔不同的是Phar 歸檔可由 PHP 本身處理,因此不需要使用額外的工具來建立或使用,使用php指令碼就能建立或提取它。phar是一個合成詞,由PHP 和 Archive構成,可以看出它是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流包裝器,關於此可訪問筆者的另外一篇帖子:

很多php應用都是以phar格式分發並執行的,著名的有依賴管理:composer、單元測試:phpunit,下面我們來看一看如何建立、執行、提取還原。

phar檔案的建立:

首先在php.ini中修改phar.readonly這個選項,去掉前面的分號,並改值為off,由於安全原因該選項預設是on,如果在php.ini中是禁用的(值為0或off),那麼在使用者指令碼中可以開啟或關閉,如果在php.ini中是開啟的,那麼使用者指令碼是無法關閉的,所以這裡設定為off來展示示例。

我們來建立一個專案,在伺服器根目錄中建立專案資料夾為project,目錄內的結構如下:

  1. file  
  2.     -yunek.js  
  3.     -yunke.css  
  4. lib  
  5.     -lib_a.php  
  6. template  
  7.     -msg.html  
  8. index.php  
  9. Lib.php  

其中file資料夾有兩個內容為空的js和css檔案,僅僅演示phar可以包含多種檔案格式

lib_a.php內容如下:

  1. <?php  
  2. /** 
  3.  * Created by yunke. 
  4.  * User: yunke 
  5.  * Date: 2017/2/10 
  6.  * Time: 9:23 
  7.  */  
  8. function show(){  
  9.     echo "l am show()";  
  10. }  

msg.html內容如下:

  1. <!DOCTYPE html>  
  2. <html lang="en">  
  3. <head>  
  4.     <meta charset="UTF-8">  
  5.     <title>phar</title>  
  6. </head>  
  7. <body>  
  8. <?=$str; ?>  
  9. </body>  
  10. </html>  

index.php內容如下:

  1. <?php  
  2. /** 
  3.  * Created by yunke. 
  4.  * User: yunke 
  5.  * Date: 2017/2/10 
  6.  * Time: 9:17 
  7.  */  
  8. require "lib/lib_a.php";  
  9. show();  
  10. $str = isset($_GET["str"]) ? $_GET["str"] : "hello world";  
  11. include "template/msg.html";  

Lib.php內容如下:

  1. <?php  
  2. /** 
  3.  * Created by yunke. 
  4.  * User: yunke 
  5.  * Date: 2017/2/10 
  6.  * Time: 9:20 
  7.  */  
  8. function yunke()  
  9. {  
  10.     echo "l am yunke()";  
  11. }  

專案檔案準備好了,開始建立,現在在project資料夾同級目錄建立一個yunkeBuild.php,用於產生phar格式檔案,內容如下:

  1. <?php  
  2. /** 
  3.  * Created by yunke. 
  4.  * User: yunke 
  5.  * Date: 2017/2/10 
  6.  * Time: 9:36 
  7.  */  
  8. //產生一個yunke.phar檔案  
  9. $phar = new Phar('yunke.phar', 0, 'yunke.phar');  
  10. // 新增project裡面的所有檔案到yunke.phar歸檔檔案  
  11. $phar->buildFromDirectory(dirname(__FILE__) . '/project');  
  12. //設定執行時的入口檔案,第一個用於命令列,第二個用於瀏覽器訪問,這裡都設定為index.php  
  13. $phar->setDefaultStub('index.php''index.php');  

然後在瀏覽器中訪問這個yunkeBuild.php檔案,將產生一個yunke.phar檔案,此時伺服器根目錄結構如下:

  1. project  
  2. yunkeBuild.php  
  3. yunke.phar  

這就是產生一個phar歸檔檔案最簡單的過程了,更多內容請看官網,這裡需要注意的是如果專案不具備單一執行入口則不宜使用phar歸檔檔案

phar歸檔檔案的使用:

我們在伺服器根目錄建立一個index.php檔案來演示如何使用上面建立的phar檔案,內容如下:

  1. <?php  
  2. /** 
  3.  * Created by yunke. 
  4.  * User: yunke 
  5.  * Date: 2017/2/8 
  6.  * Time: 9:33 
  7.  */  
  8. require "yunke.phar";  
  9. require "phar://yunke.phar/Lib.php";  
  10. yunke();  

如果index.php檔案中只有第一行,那麼和不使用歸檔檔案時,新增如下程式碼完全相同:

  1. require "project/index.php";  

如果沒有第二行,那麼第三行的yunke()將提示未定義,所以可見require一個phar檔案時並不是匯入了裡面所有的檔案,而只是匯入了入口執行檔案而已,但在實際專案中往往在這個入口檔案裡匯入其他需要使用的檔案,在本例中入口執行檔案為project/index.php

phar檔案的提取還原:

我們有時候會好奇phar裡面包含的檔案原始碼,這個時候就需要將phar檔案還原,如果只是看一看的話可以使用一些ide工具,比如phpstorm 10就能直接開啟它,如果需要修改那麼就需要提取操作了,為了演示,我們下載一個composer.phar放在伺服器目錄,在根目錄建立一個get.php檔案,內容如下:

  1. <?php  
  2. /** 
  3.  * Created by yunke. 
  4.  * User: yunke 
  5.  * Date: 2017/2/9 
  6.  * Time: 19:02 
  7.  */  
  8. $phar = new Phar('composer.phar');  
  9. $phar->extractTo('composer'); //提取一份原專案檔案  
  10. $phar->convertToData(Phar::ZIP); //另外再提取一份,和上行二選一即可  

用瀏覽器訪問這個檔案,即可提取出來,以上列子展示了兩種提取方式:第二行將建立一個composer目錄,並將提取出來的內容放入,第三行將產生一個composer.zip檔案,解壓即可得到提取還原的專案檔案。

補充:

1、在部署phar檔案到生產伺服器時需要調整伺服器的配置,避免當訪問時瀏覽器直接下載phar檔案

2、可以為歸檔設定別名,別名儲存在歸檔檔案中永久儲存,它可以用一個簡短的名字引用歸檔,而不管歸檔檔案在檔案系統中儲存在那裡,設定別名:

  1. $phar = new Phar('lib/yunke.phar', 0);  
  2. $phar->setAlias ( "yun.phar");  

設定別名後可以如下使用:

  1. <?php  
  2. require "lib/yunke.phar";  
  3. require "phar://yun.phar/Lib.php";  //使用別名訪問歸檔檔案  
  4. 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流