如何編寫一個獨立的PHP擴展

??

獨立的 PHP 擴展可以獨立于 PHP 源碼之外進(jìn)行分發(fā)。要創(chuàng)建一個這樣的擴展，需要準(zhǔn)備好兩樣?xùn)|西：

• 配置文件 (config.m4)

• 你的模塊源碼

接下來我們來描述一下如果創(chuàng)建這些文件并組合起來。

立即學(xué)習(xí)“PHP免費學(xué)習(xí)筆記（深入）”；

準(zhǔn)備好系統(tǒng)工具

想要擴展能夠在系統(tǒng)上編譯并成功運行，需要準(zhǔn)備轉(zhuǎn)以下工具：

• GNU autoconf

• GNU automake

• GNU libtool

• GNU m4

以上這些都可以從 ftp://ftp.gnu.org/pub/gnu/ 獲取。

注：以上這些都是類 Unix 環(huán)境下才能使用的工具。

改裝一個已經(jīng)存在的擴展

為了顯示出創(chuàng)建一個獨立的擴展是很容易的事情，我們先將一個已經(jīng)內(nèi)嵌到 PHP 的擴展改成獨立擴展。安裝 PHP 并且執(zhí)行以下命令：

$ mkdir /tmp/newext
$ cd /tmp/newext

現(xiàn)在你已經(jīng)有了一個空目錄。我們將 mysql 擴展目錄下的文件復(fù)制過來：

$ cp -rp php-4.0.X/ext/mysql/* .
# 注：看來這篇 README 真的需要更新一下了
# PHP7 中已經(jīng)移除了 mysql 擴展部分

到這里擴展就完成了，執(zhí)行：

$ phpize

現(xiàn)在你可以獨立存放這個目錄下的文件到任何地方，這個擴展可以完全獨立存在了。

用戶在編譯時需要使用以下命令：

$ ./configure
?????? [--with-php-config=/path/to/php-config]
?????? [--with-mysql=MYSQL-DIR]
$ make install

這樣 MySQL 模塊就可以使用內(nèi)嵌的 MySQL 客戶端庫或者已安裝的位于 MySQL 目錄中的 MySQL。

注：意思是說想要編寫 PHP 擴展，你既需要已經(jīng)安裝了 PHP，也需要下載一份 PHP 源碼。

定義一個新擴展

我們給示例擴展命名為 “foobar”。

新擴展包含兩個資源文件：foo.c 和 bar.c還有一些頭文件，但這些不只重要）。

示例擴展不引用任何外部的庫這點很重要，因為這樣用戶就不需要特別指定一些編譯選項了）。

LTLIBRARY_SOURCES 選項用于指定資源文件的名字，你可以有任意數(shù)量的資源文件。

注：上面說的是 Makefile.in 文件中的配置選項，可以參考 xdebug。

修改 m4 后綴的配置文件

m4 配置文件可以指定一些額外的檢查。對于一個獨立擴展來說，你只需要做一些宏調(diào)用即可。

PHP_ARG_ENABLE(foobar,whether to enable foobar,
[? --enable-foobar??????????? Enable foobar])

if test "$PHP_FOOBAR" != "no"; then
? PHP_NEW_EXTENSION(foobar, foo.c bar.c, $ext_shared)
fi

PHP_ARG_ENABLE 會自動設(shè)置好正確的變量以保證擴展能夠被 PHP_NEW_EXTENSION 以共享模式啟動。

PHP_NEW_EXTENSION 的第一個參數(shù)是擴展的名稱，第二個參數(shù)是資源文件。第三個參數(shù) $ext_shared 是由 PHP_ARG_ENABLE/WITH 為 PHP_NEW_EXTENSION 設(shè)定的。

請始終使用 PHP_ARG_ENABLE 或 PHP_ARG_WITH 進(jìn)行設(shè)置。即使你不打算發(fā)布你的 PHP 模塊，這些設(shè)置也可以保證讓你的模塊和 PHP 主模塊的接口保持一體。

注：PHP_ARG_ENABLE 和 PHP_ARG_WITH 應(yīng)該是用于定義模塊是動態(tài)擴展還是靜態(tài)編譯進(jìn) PHP 中，就跟編譯 PHP 時使用的 --enable-xxx 和 --with-xxx 一樣。

創(chuàng)建資源文件

ext_skel 可以為你的 PHP 模塊創(chuàng)建一些通用的代碼，你也可以編寫一些基本函數(shù)定義和 C 代碼來處理函數(shù)的參數(shù)。具體信息可以查看 READNE.EXT_SKEL。

不要擔(dān)心沒有范例，PHP 中有很多模塊供你參考，選擇一個簡單的點開始，添加你自己的代碼。

注：ext_skel 可以生成好基本模塊需要的資源文件和配置文件，不需要自己創(chuàng)建。

修改自定義模塊

將 config.m4 文件和資源文件放到同一個目錄中，然后執(zhí)行 phpize PHP 4.0 以上的版本編譯 PHP 的時候都安裝了 phpize）。

如果你的 phpize 不在系統(tǒng)環(huán)境變量中，你需要指定絕對路徑，例如：

$ /php/bin/phpize

這個命令會自動復(fù)制必需的構(gòu)建文件到當(dāng)前目錄并根據(jù) config.m4 創(chuàng)建配置文件。

通過以上的步驟，你已經(jīng)有了一個獨立的擴展了。

安裝擴展

擴展可以通過以下命令編譯安裝：

$ ./configure
??????????? [--with-php-config=/path/to/php-config]
$ make install

給模塊添加共享支持

有時候獨立擴展需要是共享的已供其他模塊加載。接下來我會解釋如何給已經(jīng)創(chuàng)建好的 foo 模塊添加共享支持。

#ifdef COMPILE_DL_FOO
?? ZEND_GET_MODULE(foo)
?? #endif

這一段講的上面都提到過了，這里只是又強調(diào)了一下。

PECL 網(wǎng)站約定

如果你打算發(fā)布你的擴展到 PECL 的網(wǎng)站，需要考慮以下幾點：

#define PHP_FOO_VERSION "1.2.3"

?