PHP開(kāi)發(fā)之歸檔格式phar文件概念與用法詳解【創(chuàng)建,使用,解包還原提取】
本文實(shí)例講述了PHP開(kāi)發(fā)之歸檔格式phar文件概念與用法。分享給大家供大家參考，具體如下：
一個(gè)php應(yīng)用程序往往是由多個(gè)文件構(gòu)成的，如果能把他們集中為一個(gè)文件來(lái)分發(fā)和運(yùn)行是很方便的，這樣的列子有很多，比如在window操作系統(tǒng)上面的安裝程序、一個(gè)jquery庫(kù)等等，為了做到這點(diǎn)php采用了phar文檔文件格式，這個(gè)概念源自java的jar，但是在設(shè)計(jì)時(shí)主要針對(duì) PHP 的 Web 環(huán)境，與 JAR 歸檔不同的是Phar 歸檔可由 PHP 本身處理，因此不需要使用額外的工具來(lái)創(chuàng)建或使用，使用php腳本就能創(chuàng)建或提取它。phar是一個(gè)合成詞，由PHP 和 Archive構(gòu)成，可以看出它是php歸檔文件的意思。
關(guān)于phar的官網(wǎng)文檔請(qǐng)見(jiàn)http://php.net/manual/zh/book.phar.php，本文檔可以看做和官網(wǎng)文檔互為補(bǔ)充
phar歸檔文件有三種格式：tar歸檔、zip歸檔、phar歸檔，前兩種執(zhí)行需要php安裝Phar 擴(kuò)展支持，用的也比較少，這里主要講phar歸檔格式。
phar格式歸檔文件可以直接執(zhí)行，它的產(chǎn)生依賴(lài)于Phar擴(kuò)展，由自己編寫(xiě)的php腳本產(chǎn)生。
Phar 擴(kuò)展對(duì) PHP 來(lái)說(shuō)并不是一個(gè)新鮮的概念，在php5.3已經(jīng)內(nèi)建于php中，它最初使用 PHP 編寫(xiě)并被命名為 PHP_Archive，然后在 2005 年被添加到 PEAR 庫(kù)。由于在實(shí)際中，解決這一問(wèn)題的純 PHP 解決方案非常緩慢，因此 2007 年重新編寫(xiě)為純 C 語(yǔ)言擴(kuò)展，同時(shí)添加了使用 SPL 的 ArrayAccess 對(duì)象遍歷 Phar 歸檔的支持。自那時(shí)起，人們做了大量工作來(lái)改善 Phar 歸檔的性能。
Phar 擴(kuò)展依賴(lài)于php流包裝器，關(guān)于此可參考前面一篇文章PHP流Streams、包裝器wrapper概念與用法實(shí)例詳解
很多php應(yīng)用都是以phar格式分發(fā)并運(yùn)行的，著名的有依賴(lài)管理：composer、單元測(cè)試：phpunit，下面我們來(lái)看一看如何創(chuàng)建、運(yùn)行、提取還原。
phar文件的創(chuàng)建：
首先在php.ini中修改phar.readonly這個(gè)選項(xiàng)，去掉前面的分號(hào)，并改值為off，由于安全原因該選項(xiàng)默認(rèn)是on，如果在php.ini中是禁用的（值為0或off），那么在用戶(hù)腳本中可以開(kāi)啟或關(guān)閉，如果在php.ini中是開(kāi)啟的，那么用戶(hù)腳本是無(wú)法關(guān)閉的，所以這里設(shè)置為off來(lái)展示示例。
我們來(lái)建立一個(gè)項(xiàng)目，在服務(wù)器根目錄中建立項(xiàng)目文件夾為project，目錄內(nèi)的結(jié)構(gòu)如下：
- file
- -yunek.js
- -yunke.<a href="http://m.survivalescaperooms.com/cssdiv/css.html" class="anchor" target="_blank">css</a>
- lib
- -lib_a.php
- template
- -msg.html
- index.php
- Lib.php
其中file文件夾有兩個(gè)內(nèi)容為空的js和css文件，僅僅演示phar可以包含多種文件格式
lib_a.php內(nèi)容如下：
- /**
- * Created by yunke.
- * User: yunke
- * Date: 2017/2/10
- * Time: 9:23
- */
- function show(){
- echo "l am show()";
- }
msg.html內(nèi)容如下：
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="UTF-8">
- <title>phar</title>
- </head>
- <body>
- <?=$str; ?>
- </body>
- </html>
index.php內(nèi)容如下：
- <?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內(nèi)容如下：
- <?php
- /**
- * Created by yunke.
- * User: yunke
- * Date: 2017/2/10
- * Time: 9:20
- */
- function yunke()
- {
- echo "l am yunke()";
- }
項(xiàng)目文件準(zhǔn)備好了，開(kāi)始創(chuàng)建，現(xiàn)在在project文件夾同級(jí)目錄建立一個(gè)yunkeBuild.php，用于產(chǎn)生phar格式文件，內(nèi)容如下：
- /**
- * Created by yunke.
- * User: yunke
- * Date: 2017/2/10
- * Time: 9:36
- */
- //產(chǎn)生一個(gè)yunke.phar文件
- $phar = new Phar('yunke.phar', 0, 'yunke.phar');
- // 添加project里面的所有文件到y(tǒng)unke.phar歸檔文件
- $phar->buildFromDirectory(dirname(__FILE__) . '/project');
- //設(shè)置執(zhí)行時(shí)的入口文件，第一個(gè)用于命令行，第二個(gè)用于瀏覽器訪問(wèn)，這里都設(shè)置為index.php
- $phar->setDefaultStub('index.php', 'index.php');
然后在瀏覽器中訪問(wèn)這個(gè)yunkeBuild.php文件，將產(chǎn)生一個(gè)yunke.phar文件，此時(shí)服務(wù)器根目錄結(jié)構(gòu)如下：
project
yunkeBuild.php
yunke.phar
這就是產(chǎn)生一個(gè)phar歸檔文件最簡(jiǎn)單的過(guò)程了，更多內(nèi)容請(qǐng)看官網(wǎng)，這里需要注意的是如果項(xiàng)目不具備單一執(zhí)行入口則不宜使用phar歸檔文件
phar歸檔文件的使用：
我們?cè)诜?wù)器根目錄建立一個(gè)index.php文件來(lái)演示如何使用上面創(chuàng)建的phar文件，內(nèi)容如下：
- /**
- * Created by yunke.
- * User: yunke
- * Date: 2017/2/8
- * Time: 9:33
- */
- require "yunke.phar";
- require "phar://yunke.phar/Lib.php";
- yunke();
如果index.php文件中只有第一行，那么和不使用歸檔文件時(shí)，添加如下代碼完全相同：
require "project/index.php";
如果沒(méi)有第二行，那么第三行的yunke()將提示未定義，所以可見(jiàn)require一個(gè)phar文件時(shí)并不是導(dǎo)入了里面所有的文件，而只是導(dǎo)入了入口執(zhí)行文件而已，但在實(shí)際項(xiàng)目中往往在這個(gè)入口文件里導(dǎo)入其他需要使用的文件，在本例中入口執(zhí)行文件為project/index.php
phar文件的提取還原：
我們有時(shí)候會(huì)好奇phar里面包含的文件源碼，這個(gè)時(shí)候就需要將phar文件還原，如果只是看一看的話可以使用一些ide工具，比如phpstorm 10就能直接打開(kāi)它，如果需要修改那么就需要提取操作了，為了演示，我們下載一個(gè)composer.phar放在服務(wù)器目錄，在根目錄建立一個(gè)get.php文件，內(nèi)容如下：
- /**
- * Created by yunke.
- * User: yunke
- * Date: 2017/2/9
- * Time: 19:02
- */
- $phar = new Phar('composer.phar');
- $phar->extractTo('composer'); //提取一份原項(xiàng)目文件
- $phar->convertToData(Phar::ZIP); //另外再提取一份，和上行二選一即可
用瀏覽器訪問(wèn)這個(gè)文件，即可提取出來(lái)，以上列子展示了兩種提取方式：第二行將建立一個(gè)composer目錄，并將提取出來(lái)的內(nèi)容放入，第三行將產(chǎn)生一個(gè)composer.zip文件，解壓即可得到提取還原的項(xiàng)目文件。
補(bǔ)充：
1、在部署phar文件到生產(chǎn)服務(wù)器時(shí)需要調(diào)整服務(wù)器的配置，避免當(dāng)訪問(wèn)時(shí)瀏覽器直接下載phar文件
2、可以為歸檔設(shè)置別名，別名保存在歸檔文件中永久保存，它可以用一個(gè)簡(jiǎn)短的名字引用歸檔，而不管歸檔文件在文件系統(tǒng)中存儲(chǔ)在那里，設(shè)置別名：
$phar = new Phar('lib/yunke.phar', 0);
$phar->setAlias ( "yun.phar");
設(shè)置別名后可以如下使用：
- require "lib/yunke.phar";
- require "phar://yun.phar/Lib.php"; //使用別名訪問(wèn)歸檔文件
- require "phar://lib/yunke.phar/Lib.php"; //當(dāng)然仍然可以使用這樣的方式去引用
如果在制作phar文件時(shí)沒(méi)有指定別名，也可以在存根文件里面使用Phar::mapPhar('yunke.phar');指定
3、歸檔文件中有一個(gè)存根文件，其實(shí)就是一段php執(zhí)行代碼，在制作歸檔時(shí)可以設(shè)置，直接執(zhí)行歸檔文件時(shí)，其實(shí)就是執(zhí)行它，所以它是啟動(dòng)文件；在腳本中包含歸檔文件時(shí)就像包含普通php文件一樣包含它并運(yùn)行，但直接以phar://的方式包含歸檔中某一個(gè)文件時(shí)不會(huì)執(zhí)行存根代碼， 往往在存根文件里面require包含要運(yùn)行的其他文件，對(duì)存根文件的限制僅為以__HALT_COMPILER();結(jié)束，默認(rèn)的存根設(shè)計(jì)是為在沒(méi)有phar擴(kuò)展時(shí)能夠運(yùn)行，它提取phar文件內(nèi)容到一個(gè)臨時(shí)目錄再執(zhí)行，不過(guò)從php5.3開(kāi)始該擴(kuò)展默認(rèn)內(nèi)置啟用了
4、制作的phar文件不能被改動(dòng)，因此配置文件之類(lèi)的文件需要另外放置在歸檔文件外面
5、mapPhar函數(shù)：這個(gè)函數(shù)只應(yīng)該在stub存根代碼中調(diào)用，在沒(méi)有設(shè)置歸檔別名的時(shí)候可以用來(lái)設(shè)置別名，打開(kāi)一個(gè)引用映射到phar流
新聞熱點(diǎn)
疑難解答
