第二節(jié)：SAPI概述

_________________________________________________________________________________________________

簡(jiǎn)介：

一些與服務(wù)相關(guān)的操作都是通過(guò)SAPI接口實(shí)現(xiàn)。

這些內(nèi)置實(shí)現(xiàn)的物理位置在PHP源碼的SAPI目錄。

這個(gè)目錄存放了PHP對(duì)各個(gè)服務(wù)器抽象層的代碼，例如命令行程序的實(shí)現(xiàn)，Apache的mod_php模塊實(shí)現(xiàn)以及fastcgi的實(shí)現(xiàn)等等。

在各個(gè)服務(wù)器抽象層抽象層遵守著相同的約定，這里我們稱(chēng)之為SAPI接口。每個(gè)SAPI實(shí)現(xiàn)都是一個(gè)__sapi_module_struct結(jié)構(gòu)體變量。(SAPI接口)。在PHP的源碼中，當(dāng)需要調(diào)用服務(wù)器相關(guān)信息時(shí)，全部通過(guò)SAPI接口中對(duì)應(yīng)方法調(diào)用實(shí)現(xiàn)，而這對(duì)應(yīng)的方法在各個(gè)服務(wù)器抽象層實(shí)現(xiàn)時(shí)都會(huì)有各自的實(shí)現(xiàn)。

由于很多操作的通用性，有很大一部分的接口方法使用的默認(rèn)方法。

如圖2.4所示：為SAPI的簡(jiǎn)單示意圖。

第一層：上層調(diào)用

第二層：SAPI層

第三層：CGI/FASTCGI,Apache,Embed

以cgi模式和apache2服務(wù)器為例，他們的啟動(dòng)方法如下：

cgi_sapi_module.startup(&cgi_sapi_module)//cgi模式

cgi/cgi_main.c文件

apache2_sapi_module.startup(&apache2_sapi_module);//apache2服務(wù)器

apache2handler/sapi_apache2.c文件

這里的cgi_sapi_module是sapi_module_struct結(jié)構(gòu)體的靜態(tài)變量。它的startup方法執(zhí)行php_cgi_startup函數(shù)指針。在這個(gè)結(jié)構(gòu)體中除了startup函數(shù)指針，還有需要其它方法或字段，其部分定義如下：

struct _sapi_module_struct{

char*name;//名字(標(biāo)識(shí)用)

char*pretty_name;//更好理解的名字(自己翻譯的)

int(*startup)(struct _sapi_module_struct *sapi_module);//啟動(dòng)函數(shù)

int(*shutdown)(struct _sapi_module_struct *sapi_module);//關(guān)閉方法

int(*activate)(TSRMLS_D);//激活

int(*deactivate)(TSRMLS_D);//停用

int(*ub_write)(const char *str,unsigned int str_length TSRMLS_DC);//不緩存的寫(xiě)操作(unbuffered write)

void(*flush)(void *server_context);//flush

structstat *(*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,...);

int(*header_handler)(sapi_header_struct*sapi_header,sapi_header_op_enum op,sapi_headers_struct*sapi_headers TSRMLS_DC);//header 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 POSTdata

char*(*read_cookies)(TSRMLS_D);//read Cookies

void(*register_server_variables)(zval *track_vars_arrayTSRMLS_DC);

void(*log_message)(char *message);// log messages

time_t(*get_request_time)(TSRMLS_D)//request Time

void(*terminate_process)(TSRMLS_D);//child terminate

char*php_ini_path_voerride;//覆蓋的ini路徑

}

其中一些函數(shù)指針的說(shuō)明如下：

startup當(dāng)SAPI初始化時(shí)，首先會(huì)調(diào)用該函數(shù)。如果服務(wù)器處理多個(gè)請(qǐng)求時(shí)，該函數(shù)只調(diào)用一次。比如Apache的SAPI,它是以

mod_php5的Apache模塊的形式加載到Apache中的，在這個(gè)SAPI中，startup函數(shù)只在父進(jìn)程中創(chuàng)建一次，在其fork的子進(jìn)程不會(huì)調(diào)用。

activate 此函數(shù)會(huì)在每個(gè)請(qǐng)求開(kāi)始時(shí)調(diào)用，它會(huì)再次初始化每個(gè)請(qǐng)求前的數(shù)據(jù)結(jié)構(gòu)。

deactivate此函數(shù)會(huì)在每個(gè)請(qǐng)求結(jié)束時(shí)調(diào)用，它用來(lái)確保所有的數(shù)據(jù)都，以及釋放在activate中初始化的數(shù)據(jù)結(jié)構(gòu)。

shutdown關(guān)閉函數(shù)，它用來(lái)解釋所有的SAPI的數(shù)據(jù)結(jié)構(gòu)、內(nèi)存等。

ub_write不緩存的寫(xiě)操作(unbuffer

write),它是用來(lái)將PHP的數(shù)據(jù)輸出給客戶(hù)端，如在CLI模式下，其最終是調(diào)用fwrite實(shí)現(xiàn)向標(biāo)準(zhǔn)輸出輸出內(nèi)容；在Apache模塊中，它最終調(diào)用Apache提供的方法rwrite。

sapi_error 報(bào)告錯(cuò)誤用，大多數(shù)的SAPI都是使用的PHP的默認(rèn)實(shí)現(xiàn)php_error。

flush

刷新輸出，在CLI模式下通過(guò)使用C語(yǔ)言的庫(kù)函數(shù)fflush實(shí)現(xiàn)，在php_mode5模式下，使用Apache的提供的函數(shù)

rflush實(shí)現(xiàn)。

read_cookie

在SAPI激活時(shí)，程序會(huì)調(diào)用此函數(shù)，并且將此函數(shù)獲取的值賦值給SG(request_info).cookie_data。在CLI模式下，此函數(shù)會(huì)返回

NULL。

read_post 此函數(shù)和 read_cookie 一樣也是在

SAPI激活時(shí)調(diào)用，它與請(qǐng)求的方法相關(guān)，當(dāng)請(qǐng)求的方法是POST時(shí)，程序會(huì)操作$_POST,$_HTTP_RAW_POST_DATA等變量。

send_header 發(fā)送頭部信息，此方法一般的SAPI 都會(huì)定制，其所不同的是，有些的會(huì)調(diào)服務(wù)器自帶的(如

Apache),有些的需要你自己實(shí)現(xiàn)(如 FastCGI)

以上的這些結(jié)構(gòu)在服務(wù)器的捷控中實(shí)現(xiàn)中都有定義。如Apache2的定義：

static sapi_module_struct apache2_sapi_module = {

"apache2handler",

"Apache 2.0 Handler"

php_apache2_startup,// strartup

php_module_shutdown_wrapper,//shutdown

}

在PHP的源碼中實(shí)現(xiàn)了很多實(shí)現(xiàn)，比如IIS的實(shí)現(xiàn)以及一些非主流的Web服務(wù)器實(shí)現(xiàn)，其文件結(jié)構(gòu)如圖 2.5所示：

sapi

aolserver

apache

apache2filter

apache2hander

apache_hooks

caudium

cgi

cli

continuity

embed

isapi

litespeed

milter

nsapi

phttpd

pi3web

roxen

tests

thrrpd

tux

webjames

目前PHP內(nèi)置的很多SAPI實(shí)現(xiàn)都已不再維護(hù)或者變的有些非主流了，PHP社區(qū)目前正在考慮將一些SAPI移出代碼庫(kù)。社區(qū)對(duì)很多功能的考慮是除非真的非常必要，或者某些功能已近非常通用了，否則就在PECL庫(kù)中，例如非常流行的APC緩存擴(kuò)展將進(jìn)入核心代碼庫(kù)中。

整個(gè)SAPI類(lèi)似于一個(gè)面向?qū)ο笾械哪０娣椒Ｊ降膽?yīng)用。SAPI.c和SAPI.h文件所包含的一些函數(shù)就是模板方法模式中的抽象模板，各個(gè)服務(wù)器對(duì)于sapi_module的定義及相關(guān)實(shí)現(xiàn)則是一個(gè)個(gè)具體的模板。

這樣的結(jié)構(gòu)在PHP源碼中有多處使用，比如在PHP擴(kuò)展開(kāi)發(fā)中，每個(gè)擴(kuò)展都需要定義一個(gè)zend_module_enty結(jié)構(gòu)體。這個(gè)結(jié)構(gòu)體的作用與sapi_module_struct結(jié)構(gòu)體類(lèi)似，都是一個(gè)類(lèi)似模版方法模式的應(yīng)用。在PHP的生命周期中如果需要調(diào)用某個(gè)擴(kuò)展.

小節(jié)：

SAPI 就是抽象類(lèi)

php初學(xué)者---千鋒php課堂筆記