php归档格式:phar文件详解(创建、使用、解包还原提取)

转载一篇,突然遇到一个冷知识,phar的东东,貌似和jar、war是一种鬼。

重点使用一下下面这个东东,就能解包出来东东了。

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

https://blog.csdn.net/u011474028/article/details/54973571

一个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,目录内的结构如下:

[plain] view plain copy

file  
    -yunek.js  
    -yunke.css  
lib  
    -lib_a.php  
template  
    -msg.html  
index.php  
Lib.php  
 

其中file文件夹有两个内容为空的js和css文件,仅仅演示phar可以包含多种文件格式

lib_a.php内容如下:

[php] view plain copy

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

msg.html内容如下:

[php] view plain copy

<!DOCTYPE html>  
<html lang="en">  
<head>  
    <meta charset="UTF-8">  
    <title>phar</title>  
</head>  
<body>  
<?=$str; ?>  
</body>  
</html>  

index.php内容如下:

[php] view plain copy

<?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] view plain copy

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

项目文件准备好了,开始创建,现在在project文件夹同级目录建立一个yunkeBuild.php,用于产生phar格式文件,内容如下:

[php] view plain copy

<?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文件,此时服务器根目录结构如下:

[plain] view plain copy

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

这就是产生一个phar归档文件最简单的过程了,更多内容请看官网,这里需要注意的是如果项目不具备单一执行入口则不宜使用phar归档文件

phar归档文件的使用:

我们在服务器根目录建立一个index.php文件来演示如何使用上面创建的phar文件,内容如下:

[php] view plain copy

<?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文件中只有第一行,那么和不使用归档文件时,添加如下代码完全相同:

[php] view plain copy

  1. require "project/index.php";  

如果没有第二行,那么第三行的yunke()将提示未定义,所以可见require一个phar文件时并不是导入了里面所有的文件,而只是导入了入口执行文件而已,但在实际项目中往往在这个入口文件里导入其他需要使用的文件,在本例中入口执行文件为project/index.php

phar文件的提取还原:

我们有时候会好奇phar里面包含的文件源码,这个时候就需要将phar文件还原,如果只是看一看的话可以使用一些ide工具,比如phpstorm 10就能直接打开它,如果需要修改那么就需要提取操作了,为了演示,我们下载一个composer.phar放在服务器目录,在根目录建立一个get.php文件,内容如下:

[php] view plain copy

<?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、可以为归档设置别名,别名保存在归档文件中永久保存,它可以用一个简短的名字引用归档,而不管归档文件在文件系统中存储在那里,设置别名:

[php] view plain copy

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

设置别名后可以如下使用:

[php] view plain copy

<?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流

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Java技术

使用Generic Webhook Trigger插件实现Jenkins+WebHooks(码云)持续集成

我们在开发的时候,特别是前后端分离的时候,前端需要我们后端提供的API接口,可能需要每次有一个接口的变动都需要重新部署到dev环境上,例如:最常见的Git工作流...

1963
来自专栏纯洁的微笑

springboot(一):入门篇

什么是spring boot Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使...

2927
来自专栏Android相关

Gradle For Android(3)--管理依赖关系

依赖关系管理是Gradle的闪光点。在这个脚本中最好的一点,就是你所需要的只是添加一行到你的build.gradle中,然后Gradle就会从一个远程仓库中下载...

913
来自专栏battcn

一起来学SpringBoot | 第二十四篇:数据库管理与迁移(Liquibase)

目前 SpringBoot 支持较好的两款工具分别是 flyway、 liquibase,支持 sql script,在初始化数据源之后执行指定的 脚本代码或者...

1242
来自专栏云计算教程系列

如何在CentOS 7上安装Bacula Server

Bacula是一种开源网络备份解决方案,允许您创建备份并执行计算机系统的数据恢复。它非常灵活和强大,这使得它在配置时稍微麻烦,适合在许多情况下进行备份。备份系统...

3873
来自专栏猿天地

Spring Boot中整合Sharding-JDBC读写分离示例

在我《Spring Cloud微服务-全栈技术与案例解析》书中,第18章节分库分表解决方案里有对Sharding-JDBC的使用进行详细的讲解。

2913
来自专栏云计算

如何在Linux,Mac或Windows上安装Git

Git是由Linus Torvalds为Linux内核设计开发的。Git为非线性的分布式开发提供了支持,允许多个项目成员同时在一个项目上进行开发。Git是最流行...

1742
来自专栏JavaEdge

Hystrix 自动降级与依赖隔离1.背景2.Hystrix说明

目前对于一些非核心操作,如增减库存后保存操作日志 发送异步消息时(具体业务流程),一旦出现MQ服务异常时,会导致接口响应超时,因此可以考虑对非核心操作引入服务降...

1512
来自专栏阮一峰的网络日志

持续集成服务 Travis CI 教程

编写代码只是软件开发的一小部分,更多的时间往往花在构建(build)和测试(test)。 为了提高软件开发的效率,构建和测试的自动化工具层出不穷。Travis ...

3595
来自专栏SpringBoot 核心技术

SpringCloud组件:搭建Eureka服务注册中心

Eureka服务注册中心是netflix开源组织提供的一个服务高可用的解决方案,在前端时间一直在疯传的2.0开源流产的问题,其实并不影响我们的使用,netfli...

1802

扫码关注云+社区