PHP扩展开发入门教程


Posted in PHP onFebruary 26, 2015

PHP扩展开发

我准备在此系列博文中总结我有关PHP扩展开发的学习和感悟,力图简单清晰地描述在Linux系统下开发一个PHP扩展应该具备的最基本知识。水平较低,难免有错误,望指出。

准备工作

首先要获取一份PHP源码(可以从Github上签出,或者到官网上下载最新的稳定版),然后编译之。为了加快编译速度,我们推荐禁用所有额外的扩展(使用--disable-all选项),但最好打开debug(使用--enable-debug选项)和线程安全(使用--enable-maintainer-zts),但要在发布扩展的时候关闭debug,视情况选择是否需要打开线程安全:

$ ./buildconf --force

$ ./configure --disable-all --enable-debug --enable-maintainer-zts

$ make

注意,我们没有指定--prefix选项(同时也没有make install),因为这不是必须的。注意查看输出信息,也许你需要安装一些依赖包才能成功编译PHP。

编译后的PHP的可执行程序在源码的sapi目录下,对应不同的宿主环境有不同的子目录,我们以后都主要使用cli(command line interface)环境,可以建一个别名方便引用:

$ alias php-dev=/usr/local/src/php-5.6.5/sapi/cli/php

有一些命令行选项是很有用的:

php-dev -h



# 打印帮助信息

php-dev -v




# 打印版本信息

php-dev --ini



# 打印配置信息        

php-dev -m




# 打印加载的模块信息

php-dev -i




# phpinfo

php-dev -r <code>


# 执行code里的代码

扩展骨架

PHP的所有官方扩展都在源码的ext目录下,我们自己写的扩展也可以放在该目录下。注意,该目录下有个名为ext_skel的shell脚本,它是用来生成PHP扩展骨架的,使用该脚本,可以帮我们快速创建PHP扩展:

$ ./ext_skel --extname=myext

上面的命令帮我们创建了一个名为myext的扩展,源码在myext目录下。不带任何参数的执行该脚本可以打印帮助信息,这样你可以查看到该脚本提供的更多选项。

接下来让我们完成我们的扩展。进入myext目录,编辑config.m4配置文件,找到PHP_ARG_ENABLE宏函数,去掉前面的dnl注释(共三行)。退回到源码根目录,重新执行buildconf、configure和make命令:

$ ./buildconf --force

$ ./configure --help | grep myext

    --enable-myext           Enable myext support

$ ./configure --disable-all --enable-myext --enable-debug --enable-maintainer-zts

$ make

注意,我们用./configure --help | grep myext打印了我们扩展的加载情况,如果看不到下面的输出,则说明我们的扩展没有配置成功,回头检查下config.m4文件。

这次编译应该非常快,因为大部分代码都已经编译过了。PHP还有另外一种编译扩展的方法(使用动态连接的方式,将扩展编译为.so的文件),不过我们推荐在开发扩展的时候使用静态编译,因为这样省去了在配置文件中加载扩展的步骤。

一切顺利的话,我们的第一个扩展就已经可以执行了:

$ php-dev -m | grep myext

myext

$ php-dev -r 'echo confirm_myext_compiled("myext") . "\n";'

Congratulations! You have successfully modified ext/myext/config.m4. Module myext is now compiled into PHP.

第一个命令显示了我们的扩展已经被加载。第二个命令执行了ext_skel扩展骨架自动为我们创建的函数。当然,这个函数毫无意义,不过我们可以很容易的把这个函数改编成hello world。

手动创建扩展

大部分教程都是以ext_skel扩展骨架为原型讲述扩展开发的,这种做法当然很方便快捷。但是我个人更喜欢纯手工开发扩展的方式,因为这样更容易理解其中的每一个细节。

手动创建扩展,先进入ext目录,创建我们的扩展目录myext2。有几个文件是必须的:config.m4,myext2.c和php_myext2.h。

首先,我们来编写配置文件config.m4:

PHP_ARG_ENABLE(myext2, whether to enable myext2 support,

[  --enable-myext2           Enable myext2 support])
if test "PHP_MYEXT2" != "no"; then

   PHP_NEW_EXTENSION(myext2, myext2.c, $ext_shared)

fi

config.m4其实是autoconf程序使用的配置文件,autoconf是autotools工具箱里重要的组成。完整介绍autoconf的用法是需要很长时间的,好在我们这里的用法非常简单。

PHP_ARG_ENABLE是PHP为autoconf定义的宏函数,myext2是它的第一个参数,指出了扩展的名字;后面两个参数只是在make和configure执行时用来显示的,所以我们可以随便写。[ ]在autoconf语法中的作用类似于双引号,用来包裹字符串(注意第二个参数中包含了空格,但是可以不用方括号起来)。还有第四个参数用来指明扩展默认是开启还是关闭(yes或no),默认是no。

下面三行其实就是shell语法,判断我们是否开启了PHP_MYEXT2扩展模块。如果开启了该扩展模块(--enable-myext2),则$PHP_MYEXT2变量的值不为no,因此执行PHP_NEW_EXTENSION宏。这个宏函数也是PHP为autoconf定义的扩展语法,第一个参数同样是扩展名称;第二个参数是扩展要编译的C文件,如果有多个,依次写下去就可以了(空格分隔);第三个参数固定是$ext_shared。

接下来编写php_myext2.h头文件,该文件的命名是PHP扩展的规范 — php_扩展名.h:

#ifndef PHP_MYEXT2_H

#define PHP_MYEXT2_H
extern zend_module_entry myext2_module_entry;

#define phpext_myext2_ptr &myext2_module_entry
#define PHP_MYEXT2_VERSION "0.1.0"
/* prototypes */

PHP_FUNCTION(hello);
#endif  /* PHP_MYEXT2_H */

这里主要的代码是定义了名为phpext_myext2_ptr的宏,PHP底层通过该宏来引用我们的扩展。可以看出,该宏的命名同样是有规范的 — phpext_扩展名_ptr。而myext2_module_entry是我们稍后要在.c文件里定义的结构体,它的命名也是规范的 — 扩展名_module_entry。

此外我们还定义了一个标识我们扩展版本号的宏和一个函数原型(通过PHP_FUNCTION宏,PHP_FUNCTION宏函数的参数是外部可使用的函数名),稍后我们会来实现这个函数。

最后来看下myext2.c文件的实现:

#include "php.h"

#include "php_myext2.h"
/* {{{ myext2_functions[]

 *

 * Every user visible function must have an entry in myext2_functions[].

 */

static const zend_function_entry myext2_functions[] = {

    PHP_FE(hello,       NULL)

    PHP_FE_END

};

/* }}} */
/* {{{ myext2_module_entry

 */

zend_module_entry myext2_module_entry = {

    STANDARD_MODULE_HEADER,

    "myext2",               /* module name */

    myext2_functions,       /* module functions */

    NULL,                   /* module initialize */

    NULL,                   /* module shutdown */

    NULL,                   /* request initialize */

    NULL,                   /* request shutdown */

    NULL,                   /* phpinfo */

    PHP_MYEXT2_VERSION,     /* module version */

    STANDARD_MODULE_PROPERTIES

};

/* }}} */
#ifdef COMPILE_DL_MYEXT2

ZEND_GET_MODULE(myext2)

#endif
/* {{{ proto void hello()

   Print "hello world!" */

PHP_FUNCTION(hello)

{

    php_printf("hello world!\n");

}

/* }}} */

对比下扩展骨架创建的.c文件就会发现,我们的.c文件非常的简单,其实这些对一个最基本的扩展来说就已经足够了。

上面的代码是简单而清晰的,大部分注释已经很具说明性了。我们再简要概括下:

1.开头包含我们要用到的头文件。php.h是必须的,它已经帮我们包含了我们会用到的绝大多数的标准库文件,比如stdio.h,stdlib.h等等。
2.myext2_functions定义了由我们要暴露出去的函数构成的结构体数组,每一个元素通过PHP_FE宏来指定。PHP_FE宏有两个参数,第一个是外部可使用的函数名,第二个是参数信息(这里我们简单使用了NULL),最后一个元素必须是PHP_FE_END。注意它的注释,再次强调,每一个要暴露给外部使用的函数,都必须在该结构体数组中有定义。
3.myext2_module_entry定义了我们的模块信息,它是一个结构体,大部分属性都已经通过注释给出了说明。注意中间的五个函数指针,我们都简单的置为了NULL,在后续的博文中会讲述它们的用法。
4.ZEND_GET_MODULE(myext2)宏函数是被ifdef宏包含的,所以说它是否调用是视情况而定的。至于什么情况下会被调用,什么情况下不会被调用,在后续的博文中会讲述。
5.最后几行代码我们实现了hello函数,它很简单,调用php_printf输出hello world!跟一个换行符,php_printf的用法和printf完全一样。
6.注释里的 {{{ 和 }}} 是为了方便vim等编辑器折叠而使用的,我们推荐你也这样来写注释。
这里面涉及了一些宏,比如PHP_FE,PHP_FE_END,PHP_FUNCTION等等,完整介绍这些宏要到后续的博文中才可以,眼下最简单的办法就是记住这些宏。

注意到我们每一个文件的命名,变量的命名,空格和缩进,以及注释等都是非常规范的,遵循这些规范,可以使我们编写的代码和PHP本身的代码更加契合,我们也推荐你使用这样的规范来开发PHP扩展。

最后,编译运行我们的扩展:

$ ./buildconf --force

$ ./configure --help | grep myext2

  --enable-myext2           Enable myext2 support

$ ./configure --disable-all --enable-myext2 --enable-debug --enable-maintainer-zts

$ make
$ php-dev -m | grep myext2

myext2

$ php-dev -r 'hello();'

hello world!
PHP 相关文章推荐
php正则
Jul 07 PHP
Win2003服务器安全加固设置--进一步提高服务器安全性
May 23 PHP
linux下安装php的memcached客户端
Aug 03 PHP
wamp安装后自定义配置的方法
Aug 23 PHP
php实现过滤表单提交中html标签的方法
Oct 17 PHP
PHP中imagick函数的中文解释
Jan 21 PHP
使用Appcan客户端自动更新PHP版本号(全)
Jul 31 PHP
php+ajax无刷新上传图片实例代码
Nov 17 PHP
WordPress中用于获取文章信息以及分类链接的函数用法
Dec 18 PHP
php简单随机字符串生成方法示例
Apr 19 PHP
php微信公众号开发之微信企业付款给个人
Oct 04 PHP
PHP函数积累总结
Mar 19 PHP
分享一则PHP定义函数代码
Feb 26 #PHP
php简单分页类实现方法
Feb 26 #PHP
PHP删除指定目录中的所有目录及文件的方法
Feb 26 #PHP
PHP获取文件相对路径的方法
Feb 26 #PHP
CentOS安装php v8js教程
Feb 26 #PHP
php设计模式之单例模式实例分析
Feb 25 #PHP
PHP实现一维数组转二维数组的方法
Feb 25 #PHP
You might like
windows7下php开发环境搭建图文教程
2015/01/06 PHP
PHP实现的无限分类类库定义与用法示例【基于thinkPHP】
2018/08/06 PHP
PHP字符串和十六进制如何实现互相转换
2020/07/16 PHP
utf-8编码引起js输出中文乱码的解决办法
2010/06/23 Javascript
JS去除数组重复值的五种不同方法
2013/09/06 Javascript
ajax请求乱码的解决方法(中文乱码)
2014/04/10 Javascript
基于promise.js实现nodejs的promises库
2014/07/06 NodeJs
深入分析jquery解析json数据
2014/12/09 Javascript
基于jQuery.validate及Bootstrap的tooltip开发气泡样式的表单校验组件思路详解
2016/07/18 Javascript
angular基于路由控制ui-router实现系统权限控制
2016/09/27 Javascript
jquery插件bootstrapValidator表单验证详解
2016/12/15 Javascript
div中文字内容溢出常见的解决方法
2017/03/16 Javascript
快速理解 JavaScript 中的 LHS 和 RHS 查询的用法
2017/08/24 Javascript
详解webpack编译多页面vue项目的配置问题
2017/12/11 Javascript
angular4 JavaScript内存溢出问题
2018/03/06 Javascript
Vue 监听列表item渲染事件方法
2018/09/06 Javascript
node中的cookie的具体使用
2018/09/13 Javascript
JavaScript循环遍历你会用哪些之小结篇
2018/09/28 Javascript
JavaScript&quot;模拟事件&quot;的注意要点详解
2019/02/13 Javascript
node.js命令行教程图文详解
2019/05/27 Javascript
Vue Element UI + OSS实现上传文件功能
2019/07/31 Javascript
layui table复选框禁止某几条勾选的实例
2019/09/20 Javascript
JS实现简易计算器
2020/02/14 Javascript
TensorFlow 实战之实现卷积神经网络的实例讲解
2018/02/26 Python
Pandas时间序列:重采样及频率转换方式
2019/12/26 Python
利用CSS3的定位页面元素
2009/08/29 HTML / CSS
美国校园市场:OCM
2017/06/08 全球购物
阿迪达斯法国官方网站:adidas法国
2018/03/20 全球购物
美国领先的男士和女士内衣购物网站:Freshpair
2019/02/25 全球购物
大学生学习2014全国两会心得体会
2014/03/13 职场文书
给孩子的新年寄语
2014/04/08 职场文书
学校搬迁方案
2014/06/15 职场文书
车辆年审委托书范本
2014/09/18 职场文书
幼儿园中班教师个人总结
2015/02/05 职场文书
民事代理词范文
2015/05/25 职场文书
德劲DE1107指针试高灵敏度全波段收音机机评
2022/04/05 无线电