淺談PHP Extension的開發(fā)——基礎(chǔ)篇第1/2頁
PHP是當(dāng)前應(yīng)用非常廣泛的一門語言，從國外的Facebook、Twitter到國內(nèi)的淘寶、騰訊、百度再到互聯(lián)網(wǎng)上林林總總的各種大中小型網(wǎng)站都能見到它的身影。PHP的成功，應(yīng)該說很大程度上依賴于其開放的擴(kuò)展API機(jī)制和豐富的擴(kuò)展組件（PHP Extension），正是這些擴(kuò)展組件使得PHP從各種數(shù)據(jù)庫操作到XML、JSON、加密、文件處理、圖形處理、Socket等領(lǐng)域無所不能。有時候開發(fā)人員可能需要開發(fā)自己的PHP擴(kuò)展，當(dāng)前PHP5的擴(kuò)展機(jī)制是基于Zend API的，Zend API提供了豐富的接口和宏定義，加上一些實用工具，使得PHP擴(kuò)展開發(fā)起來難度并不算特別大。本文將介紹關(guān)于PHP擴(kuò)展組件開發(fā)的基本知識，并通過一個實例展示開發(fā)PHP擴(kuò)展的基本過程。
PHP擴(kuò)展組件的開發(fā)過程在Unix和Windows環(huán)境下有所不同，但基本是互通的，本文將基于Unix環(huán)境（具體使用Linux）。閱讀本文需要簡單了解Unix環(huán)境、PHP和C語言的一些基礎(chǔ)知識，只要簡單了解就行，我會盡量不涉及太過具體的操作系統(tǒng)和語言特性，并在必要的地方加以解釋，以便讀者閱讀。
本文的具體開發(fā)環(huán)境為Ubuntu 10.04 + PHP 5.3.3。
下載PHP源代碼
要開發(fā)PHP擴(kuò)展，第一步要下載PHP源代碼，因為里面有開發(fā)擴(kuò)展需要的工具。我下載的是PHP最新版本5.3.3，格式為tar.bz2壓縮包。下載地址為：http://cn.php.net/get/php-5.3.3.tar.bz2/from/a/mirror。
下載后，將源代碼移動到合適的目錄并解壓。解壓命令為：
若下載的是tar.gz壓縮包，解壓命令為
解壓后，在源代碼目錄中有個ext目錄，這里便是和PHP擴(kuò)展有關(guān)的目錄。進(jìn)入目錄后用ls查看，可以看到許多已經(jīng)存在的擴(kuò)展。下圖是在我的環(huán)境下查看的結(jié)果：
開發(fā)自己的PHP擴(kuò)展——say_hello
下面我們開發(fā)一個PHP擴(kuò)展：say_hello。這個擴(kuò)展很簡單，只是接受一個字符串參數(shù)，然后輸出“Hello xxx!”。這個例子只是為了介紹PHP擴(kuò)展組件的開發(fā)流程，不承擔(dān)實際功能。
生成擴(kuò)展組件框架
PHP的擴(kuò)展組件開發(fā)目錄和文件是有固定組織結(jié)構(gòu)的，你可以隨便進(jìn)入一個已有擴(kuò)展組件目錄，查看其所有文件，我想你一定眼花繚亂了。當(dāng)然你可以選擇手工完成框架的搭建，不過我相信你更希望有什么東西來幫你完成。上文提到的ext_skel腳本就是用來自動構(gòu)建擴(kuò)展包框架的工具。ext_skel的完整命令為：
ext_skel --extname=module [--proto=file] [--stubs=file] [--xml[=file]] [--skel=dir] [--full-xml] [--no-help]
作為初學(xué)者，我們不必了解所有命令參數(shù)，實際上，大多數(shù)情況下只需要提供第一個參數(shù)就可以了，也就是擴(kuò)展模塊的名字。因此，我們在ext目錄中鍵入如下命令：
./ext_skel --extname=say_hello
（如果你希望詳細(xì)了解ext_skel的各項命令參數(shù)， 請參考這里）
這時再用ls查看，會發(fā)現(xiàn)多了一個“say_hello”目錄，進(jìn)入這個目錄，會發(fā)現(xiàn)ext_skel已經(jīng)為我們建立好了say_hello的基本框架，如下圖：
如果你懶得弄清楚PHP擴(kuò)展包目錄結(jié)構(gòu)的全部內(nèi)容，那么里面有三個文件你必須注意：
config.m4：這是Unix環(huán)境下的Build System配置文件，后面將會通過它生成配置和安裝。
php_say_hello.h：這個文件是擴(kuò)展模塊的頭文件。遵循C語言一貫的作風(fēng)，這個里面可以放置一些自定義的結(jié)構(gòu)體、全局變量等等。
say_hello.c：這個就是擴(kuò)展模塊的主程序文件了，最終的擴(kuò)展模塊各個函數(shù)入口都在這里。當(dāng)然，你可以將所有程序代碼都塞到這里面，也可以遵循模塊化思想，將各個功能模塊放到不同文件中。
下面的內(nèi)容主要圍繞這三個文件展開。
Unix Build System配置
開發(fā)PHP擴(kuò)展組件的第一步不是寫實現(xiàn)代碼，而是要先配置好Build System選項。由于我們是在Linux下開發(fā)，所以這里的配置主要與config.m4有關(guān)。
關(guān)于Build System配置這一塊，要是寫起來能寫一大堆，而且與Unix系統(tǒng)很多東西相關(guān)，就算我有興趣寫估計大家也沒興趣看，所以這里我們從略，只揀關(guān)鍵地方說一下，關(guān)于config.m4更多細(xì)節(jié)可以參考這里。
打開生成的config.m4文件，內(nèi)容大致如下：
dnl $Id$
dnl config.m4 for extension say_hello
dnl Comments in this file start with the string 'dnl'.
dnl Remove where necessary. This file will not work
dnl without editing.
dnl If your extension references something external, use with:
dnl PHP_ARG_WITH(say_hello, for say_hello support,
dnl Make sure that the comment is aligned:
dnl [ --with-say_hello Include say_hello support])
dnl Otherwise use enable:
dnl PHP_ARG_ENABLE(say_hello, whether to enable say_hello support,
dnl Make sure that the comment is aligned:
dnl [ --enable-say_hello Enable say_hello support])
if test "$PHP_SAY_HELLO" != "no"; then
dnl Write more examples of tests here...
dnl # --with-say_hello -> check with-path
dnl SEARCH_PATH="/usr/local /usr" # you might want to change this
dnl SEARCH_FOR="/include/say_hello.h" # you most likely want to change this
dnl if test -r $PHP_SAY_HELLO/$SEARCH_FOR; then # path given as parameter
dnl SAY_HELLO_DIR=$PHP_SAY_HELLO
dnl else # search default path list
dnl AC_MSG_CHECKING([for say_hello files in default path])
dnl for i in $SEARCH_PATH ; do
dnl if test -r $i/$SEARCH_FOR; then
dnl SAY_HELLO_DIR=$i
dnl AC_MSG_RESULT(found in $i)
dnl fi
dnl done
dnl fi
dnl
dnl if test -z "$SAY_HELLO_DIR"; then
dnl AC_MSG_RESULT([not found])
dnl AC_MSG_ERROR([Please reinstall the say_hello distribution])
dnl fi
dnl # --with-say_hello -> add include path
dnl PHP_ADD_INCLUDE($SAY_HELLO_DIR/include)
dnl # --with-say_hello -> check for lib and symbol presence
dnl LIBNAME=say_hello # you may want to change this
dnl LIBSYMBOL=say_hello # you most likely want to change this
dnl PHP_CHECK_LIBRARY($LIBNAME,$LIBSYMBOL,
dnl [
dnl PHP_ADD_LIBRARY_WITH_PATH($LIBNAME, $SAY_HELLO_DIR/lib, SAY_HELLO_SHARED_LIBADD)
dnl AC_DEFINE(HAVE_SAY_HELLOLIB,1,[ ])
dnl ],[
dnl AC_MSG_ERROR([wrong say_hello lib version or lib not found])
dnl ],[
dnl -L$SAY_HELLO_DIR/lib -lm
dnl ])
dnl
dnl PHP_SUBST(SAY_HELLO_SHARED_LIBADD)
PHP_NEW_EXTENSION(say_hello, say_hello.c, $ext_shared)
fi
這個結(jié)構(gòu)體可能看起來會讓人有點頭疼，不過我還是要解釋一下里面的內(nèi)容。因為這就是PHP Extension的原型，如果不搞清楚，就沒法開發(fā)PHP Extension了。當(dāng)然，我就不一一對每個字段進(jìn)行解釋了，只揀關(guān)鍵的、這篇文章會用到的字段說，因為許多字段并不需要我們手工填寫，而是可以使用某些預(yù)定義的宏填充。
第7個字段“name”，這個字段是此PHP Extension的名字，在本例中就是“say_hello”。
第8個字段“functions”，這個將存放我們在此擴(kuò)展中定義的函數(shù)的引用，具體結(jié)構(gòu)不再分析，有興趣的朋友可以閱讀_zend_function_entry的源代碼。具體編寫代碼時這里會有相應(yīng)的宏。
第9-12個字段分別是四個函數(shù)指針，這四個函數(shù)會在相應(yīng)時機(jī)被調(diào)用，分別是“擴(kuò)展模塊加載時”、“擴(kuò)展模塊卸載時”、“每個請求開始時”和“每個請求結(jié)束時”。這四個函數(shù)可以看成是一種攔截機(jī)制，主要用于相應(yīng)時機(jī)的資源分配、釋放等相關(guān)操作。
第13個字段“info_func”也是一個函數(shù)指針，這個指針指向的函數(shù)會在執(zhí)行phpinfo()時被調(diào)用，用于顯示自定義模塊信息。
第14個字段“version”是模塊的版本。
（關(guān)于zend_module_entry更詳盡的介紹請參考這里）
介紹完以上字段，我們可以看看“say_hello.c”中自動生成的“say_hello_module_entry”框架代碼了。
/* {{{ say_hello_module_entry
*/
zend_module_entry say_hello_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
STANDARD_MODULE_HEADER,
#endif
"say_hello",
say_hello_functions,
PHP_MINIT(say_hello),
PHP_MSHUTDOWN(say_hello),
PHP_RINIT(say_hello), /* Replace with NULL if there's nothing to do at request start */
PHP_RSHUTDOWN(say_hello), /* Replace with NULL if there's nothing to do at request end */
PHP_MINFO(say_hello),
#if ZEND_MODULE_API_NO >= 20010901
"0.1", /* Replace with version number for your extension */
#endif
STANDARD_MODULE_PROPERTIES
};
/* }}} */
首先，宏“STANDARD_MODULE_HEADER”會生成前6個字段，“STANDARD_MODULE_PROPERTIES ”會生成“version”后的字段，所以現(xiàn)在我們還不用操心。而我們關(guān)心的幾個字段，也都填寫好或由宏生成好了，并且在“say_hello.c”的相應(yīng)位置也生成了幾個函數(shù)的框架。這里要注意，幾個宏的參數(shù)均為“say_hello”，但這并不表示幾個函數(shù)的名字全為“say_hello”，C語言中也不可能存在函數(shù)名重載機(jī)制。實際上，在開發(fā)PHP Extension的過程中，幾乎處處都要用到Zend里預(yù)定義的各種宏，從全局變量到函數(shù)的定義甚至返回值，都不能按照“裸寫”的方式來編寫C語言，這是因為PHP的運行機(jī)制可能會導(dǎo)致命名沖突等問題，而這些宏會將函數(shù)等元素變換成一個內(nèi)部名稱，但這些對程序員都是透明的（除非你去閱讀那些宏的代碼），我們通過各種宏進(jìn)行編程，而宏則為我們處理很多內(nèi)部的東西。
寫到這里，我們的任務(wù)就明了了：第一，如果需要在相應(yīng)時機(jī)處理一些東西，那么需要填充各個攔截函數(shù)內(nèi)容；第二，編寫say_hello的功能函數(shù)，并將引用添加到say_hello_functions中。
編寫phpinfo()回調(diào)函數(shù)
因為say_hello擴(kuò)展在各個生命周期階段并不需要做操作，所以我們只編寫info_func的內(nèi)容，上文說過，這個函數(shù)將在phpinfo()執(zhí)行時被自動調(diào)用，用于顯示擴(kuò)展的信息。編寫這個函數(shù)會用到四個函數(shù)：
php_info_print_table_start()——開始phpinfo表格。無參數(shù)。
php_info_print_table_header()——輸出表格頭。第一個參數(shù)是整形，指明頭的列數(shù)，然后后面的參數(shù)是與列數(shù)等量的(char*)類型參數(shù)用于指定顯示的文字。
php_info_print_table_row()——輸出表格內(nèi)容。第一個參數(shù)是整形，指明這一行的列數(shù)，然后后面的參數(shù)是與列數(shù)等量的(char*)類型參數(shù)用于指定顯示的文字。
php_info_print_table_end()——結(jié)束phpinfo表格。無參數(shù)。
相關(guān)文章
主要用下面這兩個方法fread和 fgets的區(qū)別大家需要注意下2008-07-07
這篇文章主要介紹了php版銀聯(lián)支付接口開發(fā)的方法,結(jié)合實例形式分析了php銀聯(lián)支付接口開發(fā)的具體流程與相關(guān)操作技巧,需要的朋友可以參考下2016-10-10
PHP多維數(shù)組遍歷方法(2種實現(xiàn)方法)
這篇文章主要介紹了PHP多維數(shù)組遍歷方法,實例分析了2種多維數(shù)組的遍歷技巧,包括簡單的foreach遍歷與遞歸操作遍歷實現(xiàn)方法,需要的朋友可以參考下2015-12-12
用php代碼生成卡號2008-04-04
這篇文章主要介紹了簡單了解PHP編程中數(shù)組的指針的使用,這里著重討論了賦值時指針的指向等使用時值得注意的地方,需要的朋友可以參考下2015-11-11
這篇文章主要介紹了PHP程序員必須知道的兩種日志,結(jié)合實例形式分析了php-fpm 慢日志及php-error 錯誤日志相關(guān)原理與使用技巧,需要的朋友可以參考下2020-05-05
CakePHP去除默認(rèn)顯示的標(biāo)題及圖標(biāo)的方法
使用cakephp框架時，在生成的html頁面里，總是有cakephp的標(biāo)志（上面有大大的標(biāo)題CakePHP Rapid Development，下面還有一個cakephp的圖標(biāo)），雖然是cakephp的東西，但放到自己的項目中看起來總是不順眼。2008-10-10
首先要提出的問題是，is_file真的可以替代file_exists使用嗎？答案是否定的。為什么？原因很簡單，is_file有緩存2014-03-03
php實現(xiàn)的樹形結(jié)構(gòu)數(shù)據(jù)存取類實例
這篇文章主要介紹了php實現(xiàn)的樹形結(jié)構(gòu)數(shù)據(jù)存取類,實例演示了以樹形數(shù)據(jù)結(jié)構(gòu)存取數(shù)據(jù)的實現(xiàn)方法,對于學(xué)習(xí)基于PHP的數(shù)據(jù)結(jié)構(gòu)有一定的參考借鑒價值,需要的朋友可以參考下2014-11-11
這篇文章主要介紹了PHP購物車類Cart.class.php定義與用法,結(jié)合實例形式給出了購物車類Cart.class.php的完整定義代碼并分析了相關(guān)的使用技巧,需要的朋友可以參考下2016-07-07