PHP-X是我在2017年年初创建的一个新项目。这个项目的目标就是让有一定工作经验的PHP程序都能够具备扩展开发的能力

0x00 初衷

2012年开始编写swoole,现在算来已经有5个年头了。我发现编写一个 PHP 扩展这个工作非常艰难。PHP 程序员群体中,甚至可以说 100 人中都很难找出一个会编写 PHP 扩展的人来。PHP 官方对扩展开发者非常不友好,源代码中提供的Zend API极其难用,API复杂而且凌乱,充斥着各种宏的写法。Zend API坑非常多,普通开发者很容易踩到坑里。出现各种莫名其妙的core dump问题。Zend API几乎没有任何文档,开发者如果要真正掌握这项技能需要付出大量的学习时间。

于是我今年就冒出一个新的想法,基于我编写swoole扩展超过5年的经验,我试图在Zend APIC++之间建立一个包装层,让PHP扩展开发变得简单。有一定C++基础的PHPer都可以轻松得开发一个PHP扩展。

PHP-X这个项目就这样诞生了,开发只用了一个月的时间。它的开发效率非常高,在我公司中一个只工作了3年的 PHP 程序员,都可以做出一个扩展来。接下来陆续在公司的几个项目中进行了快速验证。在3个的时间里修复了大量崩溃和内存泄漏问题。目前稳定性、性能、健壮性均已达到工业级水准。

0x01 起步

PHP-X本身基于C++11开发,使用cmake进行编译配置。首先,你需要确定所有依赖项已安装好。包括:

  • gcc-4.8 或更高版本
  • php-7.0 或更高版本,需要php7-dev
  • cmake-2.8 或更高版本

然后安装PHP-X

git clone https://github.com/swoole/PHP-X.git
cd PHP-X
cmake .
make -j 4
sudo make install

未出现任何编译错误,会成功编译出libphpx.so,并安装到系统的lib目录。头文件会复制到系统的include目录。这时需要执行 sudo ldconfig刷新so文件缓存。

0x02 新建工程

使用任意开发工具,新建一个test.cc源文件。首先需要引入phpx.h头文件。然后使用using引入phpx的命名空间。PHP官方未使用C++,因此phpx直接使用了php作为命名空间。

#include <phpx.h>
using namespace std;
using namespace php;

创建扩展使用PHPX_EXTENSION宏来实现。在这宏中只需要new Extension即可创建扩展。构造方法接受2个参数,第一个是扩展的名称,第二个是扩展的版本号。在PHPX_EXTENSION宏中return这个扩展对象的指针。

PHPX_EXTENSION()
{
    Extension *ext = new Extension("test", "0.0.1");
    return ext;
}

这里必须使用 new Extension,而不能直接在栈上创建对象

0x03 增加函数

一个PHP扩展的主要作用就是提供扩展函数,扩展函数由于是用C/C++代码实现,因此它的性能会比PHP用户函数性能高几十甚至上百倍。在phpx中实现函数非常简单。使用PHPX_FUNCTION来实现扩展函数,然后调用Extension::registerFunction来注册扩展函数。

PHPX_FN是一个助手宏,实际上展开就是"cpp_hello_world", cpp_hello_world
PHPX_FUNCTION展开后,包含了2个变量,第一个是参数args,第二个是返回值retval
通过操作argsretval两个变量,就可以实现函数的输入和输出

这里我们的代码非常简单,cpp_test($str, $n),调用这个函数返回一个$n$str的数组。

#include <phpx.h>
using namespace std;
using namespace php;

//声明函数
PHPX_FUNCTION(cpp_test);

PHPX_EXTENSION()
{
    Extension *ext = new Extension("test", "0.0.1");
    ext->registerFunction(PHPX_FN(cpp_test));
    return ext;
}

//实现函数
PHPX_FUNCTION(cpp_test)
{
    //args[1] 就是这个扩展函数的第 2 个参数
    long n = args[1].toInt();
    
    //将返回值 retval 初始化为数组
    Array _array(retval);
    
    for(int i = 0; i < n; i++)
    {
        //args[0] 就是这个扩展函数的第 1 个参数
        //append 方法表示向数组中追加元素
        _array.append(args[0]);
    }
}

0x04 编译扩展

编写一个Makefile文件。内容如下:

PHP_INCLUDE = `php-config --includes`
PHP_LIBS = `php-config --libs`
PHP_LDFLAGS = `php-config --ldflags`
PHP_INCLUDE_DIR = `php-config --include-dir`
PHP_EXTENSION_DIR = `php-config --extension-dir`

test.so: test.cc
    c++ -DHAVE_CONFIG_H -g -o test.so -O0 -fPIC -shared test.cc -std=c++11 ${PHP_INCLUDE} -I${PHP_INCLUDE_DIR} -lphpx
    
install: test.so
    cp test.so ${PHP_EXTENSION_DIR}/
clean:
    rm *.so

php-config 这个工具是PHP提供的,使用php-config可以得到PHP的安装路径、头文件目录、扩展目录、其他额外的编译参数等等。

这个Makefile支持了3个指令,make编译,make clean清理,make install安装到扩展目录中。

这里可能需要root权限,使用sudo make install进行安装
直接从网页复制,可能会出现tab制表符被替换为空格,请手工编辑一下Makefile使用tab缩进
MacOS下需要在c++编译参数中增加-undefined dynamic_lookup

编写好之后执行make install,就会编译扩展并将扩展test.so安装到PHP的扩展目录中。这时需要修改php.ini加入extension=test.so加载扩展。

使用php -m来观察你的扩展是否正常加载。

php -m
[PHP Modules]
Core
ctype
curl
date
dom
fileinfo
filter
gd
hash
iconv
inotify
json
libxml
mbstring
mcrypt
memcached
mongodb
mysqli
mysqlnd
openssl
pcntl
pcre
PDO
pdo_mysql
pdo_sqlite
Phar
posix
redis
Reflection
session
SimpleXML
sockets
SPL
sqlite3
standard
swoole
test
tokenizer
xml
xmlreader
xmlwriter
yac
zlib
zmq

[Zend Modules]

这里看到test,表明你的扩展已经加载成功了,现在就可以调用cpp_test这个扩展函数了。

0x05 执行

编写一个test.php,内容为:

<?php
var_dump(cpp_test("hello", 3));

执行test.php

php test.php
array(3) {
  [0]=>
  string(5) "hello"
  [1]=>
  string(5) "hello"
  [2]=>
  string(5) "hello"
}

可以看到执行结果符合预期。那么恭喜你,现在你已经成功地开发了一个PHP扩展了。是不是很简单?

0x06 更多

上面的例子还比较简单,只是编写了一个扩展函数。要真正在实际项目中使用PHP-X你还有很多工作要做。

  • 需要C++的功底
  • 了解更多PHP-XAPI

另外配合使用EclipseIDE工具,可以实现API自动提示和补齐,开发起来会更顺手。

相比Zend APIPHP-X要简单易用地多了,相信你不会花太多时间就可以掌握此项技能。在接下来我会撰写更多教程,教大家如何使用PHP-X实现扩展类、资源、回调函数等更复杂的功能。

你可能感兴趣的文章

20 条评论
GenialX · 9月11日

类似的东西已经有了,如http://www.php-cpp.com/docume...。请教下,有什么优势么?

+11 回复

GlashütteOriginal · 9月11日

大佬很厉害

+3 回复

xxfaxy · 9月11日

非常不错,不过也不知道写个什么拓展好

+3 回复

和女神嗯嗯_丶 · 9月11日

编译扩展是高级PHPer的事,我只管用就成

+2 回复

2

过不了多久,你也就是高级PHPER

arvin丶阿亮 · 9月11日
Ma_Alex · 9月11日

这个屌 站在巨人的肩膀上 看远方 韩总加油

+2 回复

buff · 9月11日

希望php-x会像jQuery一样流行起来。峰哥加油。文档一定要写好点。之前网上很多人都说swoole文档不行。

+2 回复

cool_油 · 9月12日

峰哥,我按照你的教程一步步来。在编写好test.cc文件后,执行make install 总会报/usr/local/include/phpx.h:23:17: 致命错误:php.h:没有那个文件。
这个有点摸不着头绪,还望指点一下

+2 回复

3

需要php7-dev包 这个你确定下好了? 所有的依赖?

tradzero · 9月12日
2

确定安装好了所有的包,这个问题已经解决了。谢谢

cool_油 · 9月12日
徐飞 · 9月12日

目前我是一只小菜鸟…

+2 回复

3

小菜鸟+1

命中水ヽ · 9月12日
ganlen · 9月12日

老费劲了,直接换语言

+2 回复

kawais · 9月11日

和Zephir比如何?

+1 回复

gofounder · 9月12日

费老劲了 の直接转golang了 来吧 一起拥抱golang的beego或者Martini吧

+1 回复

2387041 · 5 天前

不会写扩展,是因为不会写c/cpp,又不是因为这个

+1 回复

kaibin · 9月11日

峰哥,php windows扩展生成呢?能生成吗?

回复

6

@kaibin 当然可以。

韩天峰 作者 · 9月11日
0

我想问一下写一个扩展的投入产出比有多大?仅仅是为了装逼就没有必要了。

pascal · 3 天前
RED65 · 1 天前

Unable to load dynamic library '/usr/lib64/php/modules/cpp_ext.so' - libphpx.so: cannot open shared object file: No such file or directory in Unknown on line 0

为什么我编译完是这样的

回复

载入中...
韩天峰 韩天峰

2k 声望

发布于专栏

Swoole开源项目

PHP的异步、并行、高性能网络通信引擎

165 人关注