PHP7擴展開發之Hello World

一、下載PHP源代碼

要開發PHP擴展，需要先下載PHP的源代碼，一方面是因為我們的擴展一般會用到PHP自身定義的函數和宏，另一方面我們可以利用官方提供的工具減少工作量。

我下載了PHP-7.0.2，地址是： http://cn2.php.net/get/php-7.0.2.tar.gz。

解壓源碼壓縮包， tar xzf php-7.0.2.tar.gz，我們現在只需要關注Zend和ext這兩個目錄。

Zend目錄里面包含了PHP的Zend Engine源代碼，有些函數和宏的定義我們需要在這里面簡單地看一下。

ext目錄里面包含了PHP原生的擴展，以及我們開發自己的擴展時可以利用的工具，Linux下使用ext_skel，Windows下使用ext_skel_win32.php

二、使用 ext_skel工具

我們可以在ext目錄下看到所有的PHP原生擴展，其中包括了熟悉的curl，json，mbstring，simplexml，sockets等擴展，還有很多沒有用過甚至沒有聽說過的擴展，不用在意這些，我們先打開我們最熟悉的curl來看看，有config.m4配置文件，有php_curl.h，curl_file.c等源代碼，還有一些中間文件，最后還有一個tests目錄，里面放的curl擴展的單元測試。重點關注 config.m4，php_curl.h，curl_file.c即可，最簡單的場景下這三個文件就是一個擴展的全部組成部分了。

打開隨便看一下，不算太復雜，但是自己寫一個類似的還是挺頭疼的，這時就需要用到我前面提到的ext_skel工具了。這個工具也在ext目錄下，我們執行一下，./ext_skel --help，可以看到若干參數，我們用到的只有--extname=module，這里填上自己開發的擴展名稱。想深入了解各個參數的作用可以看這里： http://php.net/manual/en/internals2.buildsys.skeleton.php

   
   
   
           

    
    
    
            
./ext_skel --extname=hello
   
   
   
           

ext目錄下多了一個hello目錄，我們后續的工作都在這個目錄下面，工具已經為我們自動生成了一些文件。

config.m4配置文件

開發PHP擴展，在寫C代碼之前，要先配置一下這里。我們打開可以看到詳細的注釋說明，dnl是注釋語法。

如果你的擴展用到了外部依賴，就配置--with-hello選項，否則配置--enable-hello選項，刪除這下面3行的del注釋

   
   
   
           

    
    
    
            
PHP_ARG_ENABLE(hello, whether to enable hello support,
    
    
    
            
Make sure that the comment is aligned:
    
    
    
            
[ --enable-hello Enable hello support])
   
   
   
           

PHP_ARG_WITH和PHP_ARG_ENABLE這兩個宏用來配置configure選項，一個配置需要外部依賴的，另一個配置不需要外部依賴的

配置好的內容，在后面執行configure --help時可以看到。

php_hello.h頭文件

類似於C語音的頭文件，包含了一些自定義的結構和函數聲明，在這個demo中暫時不需要改動

hello.c代碼文件

真正的邏輯代碼都在這個文件中，后面會詳細介紹。

三、編寫代碼

好了，到這一步我們終於要開始寫代碼了，打開hello.c文件。

整個擴展的入口是zend_module_entry這個結構，具體的定義可以在Zend目錄下的zend_modules.h文件中看到，一共有十幾個屬性，快速跳過，我們暫時只需要"hello world"。

   
   
   
           

    
    
    
            
zend_module_entry hello_module_entry = {
    
    
    
            
 STANDARD_MODULE_HEADER,
    
    
    
            
 "hello",
    
    
    
            
 hello_functions,
    
    
    
            
 PHP_MINIT(hello),
    
    
    
            
 PHP_MSHUTDOWN(hello),
    
    
    
            
 PHP_RINIT(hello), /* Replace with NULL if there's nothing to do at request start */
    
    
    
            
 PHP_RSHUTDOWN(hello), /* Replace with NULL if there's nothing to do at request end */
    
    
    
            
 PHP_MINFO(hello),
    
    
    
            
 PHP_HELLO_VERSION,
    
    
    
            
 STANDARD_MODULE_PROPERTIES
    
    
    
            
};
   
   
   
           

• STANDARD_MODULE_HEADER幫我們實現了前面6個屬性
  
• "hello"是擴展的名字
  
• hello_functions是擴展包含的全部方法的集合
  
• 后面5個宏分別代表5個擴展特定方法
  
• PHP_HELLO_VERSION是擴展的版本號，定義在頭文件中
  
• STANDARD_MODULE_PROPERTIES幫我們實現了剩下的屬性

暫時都不需要修改，知道這是一個入口就行。順着這個入口，我們繼續看怎么給擴展添加方法，在hello_functions[]方法數組中已經有了一個示例方法confirm_hello_compiled，我們參考它寫我們的方法hello_world

   
   
   
           

    
    
    
            
const zend_function_entry hello_functions[] = {
    
    
    
            
 PHP_FE(confirm_hello_compiled, NULL) /* For testing, remove later. */
    
    
    
            
 PHP_FE(hello_world, NULL)
    
    
    
            
 PHP_FE_END /* Must be the last line in hello_functions[] */
    
    
    
            
};
   
   
   
           

先在擴展的方法數組中添加上 hello_world ，然后再定義 hello_world 。找到 confirm_hello_compiled方法定義的地方，在它下面依葫蘆畫瓢， php_printf是Zend Engine中的printf方法。

   
   
   
           

    
    
    
            
PHP_FUNCTION(hello_world)
    
    
    
            
{
    
    
    
            
 php_printf("Hello World!\n");
    
    
    
            

    
    
    
            
 RETURN_TRUE;
    
    
    
            
}
   
   
   
           

四、編譯安裝

最后就是編譯安裝我們的擴展了，安裝過PHP擴展的同學不用看，沒有經驗的可以參考一下。

   
   
   
           

    
    
    
            
phpize
    
    
    
            
./configure
    
    
    
            
make
    
    
    
            
make install
   
   
   
           

現在PHP的擴展目錄中已經有了hello.so這個文件，在php.ini中添加上擴展的配置

    
    
    
            

     
     
     
             
extension = hello.so
    
    
    
            

五、測試

寫一個test.php方法，執行腳本就可以看到"Hello World!"

   
   
   
           

    
    
    
            
<?php
    
    
    
            
hello_world();
   
   
   
           

來自為知筆記(Wiz)