自己开发PHP扩展

什么是 php 扩展

通俗说，PHP 扩展是增强 PHP 语言功能的插件。PHP 提供了编程语言的语法，比如分支、循环、函数、类等，这些是 PHP 本身所提供的。在某些情况下需要在 PHP 语言的基础上进行扩展，那么就需要通过 PHP 底层提供的数据结构和接口来开发 PHP 扩展，从而来补充或扩展 PHP 语言，使之更加的强大。当然了，PHP 本身就已经集成了一些基本的、强大的、优秀的 PHP 扩展。

PHP 扩展的好处

从上面的了解得知，PHP 扩展可以在 PHP 原有的基础上来扩展 PHP 的功能，使之更为的强大。另一方面，PHP 扩展可以通过“插件式”的方式来管理和维护 PHP 的功能，如果将全部的功能整合到 PHP 语言中，PHP 想必会过于臃肿，且又不够灵活。而有了扩展，就解决了这样的问题。

PHP 扩展的存在形式

在 linux 系统下，PHP 扩展以 .so 文件存在，在 windows 下以 .dll 文件存在。

什么时候使用 PHP 扩展

单独的使用 PHP 语言并不能满足所有的开发，比如在项目中使用 redis 或 MongoDB 时，就需要相应的 PHP 扩展，来增强 PHP 语言，让 PHP 可以来操作 Redis 或者 MongoDB，以完成更加功能强大的项目。

什么时候开发自己的 PHP 扩展

开发自己的 PHP 扩展是必须的么？其实不是。通常情况下，作为一个 PHPer 是不需要自己开发 PHP 扩展的，但是某些情况下可能是必须要开发 PHP 扩展的。比如，我就遇到了这样的问题。合作的第三方提供了 Windows 下的动态链接库文件（.dll 文件，非 COM 的 DLL 文件），而我又没有找到如何在 PHP 下加载调用 DLL 文件的方式，因此我需要写 PHP 扩展，通过 PHP 的扩展来加载和调用第三方提供的 DLL 文件。

开发自己的 PHP 扩展

在前面我已经提到了我遇到的问题，合作的第三方提供了 Windows 下的动态链接库文件，而我又没有找到 PHP 下加载和调用 DLL 文件的方式，因此决定自己编写 PHP 扩展来加载和调用第三方提供的 DLL 文件中的导出函数。以下，就是我对于搭建开发 PHP 扩展环境和编译 PHP 扩展源码的记录。

准备工具

首先说明一点，DLL 文件只能在 Windows 系统上运行，Linux 系统上是无法进行运行的。那么，我们这个扩展是不考虑 Linux 系统的，只考虑 Windows 系统即可。因此，准备的开发工具是 VS2015。起初，我在网上查找了一些资料，很多资料中都写到，在 Windows 下开发 PHP 扩展需要安装 CygWin，经过我自己的学习，可以告诉大家“不需要”。当然了，我们的扩展只在 Windows 系统上运行，如果需要在 Linux 系统上运行，是否需要 Cygwin 我就不得而知了。当然了，其他版本的 VS 也应该是可以的，只是我只测试了 VS2015 罢了。

下载 PHP 的源代码

除了需要安装 VS2015 以外，还需要下载 PHP 的源码，我下载的源码是 PHP 7.2 的源码。

下载 PHP 源码的地址是：https://windows.php.net/download/

打开该地址后，下载如下图所示的源代码：

 

在这里，下载 PHP 7.2 的源码，并注意在源码下面有一个 VC15 x64 的字样。

下载完的的文件为：php-7.2.20-src.zip

下载完源码进行解压，解压后的目录为：php-7.2.20-src

下载源码并不是一件复杂的事情，但是页面中有多个版本的源码可供下载，选择哪个有时也是比较纠结的问题，这里就下载 php7.2 的源码，因为我本地使用的就是 php7.2 的环境。

创建扩展

进入 php-7.2.20-srcext 目录下，在该目录下有一个名为 ext_skel_win32.php 的文件，在命令行中执行：

1 php ext_skel_win32.php --extname=loaddll

其中，loaddll 是要创建的扩展的名称。想要成功执行该命令，需要将 PHP 的可执行程序添加到环境变量中。

执行情况如下：

λ php ext_skel_win32.php --extname=loaddll
Creating directory loaddll
FIND: Parameter format not correct
chmod: missing operand after ‘644’
Try 'chmod --help' for more information.
FIND: Parameter format not correct
chmod: missing operand after ‘755’
Try 'chmod --help' for more information.
Creating basic files: config.m4 config.w32 .gitignore loaddll.c php_loaddll.h CREDITS EXPERIMENTAL tests/001.phpt loaddll.php [done].
To use your new extension, you will have to execute the following steps:
1. $ cd ..
2. $ vi ext/loaddll/config.m4
3. $ ./buildconf
4. $ ./configure --[with|enable]-loaddll
5. $ make
6. $ ./sapi/cli/php -f ext/loaddll/loaddll.php
7. $ vi ext/loaddll/loaddll.c
8. $ make
Repeat steps 3-6 until you are satisfied with ext/loaddll/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.

看到如上的输出提示，则说明我们创建的 PHP 扩展生成成功了。以上输出如下所示：

 

此时，在 ext 目录下生成了 loaddll 的目录，该目录是生成出的 PHP 的扩展模板，可以在模板的基础上进行开发。

使用 VS2015 创建扩展项目

打开 VS2015，我这里使用的是 VS2015，其他开发环境没有进行测试。

在 VS2015 中选择 “文件” -> “新建” -> “从现有代码创建项目”，来创建 PHP 扩展的解决方案，如下图：

 

选择了 “从现有代码创建项目” 后，会出现创建项目的向导，如下图：

 

直接点击 “下一步”，到如下图：

 

在此步骤，选择刚才生成的扩展模板的目录，然后填入项目名称，这里是“loaddll”，点击“下一步”，到达如下图：

 

此步骤选择DLL项目，点击下一步，到达如下图：

 

直接点击“下一步”，到达如下图：

 

点击“完成”，等待 VS2015 开始创建项目。

配置编译选项并编译项目

在 VS2015 生成项目完毕后，切换项目为 “Release”和“x64”的选项，如下图：

 

切换完成后，在项目上右键选择“属性”，如下图：

 

修改配置类型为 DLL，这样生成的目标文件扩展名自动变为 .dll，如下图所示：

 

选择“配置属性” -> “C/C++” -> “常规”，在“附加包含目录”中点击“编辑”来添加相关的目录，如下图：

 

这里需要包含的目录包括如下图的几个目录：

 

这里主要是添加了 PHP 源码的几个目录，因为编译 PHP 扩展的源码时需要 PHP 的底层内核数据结构进行支持，因此需要包含以上的目录。

选择“配置属性” -> “C/C++” -> “预处理器”，在“预处理器定义”中点击“编辑”来添加相关预处理指令，如下图：

 

在预处理中，HAVE_LOADDLL 中的 LOADDLL 是扩展的名称，COMPILE_DL_LOADDLL 中的 LOADDLL 同样也是扩展的名称，这个名称与最开始生成扩展模板时的名称应该一致。

编译源代码

把 php-7.2.20-srcwin32build 目录下的 config.w32.h.in 复制到 php-7.2.20-srcmain 目录下，并重命名为 config.w32.h，这个 .h 文件在编译时是需要的，但是在 php-7.2.20-srcmain 下并没有该文件，因此需要自己手动进行复制。

在 config.w32.h 中增加如下代码

1 #define PHP_COMPILER_ID "VC15" 

注意这里的 VC15 ，在下载源代码的时候，我们已经见到过这个标识了。

接着，从 PHP 的安装目录中复制 php7ts.lib 文件到 loaddll 目录下，注意，是从PHP 的安装目录中，而不是 PHP 源代码的目录中。

php7ts.lib 在目录 php7.2.10dev 目录下，我使用的是 wamp64 下的 php7.2.10，大家自己使用对应的 .lib 文件即可，当然，这个 .lib 文件也必须是 php7.2 的，因为我们下载的是 php7.2 的源码。

在项目的 resource Files 下添加 php7ts.lib 文件，添加该文件就比较简单了，同样是右键添加即可。

按下 F7 生成解决方案，如图：

 

看到“成功 1 个”文件以后，在目录 php-7.2.20-srcextloaddll\x64Release 下会生成一个 loaddll.dll 文件，这个文件就是我们的 PHP 扩展文件。

PHP 扩展的安装与测试

将VS2015 生成 loaddll.dll 重命名为 php_loaddll.dll ，将其拷贝到 PHP 环境的扩展中，我的路径是 phpphp7.2.10ext，想必熟悉 PHP 的应该都会添加 PHP 扩展。如下图：

 

在 php.ini 文件中增加配置，如下图：

 

使用 php -m 来查看是否有 loaddll.dll 模块，如下图：

 

phpinfo 查看，如下图：

 

通过上面可以看出，我们的 PHP 扩展已经正常安装了，接下来就需要测试我们的扩展是否可以运行了。

在 PHP 源码目录下 php-7.2.20-srcextloaddll 有一个 loaddll.php 的测试文件，在命令行下进行执行该命令：

1 php loaddll.php

输出内容如下：

1 λ php loaddll.php
2 Functions available in the test extension:
3 confirm_loaddll_compiled
4 
5 Congratulations! You have successfully modified ext/loaddll/config.m4. Module loaddll is now compiled into PHP.

如下图：

 

看到如上输出，说明该扩展的模板编译成功，可以继续开发实际的扩展模块了。

总结

很多时候，学习编程的第一步就是搭建环境，而往往搭建环境的过程中由于步骤过于复杂，而资料又没有傻瓜化的详细步骤，导致很多想要学习或入门的程序员连第一步都无法踏出。对于开发 PHP 扩展而言也是一样的。

如何通过 PHP 扩展来让 PHP 程序可以直接调用 DLL 中的函数，除了需要掌握 C 语言的知识以外，还需要掌握 Windows 程序设计的知识，本文就不再讨论了，因为有 C 语言的知识和 Windows 程序设计的知识，在 PHP 扩展中调用 DLL 并非难事。