如何編寫一個(gè)獨(dú)立的PHP擴(kuò)展
獨(dú)立的 PHP 擴(kuò)展可以獨(dú)立于 PHP 源碼之外進(jìn)行分發(fā)。要?jiǎng)?chuàng)建一個(gè)這樣的擴(kuò)展,需要準(zhǔn)備好兩樣?xùn)|西:
-
配置文件 (config.m4)
-
你的模塊源碼
接下來(lái)我們來(lái)描述一下如果創(chuàng)建這些文件并組合起來(lái)。
準(zhǔn)備好系統(tǒng)工具
想要擴(kuò)展能夠在系統(tǒng)上編譯并成功運(yùn)行,需要準(zhǔn)備轉(zhuǎn)以下工具:
-
GNU autoconf
-
GNU automake
-
GNU libtool
-
GNU m4
以上這些都可以從 ftp://ftp.gnu.org/pub/gnu/ 獲取。
注:以上這些都是類 Unix 環(huán)境下才能使用的工具。
改裝一個(gè)已經(jīng)存在的擴(kuò)展
為了顯示出創(chuàng)建一個(gè)獨(dú)立的擴(kuò)展是很容易的事情,我們先將一個(gè)已經(jīng)內(nèi)嵌到 PHP 的擴(kuò)展改成獨(dú)立擴(kuò)展。安裝 PHP 并且執(zhí)行以下命令:
$ mkdir /tmp/newext
$ cd /tmp/newext
現(xiàn)在你已經(jīng)有了一個(gè)空目錄。我們將 mysql 擴(kuò)展目錄下的文件復(fù)制過(guò)來(lái):
$ cp -rp php-4.0.X/ext/mysql/* .
# 注:看來(lái)這篇 README 真的需要更新一下了
# PHP7 中已經(jīng)移除了 mysql 擴(kuò)展部分
到這里擴(kuò)展就完成了,執(zhí)行:
$ phpize
現(xiàn)在你可以獨(dú)立存放這個(gè)目錄下的文件到任何地方,這個(gè)擴(kuò)展可以完全獨(dú)立存在了。
用戶在編譯時(shí)需要使用以下命令:
$ ./configure
[--with-php-config=/path/to/php-config]
[--with-mysql=MYSQL-DIR]
$ make install
這樣 MySQL 模塊就可以使用內(nèi)嵌的 MySQL 客戶端庫(kù)或者已安裝的位于 MySQL 目錄中的 MySQL。
注:意思是說(shuō)想要編寫 PHP 擴(kuò)展,你既需要已經(jīng)安裝了 PHP,也需要下載一份 PHP 源碼。
定義一個(gè)新擴(kuò)展
我們給示例擴(kuò)展命名為 “foobar”。
新擴(kuò)展包含兩個(gè)資源文件:foo.c 和 bar.c(還有一些頭文件,但這些不只重要)。
示例擴(kuò)展不引用任何外部的庫(kù)(這點(diǎn)很重要,因?yàn)檫@樣用戶就不需要特別指定一些編譯選項(xiàng)了)。
LTLIBRARY_SOURCES
選項(xiàng)用于指定資源文件的名字,你可以有任意數(shù)量的資源文件。
注:上面說(shuō)的是 Makefile.in 文件中的配置選項(xiàng),可以參考 xdebug。
修改 m4 后綴的配置文件
m4 配置文件可以指定一些額外的檢查。對(duì)于一個(gè)獨(dú)立擴(kuò)展來(lái)說(shuō),你只需要做一些宏調(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
會(huì)自動(dòng)設(shè)置好正確的變量以保證擴(kuò)展能夠被 PHP_NEW_EXTENSION
以共享模式啟動(dòng)。
PHP_NEW_EXTENSION
的***個(gè)參數(shù)是擴(kuò)展的名稱,第二個(gè)參數(shù)是資源文件。第三個(gè)參數(shù) $ext_shared
是由 PHP_ARG_ENABLE/WITH
為 PHP_NEW_EXTENSION
設(shè)定的。
請(qǐng)始終使用 PHP_ARG_ENABLE
或 PHP_ARG_WITH
進(jìn)行設(shè)置。即使你不打算發(fā)布你的 PHP 模塊,這些設(shè)置也可以保證讓你的模塊和 PHP 主模塊的接口保持一體。
注:PHP_ARG_ENABLE
和 PHP_ARG_WITH
應(yīng)該是用于定義模塊是動(dòng)態(tài)擴(kuò)展還是靜態(tài)編譯進(jìn) PHP 中,就跟編譯 PHP 時(shí)使用的 --enable-xxx
和 --with-xxx
一樣。
創(chuàng)建資源文件
ext_skel
可以為你的 PHP 模塊創(chuàng)建一些通用的代碼,你也可以編寫一些基本函數(shù)定義和 C 代碼來(lái)處理函數(shù)的參數(shù)。具體信息可以查看 READNE.EXT_SKEL。
不要擔(dān)心沒(méi)有范例,PHP 中有很多模塊供你參考,選擇一個(gè)簡(jiǎn)單的點(diǎn)開始,添加你自己的代碼。
注:ext_skel
可以生成好基本模塊需要的資源文件和配置文件,不需要自己創(chuàng)建。
修改自定義模塊
將 config.m4 文件和資源文件放到同一個(gè)目錄中,然后執(zhí)行 phpize
(PHP 4.0 以上的版本編譯 PHP 的時(shí)候都安裝了 phpize)。
如果你的 phpize 不在系統(tǒng)環(huán)境變量中,你需要指定絕對(duì)路徑,例如:
$ /php/bin/phpize
這個(gè)命令會(huì)自動(dòng)復(fù)制必需的構(gòu)建文件到當(dāng)前目錄并根據(jù) config.m4 創(chuàng)建配置文件。
通過(guò)以上的步驟,你已經(jīng)有了一個(gè)獨(dú)立的擴(kuò)展了。
安裝擴(kuò)展
擴(kuò)展可以通過(guò)以下命令編譯安裝:
$ ./configure
[--with-php-config=/path/to/php-config]
$ make install
給模塊添加共享支持
有時(shí)候獨(dú)立擴(kuò)展需要是共享的已供其他模塊加載。接下來(lái)我會(huì)解釋如何給已經(jīng)創(chuàng)建好的 foo 模塊添加共享支持。
-
在 config.m4 文件中,使用
PHP_ARG_WITH/PHP_ARG_ENABLE
來(lái)設(shè)定擴(kuò)展,這樣就可以自動(dòng)使用--with-foo=shared[,..]
或--enable-foo=shared[,..]
這樣的指令作為編譯參數(shù)了。 -
在 config.m4 文件中,使用
PHP_NEW_EXTENSION(foo,.., $ext_shared)
使擴(kuò)展可以被構(gòu)建。 -
添加以下代碼到你的 C 語(yǔ)言資源文件中:
#ifdef COMPILE_DL_FOO
ZEND_GET_MODULE(foo)
#endif
這一段講的上面都提到過(guò)了,這里只是又強(qiáng)調(diào)了一下。
PECL 網(wǎng)站約定
如果你打算發(fā)布你的擴(kuò)展到 PECL 的網(wǎng)站,需要考慮以下幾點(diǎn):
-
添加 LICENSE 或 COPYING 到 package.xml
-
需要在擴(kuò)展頭文件中定義好版本信息,這個(gè)宏會(huì)被
foo_module_entry
調(diào)用來(lái)聲明擴(kuò)展版本:
#define PHP_FOO_VERSION "1.2.3"