PHP编写扩展来调用动态链接库
几年前曾写过Java如何调用动态链接库,这次的任务是用PHP来调用本地动态链接库,这篇收录下方法,主要针对Linux系统。话不多说,快速进入主题。
准备动态链接库
具体可以参考这篇文章,这里不多说了。为了简便,这次我们写一个提供整数加法功能的库。
- 创建”add.h”头文件
#ifndef _HELLO_H_
#define _HELLO_H_
#ifdef __cplusplus
extern "C" {
#endif
int add(int, int);
#ifdef __cplusplus
}
#endif
#endif
- 创建”add.c”文件,写加法函数
#include "add.h"
int add(int a, int b)
{
return a + b;
}
编译生成”libadd.so”动态库
$ gcc add.c -fPIC -shared -o libadd.so
将动态库放到程序连接搜索路径中,这里说下方法(针对Ubuntu 18.04):
在”/etc/ld.so.conf.d”目录下新建一个”.conf”文件,将你要添加的搜索路径加到里面,一行一个。
执行
$ sudo /sbin/ldconfig
命令,这步很重要,是将库文件列表缓存到”etc/ld.so.cache”中。不执行的话,编译时没问题,但运行时会出错。
- 记得测试下,确保动态库没问题
编写PHP扩展
从PHP的官网下载与你PHP运行环境上版本对应的源代码,我本地环境是PHP 7.2.24,因此就下载了此版本的源码。
源码在本地解压,然后去ext目录下,执行以下命令,来创建一个扩展的框架。
$ ./ext_skel --extname=cadd
这里”cadd”是扩展名,为了同之前动态库使用的”add”名做区分,以免看代码晕了。执行成功后,你会看的下面的输出:
命令执行完,就会在当前目录下,创建一个名为”cadd”的子目录,里面包含了PHP扩展的基本文件。进入该目录。
打开”php_cadd.h”,在
#endif /* PHP_CADD_H */
上一行,加入代码PHP_FUNCTION(add);
,声明在PHP中可调的”add”函数。打开”cadd.c”,找到
PHP_FE(confirm_cadd_compiled, NULL) /* For testing, remove l ater. */
行,在下面加上PHP_FE(add, NULL)
,代码如下:
const zend_function_entry cadd_functions[] = {
PHP_FE(confirm_cadd_compiled, NULL) /* For testing, remove later. */
PHP_FE(add, NULL) /* 加在这里 */
PHP_FE_END /* Must be the last line in cadd_functions[] */
};
- 还是在”cadd.c”中,在上面这段代码的后面加上如下代码,这是PHP中”add”函数的执行内容,就是调用动态库中的”add”函数。
PHP_FUNCTION(add)
{
long int a, b; /* 必须用long int */
long int result;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ll", &a, &b) == FAILURE) {
return; /* 验证函数调用参数,错误则直接返回 */
}
result = add(a, b); /* 这里调动态库的函数 */
RETURN_LONG(result);
}
- 执行
$ phpize
,成功后看到如下输出。
- 打开”config.m4”,该文件中”dnl”即为注释符号,确保下图中16和18行没有注释。
- 生成Makefile,编译并部署
$ ./configure
$ make LDFLAGS=-ladd # 说明连接时需要add库
$ sudo make install # 部署时需要sudo
我是Ubuntu 18.04环境下的php7.2版本,会将当前”modules”子目录下的”cadd.so”自动复制到”/usr/lib/php/20170718/“目录下,也就是扩展库保存的位置。
PHP本地调用
在我Ubuntu 18.04环境下,PHP本地客户端的配置文件”php.ini”在”/etc/php/7.2/cli/php.ini”位置,如果你找不到,可以输入以下命令查找
$ php -ini | grep php.ini
修改”php.ini”,增加一行”extension=cadd.so”
$ php -m
命令可以查看所有客户端已加载的扩展,可以执行此命令确认”cadd”扩展是否已成功添加创建一个测试文件”test.php”,写入下面的测试代码
<?php echo "4 + 5 = ".add(4, 5); ?>
执行命令
$ php test.php
,看到输出的话,就恭喜你成功了。客户端成了,我们试试网页端访问。
PHP页面调用
在我的环境下”php-fpm”的配置文件在”/etc/php/7.2/fpm/php.ini”位置,如果找不到的话,可以通过页面调用
phpinfo()
,然后搜索”php.ini”查找。修改”php.ini”,增加一行”extension=cadd.so”,然后记得重启下”php-fpm”服务。
依然可以通过页面调用
phpinfo()
,查看所有已加载的扩展。在将上面的测试文件”test.php”放到web服务器中,并用浏览器打开看看吧。