如何編寫一個獨立的 PHP 擴充套件

Scholer's Blog發表於2016-01-05
PHP套件

獨立的 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"

相關文章