深入理解PHP内核[读书笔记]--第二章:用户代码执行--SAPI概述

第二节:SAPI概述

_________________________________________________________________________________________________

简介:

一些与服务相关的操作都是通过SAPI接口实现。

这些内置实现的物理位置在PHP源码的SAPI目录。

这个目录存放了PHP对各个服务器抽象层的代码,例如命令行程序的实现,Apache的mod_php模块实现以及fastcgi的实现等等。

在各个服务器抽象层抽象层遵守着相同的约定,这里我们称之为SAPI接口。每个SAPI实现都是一个__sapi_module_struct结构体变量。(SAPI接口)。在PHP的源码中,当需要调用服务器相关信息时,全部通过SAPI接口中对应方法调用实现,而这对应的方法在各个服务器抽象层实现时都会有各自的实现。

由于很多操作的通用性,有很大一部分的接口方法使用的默认方法。

如图2.4所示:为SAPI的简单示意图。

第一层:上层调用

第二层:SAPI层

第三层:CGI/FASTCGI,Apache,Embed

以cgi模式和apache2服务器为例,他们的启动方法如下:

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

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路径

}

其中一些函数指针的说明如下:

startup当SAPI初始化时,首先会调用该函数。如果服务器处理多个请求时,该函数只调用一次。比如Apache的SAPI,它是以

mod_php5的Apache模块的形式加载到Apache中的,在这个SAPI中,startup函数只在父进程中创建一次,在其fork的子进程不会调用。

activate 此函数会在每个请求开始时调用,它会再次初始化每个请求前的数据结构。

deactivate此函数会在每个请求结束时调用,它用来确保所有的数据都,以及释放在activate中初始化的数据结构。

shutdown关闭函数,它用来解释所有的SAPI的数据结构、内存等。

ub_write不缓存的写操作(unbuffer

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,// strartup

php_module_shutdown_wrapper,//shutdown

}

在PHP的源码中实现了很多实现,比如IIS的实现以及一些非主流的Web服务器实现,其文件结构如图 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内置的很多SAPI实现都已不再维护或者变的有些非主流了,PHP社区目前正在考虑将一些SAPI移出代码库。社区对很多功能的考虑是除非真的非常必要,或者某些功能已近非常通用了,否则就在PECL库中,例如非常流行的APC缓存扩展将进入核心代码库中。

整个SAPI类似于一个面向对象中的模版方法模式的应用。SAPI.c和SAPI.h文件所包含的一些函数就是模板方法模式中的抽象模板,各个服务器对于sapi_module的定义及相关实现则是一个个具体的模板。

这样的结构在PHP源码中有多处使用,比如在PHP扩展开发中,每个扩展都需要定义一个zend_module_enty结构体。这个结构体的作用与sapi_module_struct结构体类似,都是一个类似模版方法模式的应用。在PHP的生命周期中如果需要调用某个扩展.

小节:

SAPI 就是抽象类

php初学者---千锋php课堂笔记

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,045评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,114评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,120评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,902评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,828评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,132评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,590评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,258评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,408评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,335评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,385评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,068评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,660评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,747评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,967评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,406评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,970评论 2 341

推荐阅读更多精彩内容