[ PHP 内核与扩展开发系列] PHP 启动与终止那点事:常量的底层实现

在脚本中使用扩展的一个方便之处是,人们可以改变自己定义的常量,你可以通过 define() 函数来定义一个常量。在内核中,我们将会使用 REGISTER_*_CONSTANT() 的家族函数来注册常量。

对于自定义的大多数常量来说,你可能希望在程序初始化的时候便定义这些常量:

PHP_MINIT_FUNCTION(sample4) {
    REGISTER_STRING_CONSTANT("SAMPLE4_VERSION",
            PHP_SAMPLE4_EXTVER, CONST_CS | CONST_PERSISTENT);
    return SUCCESS;
}

第一个参数是你要定义的这个常量的名称。在本例中,我们定义了一个名称为 SAMPLE4_VERSION 的常量。有一点很重要,这里要注意宏 REGISTER_*_CONSTANT() 的使用,这些函数中为了确定常量的名称长度使用了 sizeof() 函数。这就意味着,常量的名称只能为固定文本,大家可以尝试使用一个 char * 的变量,这将导致 sizeof() 计算出错误的字符串长度。

接下来,我们来看看常量的值。在大多数情况下,它会是一个单一参数的类型,然而在 STRINGL 的版本中,你会看到在一些情况下会需要使用第二个参数来表明长度。当注册字符串类型的常量时,字符串的值不会被复制到常量中,而仅仅是一个引用。

最后一个参数,你可以通过两个可以标识位的按位或组合传入。CONST_CS 标识是否大小写敏感,一般情况下 CONST_CS 标识是默认使用的。对于一些特殊的情况,比如 TRUEFALSENULL 等等,这个参数将被省略。在 | 后的标识符表明了该常量的作用域和生命周期,CONST_PERSISTENT 表示该常量是持久化常量,直到 MSHUTDOWN 阶段才会被销毁。

当我们在 MINIT 中定义常量时,你可能需要在多个请求中使用这个常量,当你在 RINIT 中定义常量时,这个常量会在当前请求结束的时候销毁。

下面列出的 4 个创建常量常用的函数,有一个共同需要注意的地方 —— 常量名称一定要用固定文本而不是 char * 类型的变量:

REGISTER_LONG_CONSTANT(char *name, long lval, int flags)
REGISTER_DOUBLE_CONSTANT(char *name, double dval, int flags)
REGISTER_STRING_CONSTANT(char *name, char *value, int flags)
REGISTER_STRINGL_CONSTANT(char *name,char *value, int value_len, int flags)

如果没有办法提供文本类型的名称,那么你可以尝试使用上面 4 个函数的底层调用函数去实现相同的效果:

void zend_register_long_constant(char *name, uint name_len, long lval, int flags, int module_number TSRMLS_DC)
void zend_register_double_constant(char *name, uint name_len, double dval, int flags, int module_number TSRMLS_DC)
void zend_register_string_constant(char *name, uint name_len, char *strval, int flags, int module_number TSRMLS_DC)
void zend_register_stringl_constant(char *name, uint name_len, char *strval, uint strlen, int flags, int module_number TSRMLS_DC)

这样就可以通过传入 name_len 来扩大函数的使用范围(比如在循环中)。

module_number 是一个加载扩展或者卸载扩展时的标识。你不需要关注它,它会自动加载到扩展中的MINITRINIT 中,所以在你用上面 4 个函数声明常量的时候,可以这样写:

PHP_MINIT_FUNCTION(sample4) 
{
    zend_register_string_constant("SAMPLE4_VERSION",
                    sizeof("SAMPLE4_VERSION"),
                    PHP_SAMPLE4_EXTVER,
                    CONST_CS | CONST_PERSISTENT,
                    module_number TSRMLS_CC);
    return SUCCESS;
}

除了数组和对象外,其他变量也可以用来注册一个常量,但是因为没有相应宏和 ZEND API 去支持这些声明,所以你必须手动声明这样的常量,通过下面一个例子来了解一下:

void php_sample4_register_boolean_constant(char *name, uint len, zend_bool bval, int flags, int module_number TSRMLS_DC)
{
    zend_constant c;

    ZVAL_BOOL(&c.value, bval);
    c.flags = CONST_CS | CONST_PERSISTENT;
    c.name = zend_strndup(name, len - 1);
    c.name_len = len;
    c.module_number = module_number;
    zend_register_constant(&c TSRMLS_CC);

}

学院君 has written 703 articles

资深PHP工程师,Laravel学院院长

发表评论

标记为*的字段是必填项(邮箱地址不会被公开)

你可以使用这些HTML 标签和属性: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>