一步步入门编写PHP扩展

1、写在最前

  随着互联网飞速发展，lamp架构的流行，php支持的扩展也越来越多，这样直接促进了php的发展。

  但是php也有脚本语言不可避免的问题，性能比例如C等编译型语言相差甚多，所以在考虑性能问题的时候最好还是通过php扩展来解决。

  那么，怎么去做一个php扩展呢。下面从一个例子开始（本文章需要C基础）。

2、解决一个问题

  在一个系统中，如果经常要求一个数组的平方和，我们可以这么写。

<?php

function array_square_sum($data){
    $sum = 0;
    foreach($data as $value){
        $sum += $value * $value;
    }
    return $sum;
}
  实际执行的时候，php zend引擎会把这段话翻译成C语言，每次都需要进行内存分配。所以性能比较差。进而，基于性能上的考虑，我们可以编写一个扩展来做这个事情。

3、编写扩展

  构建一个扩展，至少需要2个文件。一个是Configulator文件，它会告诉编译器编译这个扩展至少需要哪些依赖库；第二个是实际执行的文件。

3.1 生成框架

  听起来很复杂，实际上有一个工具可以帮我们搞定一个扩展的框架。在php源代码里面有个工具ext_skel，他可以帮我们生成扩展框架。

[email protected]:~/test/php-5.5.8/ext$ ls ext_skel
ext_skel

  现在我们利用它生成扩展 array_square_sum。($表示提示符命令)

$ ./ext_skel --extname=array_square_sum
Creating directory array_square_sum
Creating basic files: config.m4 config.w32 .svnignore array_square_sum.c php_array_square_sum.h CREDITS EXPERIMENTAL tests/001.phpt array_square_sum.php [done].

To use your new extension, you will have to execute the following steps:

  1. $ cd ..
  2. $ vi ext/array_square_sum/config.m4
  3. $ ./buildconf
  4. $ ./configure --[with|enable]-array_square_sum
  5. $ make
  6. $ ./php -f ext/array_square_sum/array_square_sum.php
  7. $ vi ext/array_square_sum/array_square_sum.c
  8. $ make

Repeat steps 3-6 until you are satisfied with ext/array_square_sum/config.m4 and
step 6 confirms that your module is compiled into PHP. Then, start writing
code and repeat the last two steps as often as necessary.

  执行命令之后，终端告诉我们怎么去生产新的扩展。查看一下文件内容，会发现多了几个比较重要的文件config.m4, php_array_square_sum.h，array_square_sum.c，下面会一一叙述。

[email protected]:~/test/php-5.5.8/ext$ ll array_square_sum/
total 44
drwxr-xr-x 3 liujun liujun 4096 Jan 29 15:40 ./
drwxr-xr-x 80 liujun liujun 4096 Jan 29 15:40 ../
-rw-r--r-- 1 liujun liujun 5548 Jan 29 15:40 array_square_sum.c
-rw-r--r-- 1 liujun liujun 532 Jan 29 15:40 array_square_sum.php
-rw-r--r-- 1 liujun liujun 2354 Jan 29 15:40 config.m4
-rw-r--r-- 1 liujun liujun 366 Jan 29 15:40 config.w32
-rw-r--r-- 1 liujun liujun 16 Jan 29 15:40 CREDITS
-rw-r--r-- 1 liujun liujun 0 Jan 29 15:40 EXPERIMENTAL
-rw-r--r-- 1 liujun liujun 3112 Jan 29 15:40 php_array_square_sum.h
-rw-r--r-- 1 liujun liujun 16 Jan 29 15:40 .svnignore
drwxr-xr-x 2 liujun liujun 4096 Jan 29 15:40 tests/
3.2 配置文件config.m4
dnl PHP_ARG_WITH(array_square_sum, for array_square_sum support,
dnl Make sure that the comment is aligned:
dnl [ --with-array_square_sum Include array_square_sum support])

  去掉dnl

PHP_ARG_WITH(array_square_sum, for array_square_sum support,
Make sure that the comment is aligned:
[ --with-array_square_sum Include array_square_sum support])

  这是./configure时能够调用enable-sample选项的最低要求.PHP_ARG_ENABLE的第二个参数将在./configure处理过程中到达这个扩展的配置文件时显示. 第三个参数将在终端用户执行./configure --help时显示为帮助信息

3.3 头文件

  修改php_array_square_sum.h，把confirm_array_square_sum_compiled改成confirm_array_square_sum,这个为我们以后实际调用的函数名字，当然你也可以直接加入函数confirm_array_square_sum，而不删除confirm_array_square_sum_compiled。

PHP_FUNCTION(confirm_array_square_sum_compiled);

  该成

PHP_FUNCTION(array_square_sum);
3.3 源代码

  修改 array_square_sum.c，把confirm_array_square_sum_compiled改成confirm_array_square_sum，这个是注册这个扩展的函数，如果在3.2中直接加入了confirm_array_square_sum，在这一步也直接加入confirm_array_square_sum就可以了。

const zend_function_entry array_square_sum_functions[] = {

PHP_FE(confirm_array_square_sum_compiled,   NULL)       /* For testing, remove later. */
PHP_FE_END  /* Must be the last line in array_square_sum_functions[] */

};

  改成

const zend_function_entry array_square_sum_functions[] = {

PHP_FE(array_square_sum,    NULL)       /* For testing, remove later. */
PHP_FE_END  /* Must be the last line in array_square_sum_functions[] */

};

  然后最为关键的一个步骤，重写confirm_array_square_sum，这个时候只需要把confirm_array_square_sum_compiled重写成confirm_array_square_sum(3.1中没有删除confirm_array_square_sum_compiled，就需要加入confirm_array_square_sum就好了)。

PHP_FUNCTION(confirm_array_square_sum_compiled)

  重写为

PHP_FUNCTION(array_square_sum)
{

zval* array_data;
HashTable *ht_data;
int ret;
char* key;
uint index;
zval **pdata;
double sum = 0;

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &array_data) == FAILURE) {
    return;
}   

ht_data = Z_ARRVAL_P(array_data);
zend_hash_internal_pointer_reset(ht_data);
while ( HASH_KEY_NON_EXISTANT != (ret = zend_hash_get_current_key(ht_data, &key, &index, 0)) ) {
    ret = zend_hash_get_current_data(ht_data, &pdata);

    if( Z_TYPE_P(*pdata) == IS_LONG){
        sum +=  Z_LVAL_P(*pdata) *  Z_LVAL_P(*pdata);
    }else {
        RETURN_FALSE;
    }
    zend_hash_move_forward(ht_data);
}
zend_hash_internal_pointer_end(Z_ARRVAL_P(array_data));
RETVAL_DOUBLE(sum);

}

  php是一个弱类型语言，他的数据都存在结构体zval里面(具体请看更加专业资料，如"php扩展开发.pdf")。

typedef union _zval {

long lval;
double dval;
struct {
    char *val;
    int len;
} str;
HashTable *ht;
zend_object_value obj;

} zval;

  为了获得函数传递的参数，可以使用zend_parse_parameters()API函数。下面是该函数的原型：

zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, …);

 zend_parse_parameters()函数的前几个参数我们直接用内核里宏来生成便可以了，形式为：ZEND_NUM_ARGS() TSRMLS_CC，注意两者之间有个空格，但是没有逗号。从名字可以看出，ZEND_NUM_ARGS()代表这参数的个数。后面紧跟着是常见的参数类型（和C语言的printf类似），后面就是常见的参数列表。
 下表列出了常见的参数类型。

参数类型 对象C类型 说明
l long 整数
b bool 布尔
s char* 字符串
d double 浮点数
a array(zval*) 数组
z zval* 不确定性zval

  此外数组是一个大型的hashtable来实现的，所以zend_hash_get_current_key可以遍历数组，使用宏Z_LVAL_P(zval*)获得实际的值。最终可以将结果放入到sum里面。RETVAL_DOUBLE(value)也是一个宏，返回结果为double,值则为value，具体可以参见" php扩展开发.pdf".

  最终完成了这个主函数的开发。

3.4 生成configure文件

  然后执行 ~/php/bin/phpize

/home/liujun/php/bin/phpize
Configuring for:
PHP Api Version: 20121113
Zend Module Api No: 20121212
Zend Extension Api No: 220121212

  可以发现array_square_sum出现可执行脚本configure。

3.5 编译

  编译的时候最好带上php-config PATH，因为系统默认的php-config-path可能不是你目前使用的php路径。

[email protected]:~/test/php-5.5.8/ext/array_square_sum$ ./configure --with-php-config=/home/liujun/php/bin/php-config

  编译如果成功，终端会有如下提示：

creating libtool
appending configuration tag "CXX" to libtool
configure: creating ./config.status
config.status: creating config.h
config.status: config.h is unchanged

  查看array_square_sum目录的module目录，会发现里面生成array_square_sum.so，这个就是我们需要的扩展。

[email protected]:~/test/php-5.5.8/ext/array_square_sum$ ls modules/
array_square_sum.la array_square_sum.so
4、使用扩展
4.1、配置扩展

  修改php的配置php.ini，加入一下配置内容。

[array_square_sum]
extension=array_square_sum.so
4.2、加入module

  php的扩展一般在 $PHP_PATH/lib/php/extensions/no-debug-non-zts-yyyymmdd，如果找不到，请自行百度or Google. 里面有很多.so文件。 

  把3.5生产的array_sum_square.so拷贝进去即可。

  如果使用fastcgi模式，需要重启php，这样我们php就应该有扩展array_square_sum，具体可以通过查看phpinfo(不会请自行百度orGoogle).

4.2、编写代码

  既然说编写扩展可以提高运行效率，因此在这里，我们通过使用扩展和直接使用php代码来进行对比，测试性能。多次实验可以减少误差，所以进行2000次对100000个数字求平方和。代码如下:

<?php

$data = array();
$max_index = 100000;
$test_time = 2000;
for($i=0; $i<$max_index; $i++){
    $data[] = $i;
}   

$php_test_time_start = time();
php_test($test_time, $data);
$php_test_time_stop = time();
echo "php test ext time is ". ($php_test_time_stop - $php_test_time_start). "\n";

$c_test_time_start = time();
c_test($test_time, $data);
$c_test_time_stop = time();
echo "php test time is ". ($c_test_time_stop - $c_test_time_start). "\n";

function php_test($test_time, $test_data){
    for($i=0; $i<$test_time; $i++){
        $sum = 0;
        foreach($test_data as $data){
            $sum += $data * $data;
        }
    }
}   

function c_test($test_time, $test_data){
    for($i=0; $i<$test_time; $i++){
        $sum = array_square_sum($test_data);
    }
}
  测试结果如下：

[email protected]:~/php$ ~/php/bin/php test.php
php test ext time is 30
php test time is 2

   可以看到扩展要比直接使用php快15倍。随着业务逻辑变得更加复杂，这个差异化会越大。

 那么直接使用c语言来做这个事情呢。下面也给一个代码来测试下（测试条件完全一致）：

include<stdio.h>

include<sys/time.h>

include<unistd.h>

define TEST_TIME 2000

define MAX_INDEX 100000

int main()
{

int data[MAX_INDEX];
double sum = 0;

for(int i=0; i<MAX_INDEX; i++){
    data[i] = i;
}   

struct timeval start;
struct timeval end;

gettimeofday(&start,NULL);

for(int i=0; i<TEST_TIME; i++){
    for(int j=0; j<MAX_INDEX; j++){
        sum += data[j] * data[j];
    }
}
gettimeofday(&end,NULL);

double time=(end.tv_sec-start.tv_sec) + (end.tv_usec-start.tv_usec) * 1.0 /1000000;
printf("total time is %lf\n", time );
printf("sum time is %lf\n", sum);
return 0;

}

  执行查看效果，可以看出直接使用C的时间只有0.261746，是使用C扩展的13.09%，是直接使用php的0.87%。当然如果涉及到IO等复杂操作，C/C++会比php快上万倍（测试过）。

[email protected]:~/php$ g++ test.cpp -O2 -o test
[email protected]:~/php$ ./test
total time is 0.261746
sum time is 36207007178615872.000000

  因此，在实际对性能要求非常高的服务，如索引、分词等，可以使用C做一套底层服务，php去进行封装调用。

原文地址：https://www.cnblogs.com/jlfw/p/12590930.html

时间： 2024-10-05 00:32:33

一步步入门编写PHP扩展的相关文章

手动使用C/C++编写Lua扩展插件

最近在研究如何在Windows 下嵌入Lua来完成业务模块编写的时候 发现Lua的一些问题,首先Lua作为一门脚本语言,其灵活性和可扩展性是很高的,要不然Cocos2d-x中也不会嵌入他来编写业务逻辑,但是由于国内资料相当的少,很少有人去正八经研究完了之后 写一篇文章 来分享自己的成果,想要去深入理解应用一些东西得时候,显得很无力,很多Lua扩展都是直接写扩展库来完成,如果不理解原理甚至你都不会灵活运用,这就是本文写作的目的. 第一 我需要Lua嵌入我的应用程序,这一点很容易的做到. 第二 我需

怎样编写scrapy扩展

原创文章,链接:http://blog.csdn.net/u012150179/article/details/38226477 在scrapy使用过程中,很多情况下需要根据实际需求定制自己的扩展,小到实现自己的pipelines,大到用新的scheduler替换默认的scheduler. 扩展可以按照是否需要读取crawler大致分为两种,对于不需要读取的,比如pipelines的编写,只需要实现默认的方法porcess_item.需要读取的,如scheduler的编写又存在另外的方式. 1.

C++编写nodejs扩展实战

C++编写nodejs扩展实战 之前有用PHP写过根据IP地址查询IP归属地,后来改用C语言编写,效率果然大幅度提高,然后转化为PHP的扩展. 想起之前有过使用手机号码查询号码归属地,最近又有在研究nodejs,于是就使用C++编写了nodejs的扩展. 遇到的问题确实不少,记录下来,供大家参考: 1.字符编码的问题:nodejs对于gbk编码支持不够好,为了提高程序效率,先把IP归属地的资源转化为utf-8的编码,具体使用PHP脚本foreach使用iconv转换 2.参数传递的问题,很多程序

【转】编写Chrome扩展程序

Chrome的扩展程序很多,也很容易入门,可以来简单实现一下 看看 官方文档 或者翻译的文档:百度.360,慢慢就能实现出一个扩展程序来 每个扩展程序应用一般会包含: 一个manifest清单文件 html文件 js文件 其他文件等 可以看到,其实结构如同一般的页面,有共通之处. 一.了解Chrome扩展程序 Chrome扩展程序商店地址为:https://chrome.google.com/webstore/category/extensions?hl=zh-CN 访问Chrome浏览器中已安

pytorch 学习笔记之编写 C 扩展,又涨姿势了

pytorch利用CFFI 进行 C 语言扩展.包括两个基本的步骤(docs): 编写 C 代码: python 调用 C 代码,实现相应的 Function 或 Module. 在之前的文章中,我们已经了解了如何自定义 Module.至于 [py]torch 的 C 代码库的结构,我们留待之后讨论: 这里,重点关注,如何在 pytorch C 代码库高层接口的基础上,编写 C 代码,以及如何调用自己编写的 C 代码. 官方示例了如何定义一个加法运算(见 repo).这里我们定义ReLU函数(见

ReactJs入门---编写Hello World

React 起源于 Facebook 的内部项目,因为该公司对市场上所有 JavaScript MVC 框架,都不满意,就决定自己写一套,用来架设 Instagram 的网站.做出来以后,发现这套东西很好用,就在2013年5月开源了.由于 React 的设计思想极其独特,属于革命性创新,性能出众,代码逻辑却非常简单.所以,越来越多的人开始关注和使用,认为它可能是将来 Web 开发的主流工具. 下面写一个React入门的小案例--Hello World ReactJs下载非常简单,为了方便大家下载

编写JMeter扩展（1）编写采样器代码

Apache JMeter自带了许多的采样器供我们使用,而且能够满足大部分的测试需求.但是在实际使用过程中,难免需要针对项目自身的特点和需求对Apache JMeter进行扩展.虽然直接继承AbstractJavaSamplerClient即可编写Java采样器,但是其相对应的GUI界面不是很友好,或者我们想编写一个类似HTTP Request那样的sampler,该如何做呢?比如我们需要编写一个TLS的采样器,该采样器允许用户在发送TLS请求的时候制定TLS的版本,以及客户端证书等信息.请参考

k8s入门系列之扩展组件(一)DNS安装篇

DNS (domain name system),提供域名解析服务,解决了难于记忆的IP地址问题,以更人性可读可记忆可标识的方式映射对应IP地址. Cluster DNS扩展插件用于支持k8s集群系统中各服务之间发现与调用. 组件: ?SkyDNS 提供DNS解析服务 ?Etcd 存储DNS信息 ?Kube2sky 监听kubernetes,当有Service创建时,生成相应的记录到SkyDNS. 本文章的实验环境与<k8s入门系列之集群安装篇>介绍中一致.master(1) + node(4

SpringMVC入门--编写一个SpringMVC小程序

一.SpringMVC的优势 Spring 为展现层提供的基于 MVC 设计理念的优秀的Web 框架,是目前最主流的 MVC 框架之一.Spring3.0 后全面超越 Struts2,成为最优秀的 MVC 框架.Spring MVC 通过一  套 MVC 注解,让 POJO 成为处理请求的控制器,而无须实现任何接口.支持 REST 风格的 URL 请求(GET POST PUT DELTE).采用了松散耦合可插拔组件结构,比其他 MVC      框架更具扩展性和灵活性..二.编写一个简单的Sp