PHP使用Phar打包控制台程序【20210419】

发表于 2020-11-20
阅读 18

介绍

介绍

php脚本有着非常强大的库支持,可以轻松做出特别强大的程序。php不仅仅可以搭建各种各样的网站系统、平台系统,还可以开发基于控制台运行的程序。不过使用php开发的控制台程序在使用的时候需要保证包含库文件的相对路径结构,这个在使用上不是很方便。如果有一个方法可以把整个php项目都变成一个php文件就好了。

其实php自身支持一种叫做phar的打包方式,可以使用自带的Phar对象将我们项目里的所有文件都打包到一个文件里面,这就很好地解决了我们的需求了。

编码转换器

我们先使用php开发一个编码转换器,支持字符串的MD5哈希加密、BASE的编码/解码、URL的编码/解码的功能。

只看需求大家都知道了,这些功能都是php内建的函数可以实现的功能,我们需要做的就是把它们封装一下而已。

lib/TFEncoder.inc.php

编码对象,用友实现需求的各种编码、解码的功能。

namespace TFPHP\Demo;

class TFEncoder{
    private string $CRLF;

    public function __construct(){
        $this->CRLF = "\n";
    }

    public function md5(string $org):string {

        return md5($org);
    }

    public function base64(string $org, bool $decode=false):string {
        if($decode){

            return base64_decode($org);
        }

        return base64_encode($org);
    }

    public function url(string $org, bool $decode=false):string {
        if($decode){

            return urldecode($org);
        }

        return urlencode($org);
    }

    public function printLine($org){
        echo $org. $this->CRLF;
    }

    public function dumpLine($org){
        var_dump($org);
    }
}

TFEncoder.php

入口程序,通过调用TFEncoder对象的方法实现需求里面的那些编码、解码功能。

use TFPHP\Demo\TFEncoder;

include_once ('lib/TFEncoder.inc.php');

$method = $_SERVER['argv'][1];
$origin = $_SERVER['argv'][2];
$myEncoder = new TFEncoder();
switch($method){
    case "md5":
        $myEncoder->printLine($myEncoder->md5($origin));
        break;
    case "b64e":
    case "base64encode":
        $myEncoder->printLine($myEncoder->base64($origin));
        break;
    case "b64d":
    case "base64decode":
        $myEncoder->printLine($myEncoder->base64($origin, true));
        break;
    case "ue":
    case "urlencode":
        $myEncoder->printLine($myEncoder->url($origin));
        break;
    case "ud":
    case "urldecode":
        $myEncoder->printLine($myEncoder->url($origin, true));
        break;
    case "-V":
    case "--version":
        print "Copyright (C) 2012 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
";
        break;
    default:
        print "Usage: TFEncoder [method] [origin]

method:
  md5                   - MD5
  b64e, base64encode    - BASE64 encode
  b64d, base64decode    - BASE64 decode
  ue, urlencode         - URL encode
  ud, urldecode         - URL decode

For more information, please see:
<http://tongfu.net/demo/tfencoder>.
";
        break;
}

20dbd20611996ac5.jpg

开启Phar打包

默认Phar打包功能的关闭的,我们需要到php.ini里面打开它。找到php.ini里面的Phar这一块,将phar.readonly改成Off即可。

ce3d30810cb88695.jpg

使用Phar打包

现在我们使用Phar对象把TFEncoder项目打包一下。

TFEncoder_Phar.php

$currDir = __DIR__. "/";
$physicalDirRoot = __DIR__. "/";
$pharSaveFilePath = $physicalDirRoot. "TFEncoder.phar";
$pharEntryFilePath = "TFEncoder.php";

$myPhar = new Phar($pharSaveFilePath);
$myPhar->addEmptyDir("lib/");
$myPhar->addFile(
    $physicalDirRoot. "lib/TFEncoder.inc.php",
    "lib/TFEncoder.inc.php"
    );
$myPhar->addFile(
    $physicalDirRoot. "TFEncoder.php",
    "TFEncoder.php"
);
$myPhar->compressFiles(Phar::GZ);
$myPhar->stopBuffering();
$myPhar->setStub($myPhar->createDefaultStub($pharEntryFilePath));

讲解

  • $pharSaveFilePath就是打包完成后的phar程序包的保存路径。

  • $pharEntryFilePath是phar程序包的入口程序文件,这个文件是程序包里的路径不是本地物理路径,运行程序包的时候会自动调用这个程序文件。

  • addEmptyDir方法可以在程序包里建立文件夹,如果要放入程序包的程序文件的目录结构是在子目录下面则必须要使用这个方法先在程序包里面建立子目录。

  • addFile方法的第一个参数是要放入程序包里的程序文件的本地物理路径,第二个参数是保存在程序包里的路径。

打包

现在可以使用TFEncoder_Phar.php打包TFEncoder项目了。

8193395743b7753d.jpg

总结

可以看到我们使用php的phar打包工具可以制作一些常用的命令行程序,这些程序使用phar打包之后可以很方便的进行分享和部署了。