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

本文翻譯自 PHP 源碼中的 README.SELF-CONTAINED-EXTENSIONS。文中標記了 注 的內容均爲本身添加。內容有點老，也挺囉嗦，沒講什麼深刻的內容，可是能夠做爲入門學習參考。

獨立的 PHP 擴展能夠獨立於 PHP 源碼以外進行分發。要建立一個這樣的擴展，須要準備好兩樣東西：

• 配置文件 (config.m4)

• 你的模塊源碼

接下來咱們來描述一下若是建立這些文件並組合起來。

準備好系統工具

想要擴展可以在系統上編譯併成功運行，須要準備轉如下工具：

• GNU autoconf

• GNU automake

• GNU libtool

• GNU m4

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

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

改裝一個已經存在的擴展

爲了顯示出建立一個獨立的擴展是很容易的事情，咱們先將一個已經內嵌到 PHP 的擴展改爲獨立擴展。安裝 PHP 而且執行如下命令：

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

如今你已經有了一個空目錄。咱們將 mysql 擴展目錄下的文件複製過來：

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

到這裏擴展就完成了，執行：

$ phpize

如今你能夠獨立存放這個目錄下的文件到任何地方，這個擴展能夠徹底獨立存在了。

用戶在編譯時須要使用如下命令：

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

這樣 MySQL 模塊就可使用內嵌的 MySQL 客戶端庫或者已安裝的位於 MySQL 目錄中的 MySQL。

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

定義一個新擴展

咱們給示例擴展命名爲 「foobar」。

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

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

LTLIBRARY_SOURCES 選項用於指定資源文件的名字，你能夠有任意數量的資源文件。

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

修改 m4 後綴的配置文件

m4 配置文件能夠指定一些額外的檢查。對於一個獨立擴展來講，你只須要作一些宏調用便可。

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 會自動設置好正確的變量以保證擴展可以被 PHP_NEW_EXTENSION 以共享模式啓動。

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

請始終使用 PHP_ARG_ENABLE 或 PHP_ARG_WITH 進行設置。即便你不打算髮布你的 PHP 模塊，這些設置也能夠保證讓你的模塊和 PHP 主模塊的接口保持一體。

注：PHP_ARG_ENABLE 和 PHP_ARG_WITH 應該是用於定義模塊是動態擴展仍是靜態編譯進 PHP 中，就跟編譯 PHP 時使用的 --enable-xxx 和 --with-xxx 同樣。

建立資源文件

ext_skel 能夠爲你的 PHP 模塊建立一些通用的代碼，你也能夠編寫一些基本函數定義和 C 代碼來處理函數的參數。具體信息能夠查看 READNE.EXT_SKEL。

不要擔憂沒有範例，PHP 中有不少模塊供你參考，選擇一個簡單的點開始，添加你本身的代碼。

注：ext_skel 能夠生成好基本模塊須要的資源文件和配置文件，不須要本身建立。

修改自定義模塊

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

若是你的 phpize 不在系統環境變量中，你須要指定絕對路徑，例如：

$ /php/bin/phpize

這個命令會自動複製必需的構建文件到當前目錄並根據 config.m4 建立配置文件。

經過以上的步驟，你已經有了一個獨立的擴展了。

安裝擴展

擴展能夠經過如下命令編譯安裝：

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

給模塊添加共享支持

有時候獨立擴展須要是共享的已供其餘模塊加載。接下來我會解釋如何給已經建立好的 foo 模塊添加共享支持。

1. 在 config.m4 文件中，使用 PHP_ARG_WITH/PHP_ARG_ENABLE 來設定擴展，這樣就能夠自動使用 --with-foo=shared[,..] 或 --enable-foo=shared[,..] 這樣的指令做爲編譯參數了。

2. 在 config.m4 文件中，使用 PHP_NEW_EXTENSION(foo,.., $ext_shared) 使擴展能夠被構建。

3. 添加如下代碼到你的 C 語言資源文件中：

   #ifdef COMPILE_DL_FOO
   ZEND_GET_MODULE(foo)
   #endif

這一段講的上面都提到過了，這裏只是又強調了一下。

PECL 網站約定

若是你打算髮布你的擴展到 PECL 的網站，須要考慮如下幾點：

1. 添加 LICENSE 或 COPYING 到 package.xml

2. 須要在擴展頭文件中定義好版本信息，這個宏會被 foo_module_entry 調用來聲明擴展版本：

   #define PHP_FOO_VERSION "1.2.3"

私博地址：http://0x1.im