一步步入門編寫PHP擴充套件

昌維發表於2019-05-14
PHP套件

1、寫在最前

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

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

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

2、解決一個問題

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

<?php

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 basic files: config.m4 config.w32 .svnignore array_square_sum.c php_array_square_sum.h CREDITS EXPERIMENTAL tests/001.phpt array_square_sum.php [done].

To use your new extension, you will have to execute the following steps:

  1. $ cd ..

  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. $ make

Repeat steps 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 repeat the last two steps as often as necessary.

  執行命令之後，終端告訴我們怎麼去生產新的擴充套件。檢視一下檔案內容，會發現多了幾個比較重要的檔案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-xr-x 3 liujun liujun 4096 Jan 29 15:40 ./
drwxr-xr-x 80 liujun liujun 4096 Jan 29 15:40 ../
-rw-r–r– 1 liujun liujun 5548 Jan 29 15:40 array_square_sum.c
-rw-r–r– 1 liujun liujun 532 Jan 29 15:40 array_square_sum.php
-rw-r–r– 1 liujun liujun 2354 Jan 29 15:40 config.m4
-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.h
-rw-r–r– 1 liujun liujun 16 Jan 29 15:40 .svnignore
drwxr-xr-x 2 liujun liujun 4096 Jan 29 15:40 tests/
3.2 配置檔案config.m4
dnl PHP_ARG_WITH(array_square_sum, for array_square_sum support,
dnl Make sure that the comment is aligned:
dnl [ –with-array_square_sum Include array_square_sum support])

  去掉dnl

PHP_ARG_WITH(array_square_sum, for array_square_sum support,
Make sure that the comment is aligned:
[ –with-array_square_sum Include array_square_sum support])

  這是./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,這個為我們以後實際呼叫的函式名字，當然你也可以直接加入函式confirm_array_square_sum，而不刪除confirm_array_square_sum_compiled。

PHP_FUNCTION(confirm_array_square_sum_compiled);

  該成

PHP_FUNCTION(array_square_sum);
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(confirm_array_square_sum_compiled,   NULL)       /* For testing, remove later. */
PHP_FE_END  /* Must be the last line in array_square_sum_functions[] */

};

  改成

const zend_function_entry array_square_sum_functions[] = {

PHP_FE(array_square_sum,    NULL)       /* For testing, remove later. */
PHP_FE_END  /* Must be the last line in array_square_sum_functions[] */

};

  然後最為關鍵的一個步驟，重寫confirm_array_square_sum，這個時候只需要把confirm_array_square_sum_compiled重寫成confirm_array_square_sum(3.1中沒有刪除confirm_array_square_sum_compiled，就需要加入confirm_array_square_sum就好了)。

PHP_FUNCTION(confirm_array_square_sum_compiled)

  重寫為

PHP_FUNCTION(array_square_sum)
{

zval* array_data;
HashTable *ht_data;
int ret;
char* key;
uint index;
zval **pdata;
double sum = 0;

if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &array_data) == FAILURE) {
    return;
}   

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

    if( Z_TYPE_P(*pdata) == IS_LONG){
        sum +=  Z_LVAL_P(*pdata) *  Z_LVAL_P(*pdata);
    }else {
        RETURN_FALSE;
    }   
    zend_hash_move_forward(ht_data);
}   
zend_hash_internal_pointer_end(Z_ARRVAL_P(array_data));
RETVAL_DOUBLE(sum);

}

  php是一個弱型別語言，他的資料都存在結構體zval裡面(具體請看更加專業資料，如"php擴充套件開發.pdf")。

typedef union _zval {

long lval;
double dval;
struct {
    char *val;
    int len;
} str;
HashTable *ht;
zend_object_value obj;

} zval;

  為了獲得函式傳遞的引數，可以使用zend_parse_parameters()API函式。下面是該函式的原型：

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
Configuring for:
PHP Api Version: 20121113
Zend Module Api No: 20121212
Zend Extension Api No: 220121212

  可以發現array_square_sum出現可執行指令碼configure。

3.5 編譯

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

liujun@ubuntu:~/test/php-5.5.8/ext/array_square_sum$ ./configure –with-php-config=/home/liujun/php/bin/php-config

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

creating libtool
appending configuration tag “CXX” to libtool
configure: creating ./config.status
config.status: creating config.h
config.status: config.h is unchanged

  檢視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_square_sum.so
4、使用擴充套件
4.1、配置擴充套件

  修改php的配置php.ini，加入一下配置內容。

[array_square_sum]
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個數字求平方和。程式碼如下:

<?php

$data = array();
$max_index = 100000;
$test_time = 2000;
for($i=0; $i<$max_index; $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). "
";

$c_test_time_start = time();
c_test($test_time, $data);
$c_test_time_stop = time();
echo "php test time is ". ($c_test_time_stop - $c_test_time_start). "
";

function php_test($test_time, $test_data){
    for($i=0; $i<$test_time; $i++){
        $sum = 0;
        foreach($test_data as $data){
            $sum += $data * $data;
        }   
    }   
}   

function c_test($test_time, $test_data){
    for($i=0; $i<$test_time; $i++){
        $sum = array_square_sum($test_data);
    }   
}
  測試結果如下：

liujun@ubuntu:~/php$ ~/php/bin/php test.php
php test ext time is 30
php test time is 2

   可以看到擴充套件要比直接使用php快15倍。隨著業務邏輯變得更加複雜，這個差異化會越大。

 那麼直接使用c語言來做這個事情呢。下面也給一個程式碼來測試下（測試條件完全一致）：

include<stdio.h>

include<sys/time.h>

include<unistd.h>

define TEST_TIME 2000

define MAX_INDEX 100000

int main()
{

int data[MAX_INDEX];
double sum = 0;

for(int i=0; i<MAX_INDEX; i++){
    data[i] = i;
}   

struct timeval start;
struct timeval end;

gettimeofday(&start,NULL);

for(int i=0; i<TEST_TIME; i++){
    for(int j=0; j<MAX_INDEX; j++){
        sum += data[j] * data[j];
    }   
}   
gettimeofday(&end,NULL);

double time=(end.tv_sec-start.tv_sec) + (end.tv_usec-start.tv_usec) * 1.0 /1000000;
printf("total time is %lf
", time );
printf("sum time is %lf
", sum);
return 0;

}

  執行檢視效果，可以看出直接使用C的時間只有0.261746，是使用C擴充套件的13.09%，是直接使用php的0.87%。當然如果涉及到IO等複雜操作，C/C++會比php快上萬倍（測試過）。

liujun@ubuntu:~/php$ g++ test.cpp -O2 -o test
liujun@ubuntu:~/php$ ./test
total time is 0.261746
sum time is 36207007178615872.000000

  因此，在實際對效能要求非常高的服務，如索引、分詞等，可以使用C做一套底層服務，php去進行封裝呼叫。

相關文章