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 相关文章推荐
ajax php 实现写入数据库
Sep 02 PHP
PHP中的float类型使用说明
Jul 27 PHP
jQuery 源码分析笔记
May 25 PHP
UCenter 批量添加用户的php代码
Jul 17 PHP
PHP 实现类似js中alert() 提示框
Mar 18 PHP
PHP中is_dir()函数使用指南
May 08 PHP
CodeIgniter配置之config.php用法实例分析
Jan 19 PHP
php强大的时间转换函数strtotime
Feb 18 PHP
Yii2.0使用阿里云OSS的SDK上传图片、下载、删除图片示例
Sep 20 PHP
Yii框架日志记录Logging操作示例
Jul 12 PHP
php+websocket 实现的聊天室功能详解
May 27 PHP
one.php 多项目、函数库、类库 统一为一个版本的方法
Aug 24 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
如何对PHP程序中的常见漏洞进行攻击
2006/10/09 PHP
用Zend Encode编写开发PHP程序
2006/10/09 PHP
Windows平台实现PHP连接SQL Server2008的方法
2017/07/26 PHP
关于Javascript 的 prototype问题。
2007/01/03 Javascript
javascript 得到文件后缀名的思路及实现
2020/05/09 Javascript
php结合imgareaselect实现图片裁剪
2015/07/05 Javascript
JavaScript是如何实现继承的(六种方式)
2016/03/31 Javascript
原生js实现可拖动的登录框效果
2017/01/21 Javascript
深入理解Node.js中的进程管理
2017/03/13 Javascript
nodejs服务搭建教程 nodejs访问本地站点文件
2017/04/07 NodeJs
Javascript ES6中数据类型Symbol的使用详解
2017/05/02 Javascript
Webpack打包css后z-index被重新计算的解决方法
2017/06/18 Javascript
EasyUI的DataGrid绑定Json数据源的示例代码
2017/12/16 Javascript
js实现双人五子棋小游戏
2020/05/28 Javascript
Vue实现点击导航栏当前标签后变色功能
2020/08/19 Javascript
[01:00:53]OG vs IG 2018国际邀请赛小组赛BO2 第一场 8.18
2018/08/19 DOTA
python实现监控windows服务并自动启动服务示例
2014/04/17 Python
在Python的struct模块中进行数据格式转换的方法
2015/06/17 Python
Python实现将数据框数据写入mongodb及mysql数据库的方法
2018/04/02 Python
解决python中 f.write写入中文出错的问题
2018/10/31 Python
在python中对变量判断是否为None的三种方法总结
2019/01/23 Python
Python中的相关分析correlation analysis的实现
2019/08/29 Python
Python selenium爬取微博数据代码实例
2020/05/22 Python
python中setuptools的作用是什么
2020/06/19 Python
Sandro Paris美国官网:典雅别致的法国时尚服饰品牌
2017/12/26 全球购物
BabyBjörn婴儿背带法国官网:BabyBjorn法国
2018/06/16 全球购物
加利福尼亚州威尼斯的女性奢侈品设计师服装和概念店:Mona Moore
2018/09/13 全球购物
美国精油公司:Plant Therapy
2019/05/17 全球购物
英国最大的在线亚洲杂货店:Red Rickshaw
2020/03/22 全球购物
陈欧的广告词
2014/03/18 职场文书
车辆工程专业求职信
2014/04/28 职场文书
2014年节能减排工作总结
2014/12/06 职场文书
写给同学的新学期寄语
2015/02/27 职场文书
看雷锋电影观后感
2015/06/10 职场文书
MySQL 覆盖索引的优点
2021/05/19 MySQL
你真的会用Mysql的explain吗
2022/03/31 MySQL