SAPI概述
在各個服務器抽象層之間遵守着相同的約定,這裏我們稱之爲SAPI接口。 每個SAPI實現都是一個_sapi_module_struct結構體變量。(SAPI接口)。 在PHP的源碼中,當需要調用服務器相關信息時,全部通過SAPI接口中對應方法調用實現, 而這對應的方法在各個服務器抽象層實現時都會有各自的實現。
cgi_sapi_module.startup(&cgi_sapi_module) // cgi模式 cgi/cgi_main.c文件
apache2_sapi_module.startup(&apache2_sapi_module);
// apache2服務器 apache2handler/sapi_apache2.c文件
這裏的cgi_sapi_module是sapi_module_struct結構體的靜態變量。 它的startup方法指向php_cgi_startup函數指針。在這個結構體中除了startup函數指針,還有許多其它方法或字段。 其部分定義如下:
struct _sapi_module_struct {
char *name; // 名字(標識用)
char *pretty_name; // 更好理解的名字(自己翻譯的)
int (*startup)(struct _sapi_module_struct *sapi_module); // 啓動函數
int (*shutdown)(struct _sapi_module_struct *sapi_module); // 關閉方法
int (*activate)(TSRMLS_D); // 激活
int (*deactivate)(TSRMLS_D); // 停用
int (*ub_write)(const char *str, unsigned int str_length TSRMLS_DC);
// 不緩存的寫操作(unbuffered write)
void (*flush)(void *server_context); // flush
struct stat *(*get_stat)(TSRMLS_D); // get uid
char *(*getenv)(char *name, size_t name_len TSRMLS_DC); // getenv
void (*sapi_error)(int type, const char *error_msg, ...); /* error handler */
int (*header_handler)(sapi_header_struct *sapi_header, sapi_header_op_enum op,
sapi_headers_struct *sapi_headers TSRMLS_DC); /* header handler */
/* send headers handler */
int (*send_headers)(sapi_headers_struct *sapi_headers TSRMLS_DC);
void (*send_header)(sapi_header_struct *sapi_header,
void *server_context TSRMLS_DC); /* send header handler */
int (*read_post)(char *buffer, uint count_bytes TSRMLS_DC); /* read POST data */
char *(*read_cookies)(TSRMLS_D); /* read Cookies */
/* register server variables */
void (*register_server_variables)(zval *track_vars_array TSRMLS_DC);
void (*log_message)(char *message); /* Log message */
time_t (*get_request_time)(TSRMLS_D); /* Request Time */
void (*terminate_process)(TSRMLS_D); /* Child Terminate */
char *php_ini_path_override; // 覆蓋的ini路徑
...
...
};
其中一些函數指針的說明如下:startup 當SAPI初始化時,首先會調用該函數。如果服務器處理多個請求時,該函數只會調用一次。 比如Apache的SAPI,它是以mod_php5的Apache模塊的形式加載到Apache中的, 在這個SAPI中,startup函數只在父進程中創建一次,在其fork的子進程中不會調用。
activate 此函數會在每個請求開始時調用,它會再次初始化每個請求前的數據結構。
deactivate 此函數會在每個請求結束時調用,它用來確保所有的數據都,以及釋放在activate中初始化的數據結構。
shutdown 關閉函數,它用來釋放所有的SAPI的數據結構、內存等。
ub_write 不緩存的寫操作(unbuffered write),它是用來將PHP的數據輸出給客戶端, 如在CLI模式下,其最終是調用fwrite實現向標準輸出輸出內容;在Apache模塊中,它最終是調用Apache提供的方法rwrite。
sapi_error 報告錯誤用,大多數的SAPI都是使用的PHP的默認實現php_error。
flush 刷新輸出,在CLI模式下通過使用C語言的庫函數fflush實現,在php_mode5模式下,使用Apache的提供的函數函數rflush實現。
read_cookie 在SAPI激活時,程序會調用此函數,並且將此函數獲取的值賦值給SG(request_info).cookie_data。 在CLI模式下,此函數會返回NULL。
read_post 此函數和read_cookie一樣也是在SAPI激活時調用,它與請求的方法相關,當請求的方法是POST時,程序會操作$_POST、$HTTP_RAW_POST_DATA等變量。
send_header 發送頭部信息,此方法一般的SAPI都會定製,其所不同的是,有些的會調服務器自帶的(如Apache),有些的需要你自己實現(如 FastCGI)。
以上的這些結構在各服務器的接口實現中都有定義。如Apache2的定義:
static sapi_module_struct apache2_sapi_module = {
"apache2handler",
"Apache 2.0 Handler",
php_apache2_startup, /* startup */
php_module_shutdown_wrapper, /* shutdown */
...
}
整個SAPI類似於一個面向對象中的模板方法模式的應用。 SAPI.c和SAPI.h文件所包含的一些函數就是模板方法模式中的抽象模板, 各個服務器對於sapi_module的定義及相關實現則是一個個具體的模板。
這樣的結構在PHP的源碼中有多處使用, 比如在PHP擴展開發中,每個擴展都需要定義一個zend_module_entry結構體。 這個結構體的作用與sapi_module_struct結構體類似,都是一個類似模板方法模式的應用。 在PHP的生命週期中如果需要調用某個擴展,其調用的方法都是zend_module_entry結構體中指定的方法, 如在上一小節中提到的在執行各個擴展的請求初始化時,都是統一調用request_startup_func方法, 而在每個擴展的定義時,都通過宏PHP_RINIT指定request_startup_func對應的函數。 以VLD擴展爲例:其請求初始化爲PHP_RINIT(vld),與之對應在擴展中需要有這個函數的實現:
PHP_RINIT_FUNCTION(vld) {
}
所以, 我們在寫擴展時也需要實現擴展的這些接口,同樣,當實現各服務器接口時也需要實現其對應的SAPI。