php中的ini配置原理详解
|
《PHP实例：php中的ini配置原理详解》要点： 使用php的同学都知道php.ini配置的生效会贯穿整个SAPI的生命周期.在一段php脚本的执行过程中,如果手动修改ini配置,是不会启作用的.此时如果无法重启apache或者nginx等,那么就只能显式的在php代码中调用ini_set接口.ini_set是php向我们提供的一个动态修改配置的函数,需要注意的是,利用ini_set所设置的配置与ini文件中设置的配置,其生效的时间范围并不相同.在php脚本执行结束之后,ini_set的设置便会随即失效.PHP实例 因此本文打算分两篇,第一篇阐述php.ini配置原理,第二篇讲动态修改php配置.PHP实例 php.ini的配置大致会涉及到三块数据,configuration_hash,EG(ini_directives)以及PG、BG、PCRE_G、JSON_G、XXX_G等.如果不清楚这三种数据的含义也没有关系,下文会详细解释.PHP实例 1,解析INI配置文件 由于php.ini需要在SAPI过程中一直生效,那么解析ini文件并据此来构建php配置的工作,必定是发生SAPI的一开始.换句话说,也就是必定发生在php的启动过程中.php需要任意一个实际的哀求到达之前,其内部已经生成好这些配置.PHP实例 反映到php的内核,即为php_module_startup函数.PHP实例 php_module_startup主要负责对php进行启动,通常它会在SAPI开始的时候被调用.btw,还有一个常见的函数是php_request_startup,它负责将在每个哀求到来的时刻进行初始化,php_module_startup与php_request_startup是两个标识性的动作,不过对他们进行分析并不在本文的探讨范围内.PHP实例 举个例子,当php挂接在apache下面做一个module,那么apache启动的时候,便会激活所有这些module,其中包括php module.在激活php module时,便会调用到php_module_startup.php_module_startup函数完成了茫茫多的工作,一旦php_module_startup调用结束就意味着,OK,php已经启动,现在可以接受哀求并作出响应了.PHP实例 在php_module_startup函数中,与解析ini文件相关的实现是：PHP实例
代码如下:
/* this will read in php.ini,set up the configuration parameters, ?? load zend extensions and register php function extensions ?? to be loaded later */ if (php_init_config(TSRMLS_C) == FAILURE) { ??? return FAILURE; } 可以看到,其实就是调用了php_init_config函数,去完成对ini文件的parse.parse工作主要进行lex&grammar分析,并将ini文件中的key、value键值对提取出来并保存.php.ini的格式很简单,等号左侧为key,右侧为value.每当一对kv被提取出来之后,php将它们存储到哪儿呢?答案就是之前提到的configuration_hash.PHP实例 static HashTable configuration_hash; 注意四点：PHP实例 第一,php_init_config不会做除了词法语法以外的任何校验.也就是说,假如我们在ini文件中添加一行 hello=world,只要这是一个格式正确的配置项,那么最终configuration_hash中就会包含一个键为hello、值为world的元素,configuration_hash最大限度的反映出ini文件.PHP实例 第二,ini文件允许我们以数组的形式进行配置.例如ini文件中写入以下三行：PHP实例
代码如下:
drift.arr[]=1 drift.arr[]=2 drift.arr[]=3 那么最终生成的configuration_hash表中,就会存在一个key为drift.arr的元素,其value为一个包含的1,2,3三个数字的数组.这是一种极为罕见的配置方法.PHP实例 第三,php还允许我们除了默认的php.ini文件(准确说是php-%s.ini)之外,另外构建一些ini文件.这些ini文件会被放入一个额外的目录.该目录由环境变量PHP_INI_SCAN_DIR来指定,当php_init_config解析完了php.ini之后,会再次扫描此目录,然后找出目录中所有.ini文件来分析.这些额外的ini文件中产生的kv键值对,也会被加入到configuration_hash中去.PHP实例 这是一个偶尔有用的特性,假设我们自己开发php的扩展,却又不想将配置混入php.ini,便可以另外写一份ini,并通过PHP_INI_SCAN_DIR告诉php该去哪儿找到它.当然,其缺点也显而易见,其需要设置额外的环境变量来支持.更好的解决办法是,开发者在扩展中自己调用php_parse_user_ini_file或zend_parse_ini_file去解析对应的ini文件.PHP实例 第四,在configuration_hash中,key是字符串,那么值的类型是什么?答案也是字符串(除了上述很特殊的数组).具体来说,比如下面的配置：PHP实例
代码如下:
display_errors = On log_errors = Off log_errors_max_len = 1024 ?那么最后configuration_hash中实际存放的键值对为：PHP实例
代码如下:
key: "display_errors" val : "1" key: "log_errors" key: "log_errors_max_len" 注意log_errors,其存放的值连"0"都不是,就是一个实实在在地空字符串.另外,log_errors_max_len也并非数字,而是字符串1024.PHP实例 分析至此,基本上解析ini文件相关的内容都说清楚了.简单总结一下：PHP实例 1,解析ini发生在php_module_startup阶段PHP实例 2,解析结果存放在configuration_hash里.PHP实例 2,配置作用到模块 php的大致结构可以看成是最下层有一个zend引擎,它负责与OS进行交互、编译php代码、提供内存托管等等,在zend引擎的上层,排列着很多很多的模块.其中最核心的就一个Core模块,其他还有比如Standard,PCRE,Date,Session等等...这些模块还有另一个名字叫php扩展.我们可以简单理解为,每个模块都会提供一组功能接口给开发者来调用,举例来说,常用的诸如explode,trim,array等内置函数,便是由Standard模块提供的.PHP实例 为什么需要谈到这些,是因为在php.ini里除了针对php自身,也就是针对Core模块的一些配置(例如safe_mode,display_errors,max_execution_time等),还有相当多的配置是针对其他不同模块的.PHP实例 例如,date模块,它提供了常见的date,time,strtotime等函数.在php.ini中,它的相关配置形如：PHP实例
代码如下:
[Date] ;date.timezone = 'Asia/Shanghai' ;date.default_latitude = 31.7667 ;date.default_longitude = 35.2333 ;date.sunrise_zenith = 90.583333 ;date.sunset_zenith = 90.583333 除了这些模块拥有独立的配置,zend引擎也是可配的,只不过zend引擎的可配项非常少,只有error_reporting,zend.enable_gc和detect_unicode三项.PHP实例 在上一小节中我们已经谈到,php_module_startup会调用php_init_config,其目的是解析ini文件并生成configuration_hash.那么接下来在php_module_startup中还会做什么事情呢?很显然,就是会将configuration_hash中的配置作用于Zend,Core,Standard,SPL等不同模块.当然这并非一个一蹴而就的过程,因为php通常会包含有很多模块,php启动的过程中这些模块也会依次进行启动.那么,对模块A进行配置的过程,便是发生在模块A的启动过程中.PHP实例 有扩展开发经验的同学会直接指出,模块A的启动不就是在PHP_MINIT_FUNCTION(A)中么?PHP实例 是的,如果模块A需要配置,那么在PHP_MINIT_FUNCTION中,可以调用REGISTER_INI_ENTRIES()来完成.REGISTER_INI_ENTRIES会根据当前模块所需要的配置项名称,去configuration_hash查找用户设置的配置值,并更新到模块自己的全局空间中.PHP实例 2.1,模块的全局空间 要理解如何将ini配置从configuration_hash作用到各个模块之前,有必要先了解一下php模块的全局空间.对于不同的php模块,均可以开辟一块属于自己的存储空间,并且这块空间对于该模块来说,是全局可见的.一般而言,它会被用来存放该模块所需的ini配置.也就是说,configuration_hash中的配置项,最终会被存放到该全局空间中.在模块的执行过程中,只需要直接拜访这块全局空间,就可以拿到用户针对该模块进行的设置.当然,它也经常被用来记录模块在执行过程中的中间数据.PHP实例 我们以bcmath模块来举例说明,bcmath是一个提供数学计算方面接口的php模块,首先我们来看看它有哪些ini配置：PHP实例
代码如下:
PHP_INI_BEGIN() ??? STD_PHP_INI_ENTRY("bcmath.scale","0",PHP_INI_ALL,OnUpdateLongGEZero,bc_precision,zend_bcmath_globals,bcmath_globals) PHP_INI_END() bcmath只有一个配置项,我们可以在php.ini中用bcmath.scale来配置bcmath模块.PHP实例 接下来继续看看bcmatch模块的全局空间定义.在php_bcmath.h中有如下声明：PHP实例
代码如下:
ZEND_BEGIN_MODULE_GLOBALS(bcmath) ??? bc_num _zero_; ??? bc_num _one_; ??? bc_num _two_; ??? long bc_precision; ZEND_END_MODULE_GLOBALS(bcmath) ?宏展开之后,即为：PHP实例
代码如下:
typedef struct _zend_bcmath_globals { ??? bc_num _zero_; ??? bc_num _one_; ??? bc_num _two_; ??? long bc_precision; } zend_bcmath_globals; 其实,zend_bcmath_globals类型就是bcmath模块中的全局空间类型.这里仅仅声明了zend_bcmath_globals结构体,在bcmath.c中还有具体的实例化定义：PHP实例 // 展开后即为zend_bcmath_globals bcmath_globals; bcmath_globals是一块真正的全局空间,它包含有四个字段.其最后一个字段bc_precision,对应于ini配置中的bcmath.scale.我们在php.ini中设置了bcmath.scale的值,随后在启动bcmath模块的时候,bcmath.scale的值被更新到bcmath_globals.bc_precision中去.PHP实例 把configuration_hash中的值,更新到各个模块自己定义的xxx_globals变量中,就是所谓的将ini配置作用到模块.一旦模块启动完成,那么这些配置也都作用到位.所以在随后的执行阶段,php模块无需再次拜访configuration_hash,模块仅需要拜访自己的XXX_globals,就可以拿到用户设定的配置.PHP实例 bcmath_globals,除了有一个字段为ini配置项,其他还有三个字段为何意?这就是模块全局空间的第二个作用,它除了用于ini配置,还可以存储模块执行过程中的一些数据.PHP实例
再例如json模块,也是php中一个很常用的模块：PHP实例
代码如下:
ZEND_BEGIN_MODULE_GLOBALS(json) ??? int error_code; ZEND_END_MODULE_GLOBALS(json) 可以看到json模块并不需要ini配置,它的全局空间只有一个字段error_code.error_code记录了上一次执行json_decode或者json_encode中发生的错误.json_last_error函数便是返回这个error_code,来帮助用户定位错误原因.PHP实例 为了能够很便捷的拜访模块全局空间变量,php约定俗成的提出了一些宏.比如我们想拜访json_globals中的error_code,当然可以直接写做json_globals.error_code(多线程环境下不行),不过更通用的写法是定义JSON_G宏：PHP实例
代码如下:
#define JSON_G(v) (json_globals.v) 我们使用JSON_G(error_code)来拜访json_globals.error_code.本文刚开始的时候,曾提到PG、BG、JSON_G、PCRE_G,XXX_G等等,这些宏在php源代码中也是很常见的.现在我们可以很轻松的理解它们,PG宏可以拜访Core模块的全局变量,BG拜访Standard模块的全局变量,PCRE_G则拜访PCRE模块的全局变量.PHP实例
代码如下:
#define PG(v) (core_globals.v) #define BG(v) (basic_globals.v) 2.2,如何确定一个模块需要哪些配置呢? 模块需要什么样的INI配置,都是在各个模块中自己定义的.举例来说,对于Core模块,有如下的配置项定义：PHP实例
代码如下:
PHP_INI_BEGIN() ??? ...... ??? STD_PHP_INI_ENTRY_EX("display_errors","1",??? OnUpdateDisplayErrors,php_core_globals,core_globals,display_errors_mode) ??? STD_PHP_INI_BOOLEAN("enable_dl",?????? "1",PHP_INI_SYSTEM,OnUpdateBool,????????? enable_dl,????? php_core_globals,core_globals) ??? STD_PHP_INI_BOOLEAN("expose_php",????? "1",????????? expose_php,???? php_core_globals,core_globals) ??? STD_PHP_INI_BOOLEAN("safe_mode",?????? "0",????????? safe_mode,core_globals) ??? ...... PHP_INI_END() 可以在php-srcmainmain.c文件大概450+行找到上述代码.其中涉及的宏比较多,有ZEND_INI_BEGIN 、ZEND_INI_END、PHP_INI_ENTRY_EX、STD_PHP_INI_BOOLEAN等等,本文不一一赘述,感兴趣的读者可自行分析.PHP实例 上述代码进行宏展开后得到：PHP实例
代码如下:
static const zend_ini_entry ini_entries[] = { ??? .. ??? { 0,??? "display_errors",sizeof("display_errors"),OnUpdateDisplayErrors,(void *)XtOffsetOf(php_core_globals,display_errors),(void *)&core_globals,NULL,sizeof("1")-1,display_errors_mode }, ??? { 0,"enable_dl",???? sizeof("enable_dl"),???? OnUpdateBool,???????? (void *)XtOffsetOf(php_core_globals,enable_dl),????? (void *)&core_globals,zend_ini_boolean_displayer_cb },"expose_php",??? sizeof("expose_php"),??? OnUpdateBool,expose_php),???? (void *)&core_globals,"safe_mode",???? sizeof("safe_mode"),safe_mode),sizeof("0")-1, ??? ... ??? { 0,NULL } }; 我们看到,配置项的定义,其本质上就是定义了一个zend_ini_entry类型的数组.zend_ini_entry结构体的字段具体含义为：PHP实例
代码如下:
struct _zend_ini_entry { ??? int module_number;??????????????? // 模块的id ??? int modifiable;?????????????????? // 可被修改的范围,例如php.ini,ini_set ??? char *name;?????????????????????? // 配置项的名称 ??? uint name_length; ??? ZEND_INI_MH((*on_modify));??????? // 回调函数,配置项注册或修改的时候会调用 ??? void *mh_arg1;??????????????????? // 通常为配置项字段在XXX_G中的偏移量 ??? void *mh_arg2;??????????????????? // 通常为XXX_G ??? void *mh_arg3;??????????????????? // 通常为保留字段,极少用到 ??? char *value;????????????????????? // 配置项的值 ??? char *orig_value;???????????????? // 配置项的原始值 ??? void (*displayer)(zend_ini_entry *ini_entry,int type); 2.3,将配置作用到模块――REGISTER_INI_ENTRIES 经常能够在不同扩展的PHP_MINIT_FUNCTION里看到REGISTER_INI_ENTRIES.REGISTER_INI_ENTRIES主要负责完成两件事情,第一,对模块的全局空间XXX_G进行填充,同步configuration_hash中的值到XXX_G中去.其次,它还生成了EG(ini_directives).PHP实例 REGISTER_INI_ENTRIES也是一个宏,展开之后实则为zend_register_ini_entries方法.具体来看下zend_register_ini_entries的实现：PHP实例
代码如下:
ZEND_API int zend_register_ini_entries(const zend_ini_entry *ini_entry,int module_number TSRMLS_DC) /* {{{ */ { ??? // ini_entry为zend_ini_entry类型数组,p为数组中每一项的指针 ??? const zend_ini_entry *p = ini_entry; ??? zend_ini_entry *hashed_ini_entry; ??? zval default_value; ??? ??? // EG(ini_directives)就是registered_zend_ini_directives ??? HashTable *directives = registered_zend_ini_directives; ??? zend_bool config_directive_success = 0; ??? ??? // 还记得ini_entry最后一项固定为{ 0,... }么 ??? while (p->name) { ??????? config_directive_success = 0; ??????? ??????? // 将p指向的zend_ini_entry加入EG(ini_directives) ??????? if (zend_hash_add(directives,p->name,p->name_length,(void*)p,sizeof(zend_ini_entry),(void **) &hashed_ini_entry) == FAILURE) { ??????????? zend_unregister_ini_entries(module_number TSRMLS_CC); ??????????? return FAILURE; ??????? } ??????? hashed_ini_entry->module_number = module_number; ??????? ??????? // 根据name去configuration_hash中查询,取出来的结果放在default_value中 ??????? // 注意default_value的值比较原始,一般是数字、字符串、数组等,具体取决于php.ini中的写法 ??????? if ((zend_get_configuration_directive(p->name,&default_value)) == SUCCESS) { ??????????? // 调用on_modify更新到模块的全局空间XXX_G中 ??????????? if (!hashed_ini_entry->on_modify || hashed_ini_entry->on_modify(hashed_ini_entry,Z_STRVAL(default_value),Z_STRLEN(default_value),hashed_ini_entry->mh_arg1,hashed_ini_entry->mh_arg2,hashed_ini_entry->mh_arg3,ZEND_INI_STAGE_STARTUP TSRMLS_CC) == SUCCESS) { ??????????????? hashed_ini_entry->value = Z_STRVAL(default_value); ??????????????? hashed_ini_entry->value_length = Z_STRLEN(default_value); ??????????????? config_directive_success = 1; ??????????? } ??????? } ??????? // 如果configuration_hash中没有找到,则采用默认值 简单来说,可以把上述代码的逻辑表述为：PHP实例 1,将模块声明的ini配置项添加到EG(ini_directives)中.注意,ini配置项的值可能在随后被修改.PHP实例 2,尝试去configuration_hash中寻找各个模块需要的ini.PHP实例 如果能够找到,说明用户ini文件中配置了该值,那么采用用户的配置. 我们来具体看下on_modify,它其实是一个函数指针,来看两个具体的Core模块的配置声明：PHP实例
代码如下:
STD_PHP_INI_BOOLEAN("log_errors",????? "0",??? PHP_INI_ALL,log_errors,???????? php_core_globals,core_globals) STD_PHP_INI_ENTRY("log_errors_max_len","1024",OnUpdateLong,log_errors_max_len,core_globals) 对于log_errors,它的on_modify被设置为OnUpdateBool,对于log_errors_max_len,则on_modify被设置为OnUpdateLong.PHP实例 进一步假设我们在php.ini中的配置为：PHP实例
代码如下:
log_errors = On log_errors_max_len = 1024 具体来看下OnUpdateBool函数：PHP实例
代码如下:
ZEND_API ZEND_INI_MH(OnUpdateBool) { ??? zend_bool *p; ??? ??? // base表示core_globals的地址 ??? char *base = (char *) mh_arg2; ??? // p表示core_globals的地址加上log_errors字段的偏移量 ??? if (new_value_length == 2 && strcasecmp("on",new_value) == 0) { 最令人费解的估计就是mh_arg1和mh_arg2了,其实对照前面所述的zend_ini_entry定义,mh_arg1,mh_arg2还是很容易参透的.mh_arg1表示字节偏移量,mh_arg2表示XXX_globals的地址.因此,(char *)mh_arg2 + mh_arg1的结果即为XXX_globals中某个字段的地址.具体到本case中,就是计算core_globals中log_errors的地址.因此,当OnUpdateBool最后执行到PHP实例
代码如下:
*p = (zend_bool) atoi(new_value); 其作用就相当于PHP实例
代码如下:
core_globals.log_errors = (zend_bool) atoi("1"); 分析完了OnUpdateBool,我们再来看OnUpdateLong便觉得一目了然：PHP实例
代码如下:
ZEND_API ZEND_INI_MH(OnUpdateLong) { ??? long *p; ??? char *base = (char *) mh_arg2; ??? // 获得log_errors_max_len的地址 ??? // 将"1024"转化成long型,并赋值给core_globals.log_errors_max_len 最后需要注意的是,zend_register_ini_entries函数中,如果configuration_hash中存在配置,则当调用on_modify结束后,hashed_ini_entry中的value和value_length会被更新.也就是说,如果用户在php.ini中配置过,则EG(ini_directives)存放的就是实际配置的值.如果用户没配,EG(ini_directives)中存放的是声明zend_ini_entry时给出的默认值.PHP实例 zend_register_ini_entries中的default_value变量命名比较糟糕,相当容易造成误解.其实default_value并非表示默认值,而是表示用户实际配置的值.PHP实例 3,总结 至此,三块数据configuration_hash,EG(ini_directives)以及PG、BG、PCRE_G、JSON_G、XXX_G...已经都交代清楚了.PHP实例 总结一下：PHP实例 1,存放php.ini文件里的配置,不做校验,其值为字符串. 《PHP实例：php中的ini配置原理详解》是否对您有启发，欢迎查看更多与《PHP实例：php中的ini配置原理详解》相关教程，学精学透。编程之家 52php.cn为您提供精彩教程。 （编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |
