快速开发一个PHP扩展图文教程

时间：2011-02-11 来源：xiaokaizi

作者：heiyeluren
时间：2008-12-5
博客：http://blog.csdn.net/heiyeshuwu

本文通过非常快速的方式讲解了如何制作一个PHP 5.2 环境的扩展（PHP Extension），希望能够在图文的方式下让想快速学习的朋友了解一下制作过程。

需求：比如开发一个叫做 heiyeluren 的扩展，扩展里就一个函数 heiyeluren_test()，输入一个字符串，函数返回：Your input string: xxxxx。
要求：了解C/C++编程，熟悉PHP编程
环境：下载一份php对应版本的源码，我这里是 php-5.2.6，先正常安装php，假设我们的php安装在 /usr/local/php 目录，源码在 /root/soft/php/php-5.2.6/，现在开始！
步骤一：生成扩展框架

cd /root/soft/php/php-5.2.6/ext
./ext_skel --extname=heiyeluren
cd /root/soft/php/php-5.2.6/ext/heiyeluren
vi config.m4
打开文件后去掉 dnl ，获得下面的信息：
PHP_ARG_ENABLE(heiyeluren, whether to enable heiyeluren support,
[ --enable-heiyeluren Enable heiyeluren support])
保存退出.
(图01)

第二步：编写代码

vi php_heiyeluren.h
找到：PHP_FUNCTION(confirm_heiyeluren_compiled); ，新增一行：
PHP_FUNCTION(heiyeluren_test);
保存退出。
(图02)

vi heiyeluren.c
数组里增加我们的函数，找到 zend_function_entry heiyeluren_functions[]，增加：
PHP_FE(heiyeluren, NULL)
(图03)

再到 heiyeluren.c 文件最后面增加如下代码：
PHP_FUNCTION(heiyeluren_test)
{
char *arg = NULL;
int arg_len, len;
char *strg;

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE) {
return;
}

len = spprintf(&strg, 0, "Your input string: %s\n", arg);
RETURN_STRINGL(strg, len, 0);
}
保存退出。
(图04)

第三步：编译安装

cd /root/soft/php/php-5.2.6/ext/heiyeluren
/usr/local/php/bin/phpize
./configure --with-php-config=/usr/local/php/bin/php-config
make
make test
make install

现在看看是不是有个 /usr/local/php/lib/php/extensions/no-debug-non-zts-20060613/heiyeluren.so
编辑php.ini，把扩展加入进去：
vi /usr/local/php/lib/php.ini
在[PHP]模块下增加：
extension = heiyeluren.so
保存退出。
(图05)

注意：如果你不存在扩展文件目录，或者安装报错，那么可以自行建立这个目录，然后把扩展拷贝到目录下，然后记得把 php.ini 文件中的 extension_dir 修改为该目录：
extension_dir = "/usr/local/php/lib/php/extensions/no-debug-non-zts-20060613/"
(图06)

第四步：检查安装结果
现在看看模块加载了没有：
/usr/local/php/bin/php -m，应该会打印出：
[PHP Modules]
...
heiyeluren
...
[Zend Modules]

然后重启apache，输出 phpinfo() ，应该能够看到：
heiyeluren
heiyeluren support enabled
(图07)

看看函数是否存在并且调用，在web目录下建立：heiyeluren.php
<?php
echo "<pre>";
print_r(get_loaded_extensions());
print_r(get_extension_funcs('heiyeluren'));
echo heiyeluren_test('My first php extension');
echo "</pre>";
?>
访问apache，应该能够看到：
Array
(
...
[33] => heiyeluren
)
Array
(
[0] => confirm_heiyeluren_compiled
[1] => heiyeluren_test
)
Your input string: heiyeluren
(图08)

扩展制作成功！

补充：作者：blankyao

关于如何着手开发一个PHP扩展，大家可以去看下黑夜路人同学写的快速开发一个PHP扩展一文，这篇文章深入浅出的介绍了开发一个PHP扩展的基本流程，今天我就来总结下PHP扩展开发里面几个基本的宏和函数。

一、PHP_FUNCTION
用户空间和扩展之间的连接通过PHP_FUNCTION来完成，

PHP_FUNCTION(sample_hello_world)
{
php_printf(”Hello World!\n”);
}

PHP_FUNCTION()宏和普通的c函数一样，它的定义为
#define PHP_FUNCTION(name) void zif_##name(INTERNAL_FUNCTION_PARAMETERS)
在这里，可以写为下面的代码

void zif_sample_hello_world(zval *return_value, char return_value_used, zval *this_ptr TSRMLS_C)

二、function_entry
简单的声明函数是不够的，zend引擎需要知道函数的地址以及如何将函数名字导入用户空间

static function_entry php_sample_functions[] = {
PHP_FE(sample_hello_world, NULL)
{ NULL, NULL, NULL }
};

php_sample_functions向量要随着你向扩展中添加函数而增长，每一个函数都会是这个向量中的一部分。
考虑PHP_FE()宏，PHP_FE(sample_hello_world, NULL)展开后会是{ “sample_hello_world”, zif_sample_hello_world, NULL},
这样既提供了函数的名字，同时提供了指向它的实现函数的指针，地三个参数暗示一些信息比如某个特定的参数要以引用的方式传递。

三、zend_module_entry
现在已经有了对外的函数，但是还没有和zend引擎联系起来。你只要将function_entry类型的结构加入zend_module_entry这个类型的结构就可以了。

只会这些是不够的，你还需要了解一些PHP内核的机制，以及Zend Engine的机制。另外很重要的一点是，你需要有扎实的C语言基础，网上关于PHP扩展以及内核机制的内容不太多，大多数都是英文的，推荐大家阅读下 Sams.Extending.and.Embedding.PHP.一书，也是英文的。

今天就先介绍这点，不足之处，欢迎大家指教！