PHP內核探索 —— 常量的實現
常量,顧名思義是一個常態的量值。它與值只綁定一次,它的作用在于有肋于增加程序的可讀性和可靠性。 在PHP中,常量的名字是一個簡單值的標識符,在腳本執行期間該值不能改變。 和變量一樣,常量默認為大小寫敏感,但是按照我們的習慣常量標識符總是大寫的。 常量名和其它任何 PHP 標簽遵循同樣的命名規則。合法的常量名以字母或下劃線開始,后面跟著任何字母,數字或下劃線。
在設定以后,常量的值無法更改常量名不需要開頭的美元符號 ($)作用域不影響對常量的訪問常量值只能是字符串或數字在這一小節我們一起看下常量與我們常見的變量有啥區別,它在執行期間的不可改變的特性是如何實現的以及常量的定義過程。
首先看下常量與變量的區別,常量是在變量的zval結構的基礎上添加了一額外的元素。如下所示為PHP中常量的內部結構。
常量的內部結構typedef struct _zend_constant { zval value; /* zval結構,PHP內部變量的存儲結構,在第一小節有說明 */ int flags; /* 常量的標記如 CONST_PERSISTENT | CONST_CS */ char *name; /* 常量名稱 */ uint name_len; int module_number; /* 模塊號 */} zend_constant;
在Zend/zend_constants.h文件的33行可以看到如上所示的結構定義。 在常量的結構中,除了與變量一樣的zval結構,它還包括屬于常量的標記,常量名以及常量所在的模塊號。
在了解了常量的存儲結構后,我們來看PHP常量的定義過程。一個例子。
define(’ICULTIVATOR’, ’www.icultivator.com’);
這是一個很常規的常量定義過程,它使用了PHP的內置函數define。常量名為ICULTIVATOR,值為一個字符串,存放在zval結構中。 從這個例子出發,我們看下define定義常量的過程實現。
define定義常量define是PHP的內置函數,在Zend/zend_builtin_functions.c文件中定義了此函數的實現。如下所示為部分源碼:
/* {{{ proto bool define(string constant_name, mixed value, boolean case_insensitive=false) Define a new constant */ZEND_FUNCTION(define){if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, 'sz|b', &name,&name_len, &val, &non_cs) == FAILURE) {return;}... // 類常量定義 此處不做介紹... // 值類型判斷和處理c.value = *val;zval_copy_ctor(&c.value);if (val_free) {zval_ptr_dtor(&val_free);}c.flags = case_sensitive; /* non persistent */c.name = zend_strndup(name, name_len);c.name_len = name_len+1;c.module_number = PHP_USER_CONSTANT;if (zend_register_constant(&c TSRMLS_CC) == SUCCESS) {RETURN_TRUE;} else {RETURN_FALSE;}}/* }}} */
上面的代碼已經對對象和類常量做了簡化處理, 其實現基本上是一個將傳遞的參數傳遞給新建的zend_constant結構,并將這個結構體注冊到常量列表中的過程。 關于大小寫敏感,函數的第三個參數表示是否大小不敏感,默認為false(大小寫敏感)。這個參數最后會賦值給zend_constant結構體的flags字段。其在函數中實現代碼如下:
zend_bool non_cs = 0; // 第三個參數的臨時存儲變量int case_sensitive = CONST_CS; // 是否大小寫敏感,默認為1if(non_cs) { // 輸入為真,大小寫不敏感 case_sensitive = 0;}c.flags = case_sensitive; // 賦值給結構體字段
從上面的define函數的實現來看,PHP對于常量的名稱在定義時其實是沒有所謂的限制。如下所示代碼:
define(’^_^’, ’smile’);if (defined(’^_^’)) { echo ’yes’;}else{ echo ’no’;}//$var = ^_^; //語法錯誤$var = constant('^_^');
通過defined函數測試表示,‘^_^’這個常量已經定義好,這樣的常量無法直接調用, 只能使用constant語句來使用, 否則在語法解析時會顯示錯誤。 在上面的代碼中有用到一個判斷常量是否定義的函數,下面我們看看這個函數是如何實現的。
判斷常量是否設置和define一樣, defined的實現也在Zend/zend_builtin_functions.c文件, 其實現是一個讀取參數變量,調用 zend_get_constant_ex函數獲取常量的值來判斷常量是否存在的過程。 而zend_get_constant_ex函數不僅包括了常規的常規的常量獲取,還包括類常量的獲取, 最后是通過zend_get_constant函數獲取常量的值。在zend_get_constant函數中,基本上是通過下面的代碼來獲取常量的值。
zend_hash_find(EG(zend_constants), name, name_len+1, (void **) &c)
除此之外,只是調用這個函數之前和之后對name有一些特殊的處理。
常量的初始化以上通過define定義的常量的模塊編號都是PHP_USER_CONSTANT,這表示是用戶定義的常量。 除此之外我們在平時使用較多的,如在顯示所有級別錯誤報告時使用的E_ALL常量就有點不同了。 這里我們以cgi模式為例說明標準常量的定義過程。 整個調用順序如下所示:
[php_cgi_startup() -> php_module_startup() -> zend_startup() -> zend_register_standard_constants()]
void zend_register_standard_constants(TSRMLS_D){ ... // 若干常量以REGISTER_MAIN_LONG_CONSTANT設置, REGISTER_MAIN_LONG_CONSTANT('E_ALL', E_ALL, CONST_PERSISTENT | CONST_CS); ...}
REGISTER_MAIN_LONG_CONSTANT宏展開是以zend_register_long_constant實現。 zend_register_long_constant函數將常量中值的類型,值,名稱及模塊號賦值給新的zend_constant。 并調用zend_register_constant添加到全局的常量列表中。
[php_cgi_startup() -> php_module_startup() -> zend_startup() -> zend_register_standard_constants() -> zend_register_constant]
ZEND_API void zend_register_long_constant(const char *name, uint name_len,long lval, int flags, int module_number TSRMLS_DC){ zend_constant c; c.value.type = IS_LONG; c.value.value.lval = lval; c.flags = flags; c.name = zend_strndup(name, name_len-1); c.name_len = name_len; c.module_number = module_number; zend_register_constant(&c TSRMLS_CC);}
zend_register_constant函數首先根據常量中的c->flags判斷是否區分大小寫, 如果不區分,則名字統一為小寫,如果包含'',也統一成小寫。否則為定義的名字 然后將調用下面的語句將當前常量添加到EG(zend_constants)。 EG(zend_constants)是一個HashTable(這在前面的章節中說明), 下面的代碼是將常量添加到這個HashTable中。
zend_hash_add(EG(zend_constants), name, c->name_len, (void *) c,sizeof(zend_constant), NULL)==FAILURE)
在php_module_startup函數中,除了zend_startup函數中有注冊標準的常量, 它本身體通過宏REGISTER_MAIN_LONG_CONSTANT等注冊了一些常量,如:PHP_VERSION,PHP_OS等。
相關文章:
