摘要&引言 
PHP是當前應用非常廣泛的一門語言，從國外的Facebook、Twitter到國內的淘寶、騰訊、百度再到互聯網上林林總總的各種大中小型網站都能見到它的身影。PHP的成功，應該說很大程度上依賴于其開放的擴展API機制和豐富的擴展組件（PHP Extension），正是這些擴展組件使得PHP從各種數據庫操作到XML、JSON、加密、文件處理、圖形處理、Socket等領域無所不能。有時候開發人員可能需要開發自己的PHP擴展，當前PHP5的擴展機制是基于Zend API的，Zend API提供了豐富的接口和宏定義，加上一些實用工具，使得PHP擴展開發起來難度并不算特別大。本文將介紹關于PHP擴展組件開發的基本知識，并通過一個實例展示開發PHP擴展的基本過程。 

PHP擴展組件的開發過程在Unix和Windows環境下有所不同，但基本是互通的，本文將基于Unix環境（具體使用Linux）。閱讀本文需要簡單了解Unix環境、PHP和C語言的一些基礎知識，只要簡單了解就行，我會盡量不涉及太過具體的操作系統和語言特性，并在必要的地方加以解釋，以便讀者閱讀。 

本文的具體開發環境為Ubuntu 10.04 + PHP 5.3.3。 

下載PHP源代碼 
要開發PHP擴展，第一步要下載PHP源代碼，因為里面有開發擴展需要的工具。我下載的是PHP最新版本5.3.3，格式為tar.bz2壓縮包。下載地址為：http://cn.php.net/get/php-5.3.3.tar.bz2/from/a/mirror。 

下載后，將源代碼移動到合適的目錄并解壓。解壓命令為： 

復制代碼代碼如下:

tar -jxvf 源碼包名稱

若下載的是tar.gz壓縮包，解壓命令為 

復制代碼代碼如下:

tar -zxvf 源碼包名稱

解壓后，在源代碼目錄中有個ext目錄，這里便是和PHP擴展有關的目錄。進入目錄后用ls查看，可以看到許多已經存在的擴展。下圖是在我的環境下查看的結果： 

其中藍色的均是擴展包目錄，其中可以看到我們很熟悉的mysql、iconv和gd等等。而ext_skel是Unix環境下用于自動生成PHP擴展框架的腳本工具，后面我們馬上會用到，ext_skel_win32.php是windows下對應的腳本。 

開發自己的PHP擴展——say_hello 
下面我們開發一個PHP擴展：say_hello。這個擴展很簡單，只是接受一個字符串參數，然后輸出“Hello xxx!”。這個例子只是為了介紹PHP擴展組件的開發流程，不承擔實際功能。 

生成擴展組件框架 
PHP的擴展組件開發目錄和文件是有固定組織結構的，你可以隨便進入一個已有擴展組件目錄，查看其所有文件，我想你一定眼花繚亂了。當然你可以選擇手工完成框架的搭建，不過我相信你更希望有什么東西來幫你完成。上文提到的ext_skel腳本就是用來自動構建擴展包框架的工具。ext_skel的完整命令為： 

ext_skel --extname=module [--proto=file] [--stubs=file] [--xml[=file]] [--skel=dir] [--full-xml] [--no-help] 

作為初學者，我們不必了解所有命令參數，實際上，大多數情況下只需要提供第一個參數就可以了，也就是擴展模塊的名字。因此，我們在ext目錄中鍵入如下命令： 
./ext_skel --extname=say_hello 

（如果你希望詳細了解ext_skel的各項命令參數， 請參考這里）

這時再用ls查看，會發現多了一個“say_hello”目錄，進入這個目錄，會發現ext_skel已經為我們建立好了say_hello的基本框架，如下圖：

如果你懶得弄清楚PHP擴展包目錄結構的全部內容，那么里面有三個文件你必須注意：

config.m4：這是Unix環境下的Build System配置文件，后面將會通過它生成配置和安裝。

php_say_hello.h：這個文件是擴展模塊的頭文件。遵循C語言一貫的作風，這個里面可以放置一些自定義的結構體、全局變量等等。

say_hello.c：這個就是擴展模塊的主程序文件了，最終的擴展模塊各個函數入口都在這里。當然，你可以將所有程序代碼都塞到這里面，也可以遵循模塊化思想，將各個功能模塊放到不同文件中。

下面的內容主要圍繞這三個文件展開。

Unix Build System配置

開發PHP擴展組件的第一步不是寫實現代碼，而是要先配置好Build System選項。由于我們是在Linux下開發，所以這里的配置主要與config.m4有關。

關于Build System配置這一塊，要是寫起來能寫一大堆，而且與Unix系統很多東西相關，就算我有興趣寫估計大家也沒興趣看，所以這里我們從略，只揀關鍵地方說一下，關于config.m4更多細節可以參考這里。

打開生成的config.m4文件，內容大致如下：

復制代碼代碼如下:

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 

這個結構體可能看起來會讓人有點頭疼，不過我還是要解釋一下里面的內容。因為這就是PHP Extension的原型，如果不搞清楚，就沒法開發PHP Extension了。當然，我就不一一對每個字段進行解釋了，只揀關鍵的、這篇文章會用到的字段說，因為許多字段并不需要我們手工填寫，而是可以使用某些預定義的宏填充。

第7個字段“name”，這個字段是此PHP Extension的名字，在本例中就是“say_hello”。

第8個字段“functions”，這個將存放我們在此擴展中定義的函數的引用，具體結構不再分析，有興趣的朋友可以閱讀_zend_function_entry的源代碼。具體編寫代碼時這里會有相應的宏。

第9-12個字段分別是四個函數指針，這四個函數會在相應時機被調用，分別是“擴展模塊加載時”、“擴展模塊卸載時”、“每個請求開始時”和“每個請求結束時”。這四個函數可以看成是一種攔截機制，主要用于相應時機的資源分配、釋放等相關操作。

第13個字段“info_func”也是一個函數指針，這個指針指向的函數會在執行phpinfo()時被調用，用于顯示自定義模塊信息。

第14個字段“version”是模塊的版本。

（關于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”后的字段，所以現在我們還不用操心。而我們關心的幾個字段，也都填寫好或由宏生成好了，并且在“say_hello.c”的相應位置也生成了幾個函數的框架。這里要注意，幾個宏的參數均為“say_hello”，但這并不表示幾個函數的名字全為“say_hello”，C語言中也不可能存在函數名重載機制。實際上，在開發PHP Extension的過程中，幾乎處處都要用到Zend里預定義的各種宏，從全局變量到函數的定義甚至返回值，都不能按照“裸寫”的方式來編寫C語言，這是因為PHP的運行機制可能會導致命名沖突等問題，而這些宏會將函數等元素變換成一個內部名稱，但這些對程序員都是透明的（除非你去閱讀那些宏的代碼），我們通過各種宏進行編程，而宏則為我們處理很多內部的東西。

寫到這里，我們的任務就明了了：第一，如果需要在相應時機處理一些東西，那么需要填充各個攔截函數內容；第二，編寫say_hello的功能函數，并將引用添加到say_hello_functions中。

編寫phpinfo()回調函數

因為say_hello擴展在各個生命周期階段并不需要做操作，所以我們只編寫info_func的內容，上文說過，這個函數將在phpinfo()執行時被自動調用，用于顯示擴展的信息。編寫這個函數會用到四個函數：

php_info_print_table_start()——開始phpinfo表格。無參數。

php_info_print_table_header()——輸出表格頭。第一個參數是整形，指明頭的列數，然后后面的參數是與列數等量的(char*)類型參數用于指定顯示的文字。

php_info_print_table_row()——輸出表格內容。第一個參數是整形，指明這一行的列數，然后后面的參數是與列數等量的(char*)類型參數用于指定顯示的文字。

php_info_print_table_end()——結束phpinfo表格。無參數。

 

下面是“say_hello.c”中需要編寫的info_func的具體代碼：

復制代碼代碼如下:

/* {{{ PHP_MINFO_FUNCTION 
*/ 
PHP_MINFO_FUNCTION(say_hello) 
{ 
php_info_print_table_start(); 
php_info_print_table_header(2, "say_hello support", "enabled"); 
php_info_print_table_row(2, "author", "Zhang Yang"); /* Replace with your name */ 
php_info_print_table_end(); 

/* Remove comments if you have entries in php.ini 
DISPLAY_INI_ENTRIES(); 
*/ 
} 
/* }}} */ 

可以看到我們編寫了兩行內容、組件是否可用以及作者信息。 

編寫核心函數 
編寫核心函數，總共分為三步：1、使用宏PHP_FUNCTION定義函數體；2、使用宏ZEND_BEGIN_ARG_INFO和ZEND_END_ARG_INFO定義參數信息；3、使用宏PHP_FE將函數加入到say_hello_functions中。下面分步說明。 

使用宏PHP_FUNCTION定義函數體 

復制代碼代碼如下:

PHP_FUNCTION(say_hello_func) 
{ 
char *name; 
int name_len; 

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &name, &name_len) == FAILURE) 
{ 
return; 
} 
php_printf("Hello %s!", name); 

RETURN_TRUE; 
} 

上文說過，編寫PHP擴展時幾乎所有東西都不能裸寫，而是必須使用相應的宏。從上面代碼可以清楚看到這一點。總體來說，核心函數代碼一般由如下幾部分構成：

定義函數，這一步通過宏PHP_FUNCTION實現，函數的外部名稱就是宏后面括號里面的名稱。

聲明并定義局部變量。

解析參數，這一步通過zend_parse_parameters函數實現，這個函數的作用是從函數用戶的輸入棧中讀取數據，然后轉換成相應的函數參數填入變量以供后面核心功能代碼使用。zend_parse_parameters的第一個參數是用戶傳入參數的個數，可以由宏“ZEND_NUM_ARGS() TSRMLS_CC”生成；第二個參數是一個字符串，其中每個字母代表一個變量類型，我們只有一個字符串型變量，所以第二個參數是“s”；最后各個參數需要一些必要的局部變量指針用于存儲數據，下表給出了不同變量類型的字母代表及其所需要的局部變量指針。

參數解析完成后就是核心功能代碼，我們這里只是輸出一行字符，php_printf是Zend版本的printf。

最后的返回值也是通過宏實現的。RETURN_TRUE宏是返回布爾值“true”。

使用宏ZEND_BEGIN_ARG_INFO和ZEND_END_ARG_INFO定義參數信息

參數信息是函數所必要部分，這里不做深究，直接給出相應代碼：

復制代碼代碼如下:

ZEND_BEGIN_ARG_INFO(arginfo_say_hello_func, 0) 
ZEND_END_ARG_INFO() 

如需了解具體信息請閱讀相關宏定義。 

使用宏PHP_FE將函數加入到say_hello_functions中 
最后，我們需要將剛才定義的函數和參數信息加入到say_hello_functions數組里，代碼如下： 

復制代碼代碼如下:

const zend_function_entry say_hello_functions[] = { 
PHP_FE(say_hello_func, arginfo_say_hello_func) 
{NULL, NULL, NULL} 
}; 

這一步就是通過PHP_EF宏實現，注意這個數組最后一行必須是{NULL, NULL, NULL} ，請不要刪除。 

下面是編寫完成后的say_hello.c全部代碼： 

復制代碼代碼如下:

/* 
+----------------------------------------------------------------------+ 
| PHP Version 5 | 
+----------------------------------------------------------------------+ 
| Copyright (c) 1997-2010 The PHP Group | 
+----------------------------------------------------------------------+ 
| This source file is subject to version 3.01 of the PHP license, | 
| that is bundled with this package in the file LICENSE, and is | 
| available through the world-wide-web at the following url: | 
| http://www.php.net/license/3_01.txt | 
| If you did not receive a copy of the PHP license and are unable to | 
| obtain it through the world-wide-web, please send a note to | 
| license@php.net so we can mail you a copy immediately. | 
+----------------------------------------------------------------------+ 
| Author: | 
+----------------------------------------------------------------------+ 
*/ 

/* $Id: header 297205 2010-03-30 21:09:07Z johannes $ */ 

#ifdef HAVE_CONFIG_H 
#include "config.h" 
#endif 

#include "php.h" 
#include "php_ini.h" 
#include "ext/standard/info.h" 
#include "php_say_hello.h" 

/* If you declare any globals in php_say_hello.h uncomment this: 
ZEND_DECLARE_MODULE_GLOBALS(say_hello) 
*/ 

/* True global resources - no need for thread safety here */ 
static int le_say_hello; 

/* {{{ PHP_FUNCTION 
*/ 
PHP_FUNCTION(say_hello_func) 
{ 
char *name; 
int name_len; 

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &name, &name_len) == FAILURE) 
{ 
return; 
} 
php_printf("Hello %s!", name); 

RETURN_TRUE; 
} 

ZEND_BEGIN_ARG_INFO(arginfo_say_hello_func, 0) 
ZEND_END_ARG_INFO() 
/* }}} */ 

/* {{{ say_hello_functions[] 
* 
* Every user visible function must have an entry in say_hello_functions[]. 
*/ 
const zend_function_entry say_hello_functions[] = { 
PHP_FE(say_hello_func, arginfo_say_hello_func) 
{NULL, NULL, NULL} /* Must be the last line in say_hello_functions[] */ 
}; 
/* }}} */ 

/* {{{ 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, 
NULL, 
NULL, 
NULL, 
NULL, 
PHP_MINFO(say_hello), 
#if ZEND_MODULE_API_NO >= 20010901 
"0.1", /* Replace with version number for your extension */ 
#endif 
STANDARD_MODULE_PROPERTIES 
}; 
/* }}} */ 

#ifdef COMPILE_DL_SAY_HELLO 
ZEND_GET_MODULE(say_hello) 
#endif 

/* {{{ PHP_MINFO_FUNCTION 
*/ 
PHP_MINFO_FUNCTION(say_hello) 
{ 
php_info_print_table_start(); 
php_info_print_table_header(2, "say_hello support", "enabled"); 
php_info_print_table_row(2, "author", "Zhang Yang"); /* Replace with your name */ 
php_info_print_table_end(); 

/* Remove comments if you have entries in php.ini 
DISPLAY_INI_ENTRIES(); 
*/ 
} 
/* }}} */ 

編譯并安裝擴展 
在say_hello目錄下輸入下面命令： 

復制代碼代碼如下:

/usr/bin/phpize 
./configure 
make 
make install 

這樣就完成了say_hello擴展的安裝（如果沒有報錯的話）。

這時如果你去放置php擴展的目錄下，會發現多了一個say_hello.so的文件。如下圖所示：

下面就是將其加入到php.ini配置中，然后重啟Apache（如果需要的話）。這些都是PHP基本配置的內容，我就不詳述了。

擴展測試

如果上面順利完成，這時運行phpinfo()，應該能看到如下信息：

這說明擴展已經安裝成功了。然后我們編寫一個測試用PHP腳本：

復制代碼代碼如下:

<?php 
say_hello_func('Zhang Yang'); 
?> 

執行這個腳本，結果如下：

說明擴展已經正常工作了。

總結

這篇文章主要用示例方法介紹PHP Extension的開發基礎。在PHP的使用中，也許是因為需要支持新的組件（如新的數據庫），又或是業務需要或性能需要，幾乎都會遇到需要開發PHP擴展的地方。后續如果有機會，我會寫文章介紹一些關于擴展開發較為深入的東西，如擴展模塊生命周期、INI使用以及編寫面向對象的擴展模塊等等。
本文基于署名-非商業性使用 3.0許可協議發布，歡迎轉載或演繹，但是必須保留本文的署名張洋（包含鏈接），且不得用于商業用途。如您有任何疑問或者授權方面的協商，請與我聯系。