這次帶給大家PHP如何操作phar文件,PHP操作phar文件的注意事項有哪些,下面就是實戰案例,一起來看一下。
# 本文實例講述了PHP開發之歸檔格式phar檔案概念與用法。分享給大家參考,具體如下:
# 一個php應用程式往往是由多個檔案構成的,如果能把他們集中為一個檔案來分發和運行是很方便的,這樣的列子有很多,例如在window作業系統上面的安裝程式、一個jquery庫等等等,為了做到這點php採用了phar文檔文件格式,這個概念源自java的jar,但是在設計時主要針對 PHP 的 Web 環境,與 JAR 歸檔不同的是Phar 歸檔可由 PHP 本身處理,因此不需要使用額外的工具來創建或使用,使用php腳本就能創建或提取它。 phar是一個合成詞,由PHP 和 Archive構成,可以看出它是php歸檔檔的意思。
關於phar的官網文件請見http://php.net/manual/zh/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流包裝器,關於此可參考前面一篇文章PHP流Streams、包裝器wrapper概念與用法實例詳解
# 許多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流
相信看了本文案例你已经掌握了方法,更多精彩请关注php中文网其它相关文章!
推荐阅读:
以上是PHP如何操作phar文件的詳細內容。更多資訊請關注PHP中文網其他相關文章!