一步步入門編寫PHP擴展

1、寫在最前

隨著網路快速發展，lamp架構的流行，php支援的擴展也越來越多，這樣直接促進了php的發展。

但php也有腳本語言不可避免的問題，效能比例如C等編譯型語言相差甚多，所以在考慮效能問題的時候最好還是透過php擴充來解決。

那麼，怎麼做一個php擴充呢。下面從一個例子開始（本文章需要C基礎）。

2、解決一個問題

在一個系統中，如果常常要求一個陣列的平方和，我們可以這麼寫。

 function array_square_sum($data){
 $sum = 0;
 foreach($data as $value){
 $sum += $value * $value;
 }
 return $sum;
 }

實際執行的時候，php zend引擎會把這段話翻譯成C語言，每次都需要進行記憶體分配。所以效能比較差。進而，基於效能上的考慮，我們可以寫一個擴充來做這個事情。

3、寫擴充

建立一個擴展，至少需要2個檔案。一個是Configulator文件，它會告訴編譯器編譯這個擴充至少需要哪些依賴函式庫；第二個是實際執行的文件。

3.1 生成框架

聽起來很複雜，實際上有一個工具可以幫我們搞定一個擴充的框架。在php原始碼裡面有個工具ext_skel，他可以幫我們產生擴充框架。

liujun@ubuntu:~/test/php-5.5.8/ext$ ls ext_skel
ext_skel

現在我們利用它來產生擴充 array_square_sum。 ($表示提示符號指令)

$ ./ext_skel --extname=array_square_sum
Creating directory array_square_sum
Creating bas . .svnignore array_square_sum.c php_array_square_sum.h CREDITS EXPERIMENTAL tests/001.phpt array_square_sum.php [done].
2. $ vi ext/array_square_sum/config.m4
3. $ ./buildconf
4. $ ./configure --[with|enable]-array_square_sum
5 . $ make
6. $ ./php -f ext/array_square_sum/array_square_sum.php
7. $ vi ext/array_square_sum/array_square_sum.c
8. $. $. 3-6 until you are satisfied with ext/array_square_sum/config.m4 and
step 6 confirms that your module is compiled into PHP. Then, start writing
code and meeat the last s stesm. 🎜>

複製程式碼


 執行指令之後，終端告訴我們怎麼去生產新的擴充。檢視一下檔案內容，會發現多了幾個比較重要的檔案config.m4, php_array_square_sum.h，array_square_sum.c，下面會一一敘述。

liujun@ubuntu:~/test/php-5.5.8/ext$ ll array_square_sum/

total 44

drwxr-xjunlix 3 jun 4096 Jan 29 15:40 ./

-rw-r--r-- 1 liujun liujun 2354 Jan 29 15:40 config.
-rw-r--r-- 1 liujun liujun 366 Jan 29 15:40 config.w32
-rw-r--r-- 1 liujun liujun 16 Jan 29 15:40 CREDITS
 rw-r--r-- 1 liujun liujun 0 Jan 29 15:40 EXPERIMENTAL
-rw-r--r-- 1 liujun liujun 3112 Jan 29 15:40 php_array_square_sum.hdrwxr-xr-x 2 liujun liujun 4096 Jan 29 15:40 tests/

 >


3.2 設定檔config.m4

複製程式碼

複製程式碼

這是./configure時能夠呼叫enable-sample選項的最低要求.PHP_ARG_ENABLE的第二個參數將在./configure處理過程中到達這個擴充的設定檔時顯示. 第三個參數將在終端用戶執行./configure --help時顯示為幫助資訊

3.3 頭檔

修改php_array_square_sum.h，把confirm_array_square_sum_compiled改成confirm_array_square_sum,這個為我們以後實際呼叫的函式名字，當然你也可以直接加入函式碼_，

PHP_FUNCTION(confirm_array_square_sum_compiled);

複製程式碼

3.3 原始碼

修改 array_square_sum.c，把confirm_array_square_sum_compiled改成confirm_array_square_sum，這個是註冊這個擴充的函數，如果在3.2直接加入了confirm_array_square_sum，在這一步也直接加入了confirm_array_square_sum，在這一步驟也直接加入了這一步也可以。

};


複製程式碼

 const zend_function_entry array_square_sum_functions[] = {
 PHP_FE(array_square_sum, NULL) /* For testing, remove later. */
 PHP_FE_END /* Must bey last me_an 3m >

然後最關鍵的步驟，重寫confirm_array_square_sum，這個時候只要把confirm_array_square_sum_compiled重寫成confirm_array_square_sum(3.1沒有刪除confirm_array_square_sum_compilm_sum(3.1中沒有刪除了confirm_array_square_sum_compilm_sumre_sum_compilm_conf_s。

複製程式碼

複製程式碼

複製程式碼



複製碼
 重寫為




 PHP_FUNCTION(array_square_sum)
{
 zval* array_data; char* key;
 uint index;
 zval **pdata;
 double sum = 0;

 if (zend_parse_parameters(ZEND_NUM_ARGS(> if (zend_parse_parameters(ZEND_NUM_ARGS() TSRM_CCGS() TS_D.M. = FAILURE) {
 return;
 }

 ht_data = Z_ARRVAL_P(array_data);
 zend_hash_internal_pointer_reset(ht_data);
 zend_hash_internal_pointer_reset(ht_data);
 , &key , &index, 0)) ) {
 ret = zend_hash_get_current_data(ht_data, &pdata);

 if( Z_TYPE_P(*pdata) == IS_LONG){
 sum += Z_LVAL_Pf Z_LVAL_P(*pdata);

}

zend_hash_internal_pointer_end(Z_ARRVAL_P(array_data));

RETVAL_DOUBLE(sum );

}複製程式碼

具體請看更專業資料，如"php擴充開發.pdf

"
)。




typedef union _zval {
 long lval;

} zval;

複製程式碼

zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, …);複製程式碼 🎜>

zend_parse_parameters()函數的前幾個參數我們直接用內核裡宏來產生便可以了，形式為：ZEND_NUM_ARGS() TSRMLS_CC，注意兩者之間有個空格，但是沒有逗號。從名字可以看出，ZEND_NUM_ARGS()代表這參數的數量。後面緊跟著是常見的參數型別（和C語言的printf類似），後面就是常見的參數列表。
下表列出了常見的參數類型。

参数类型	对象C类型	说明
l	long	整数
b	bool	布尔
s	char*	字符串
d	double	浮点数
a	array(zval*)	数组
z	zval*	不确定性zval

另外數組是一個大型的hashtable來實現的，所以zend_hash_get_current_key可以遍歷數組，使用宏Z_LVAL_P(zval*)來獲得實際的值。最終可以將結果放入到sum裡面。 RETVAL_DOUBLE(value)也是一個宏，回傳結果為double,值則為value，具體可以參考" php擴充開發.pdf".

最後完成了這個主函數的開發。

3.4 產生configure檔

然後執行 ~/php/bin/phpize

/home/liujun/php/bin/phpize

複製程式碼

可以發現array_square_sum出現執行腳本configure。

3.5 編譯

編譯的時候最好帶php-config PATH，因為系統預設的php-config-path可能不是你目前使用的php路徑。

編譯如果成功，終端機會有以下提示：

creating libtool
appending configuration tag "CXX" to libtool
configure: creating ./config.status
config.status: creating config.h

看array_square_sum目錄的module目錄，會發現裡面產生array_square_sum.so，這就是我們需要的擴充功能。

liujun@ubuntu:~/test/php-5.5.8/ext/array_square_sum$ ls modules/
array_square_sum.la array_s modules/

4、使用擴充

4.1、設定擴充

修改php的設定php.ini，加入一下設定內容。

extension=array_square_sum.so

4.2、加入module

php的擴充一般在 $PHP_PATH/lib/php/extensions/no-debug-non-zts-yyyymmdd，如果找不到，請自行百度or Google. 裡面有很多.so檔。

把3.5生產的array_sum_square.so拷貝進去即可。

如果使用fastcgi模式，需要重啟php，這樣我們php就應該有擴充array_square_sum，具體可以透過查看phpinfo(不會請自行百度orGoogle).

4.2、寫程式

既然說編寫擴充功能可以提高運行效率，因此在這裡，我們透過使用擴充和直接使用php程式碼來進行對比，測試效能。多次實驗可以減少誤差，所以進行2000次對100000個數字求平方和。程式碼如下:

 $max_index = 100000;
 $test_time = 2000time = 100000;
 $test_time = 2000>; for($i=0; $i $data[] = $i;
 }

 $php_test_time_start = time();
 php_test( $test_time, $data);
 $php_test_time_stop = time();
 echo "php test ext time is ". ($php_test_time_stop - $php_test_time_start). "n";
 c_test($test_time, $data);
 $c_test_time_stop = time();
 echo "php test time is ". ($c_test_time_stop - $c_test_time_start). "n"; 🎜>
 function php_test($test_time, $test_data){
 for($i=0; $i $sum = 0;
 foreach($test_data as $data){
 $sum += $data * $data;
 }
 }
 }

 function c_test($test_time, $test_data){
 for ($i=0; $i            $sum = array_square_sum($test_data);
        }
    }


複製代碼

複製程式碼