12.4 PHP扩展中的全局变量

    在扩展中定义全局变量

    首先，我们需要在扩展的头文件中(默认是php_*.h)中定义所有的全局变量。举个例子，比如我们要定义一个无符号的long类型的全局变量，我们可以这样定义：

    用ZEND_BEGIN_MODULE_GLOBALS和ZEND_END_MODULE_GLOBALS宏将定义的全局变量包起来。将上例中的宏展开后，是下面这个样子：

    2.     unsigned long counter;
    3. } zend_sample4_globals;

    如果你还有其他的全局变量需要定义，只需加在两个宏之间就可以了。接下来我们该在simple4.c中声明我们在头文件中定义的这些全局变量了：

    1. ZEND_DECLARE_MODULE_GLOBALS(sample4);

    这个宏的内部实现取决于是否启用了线程安全，在非线程安全的环境下，如：Apache1，Apache2-prefork, CGI，CLI…会使用zend_sample4_globals结构来定义全局变量：

    1. zend_sample4_globals sample4_globals;

    填充这个ID就等于定义了扩展中的全局变量。根据其定义的信息，将为每个新线程的独立存储空间分配内存块。我们可以在MINIT中这样定义：

    1. #ifdef ZTS
    2.     ts_allocate_id(
    3.             &sample4_globals_id,
    4.             sizeof(zend_sample4_globals),
    5.             NULL, NULL);
    6. #endif

    有一点需要注意这种方法需要包裹在#ifdef中，以防止它在没有启动Zend Thread Safety(ZTS)时执行。因为sample4_globals_id只能在多线程环境中使用。非线程的版本用我们在前面提到的sample4_globals来声明全局变量。

    线程中的初始化和关闭

    在非线程的环境中，会将一个zend_sample4_globals结构的副本保存在指定进程中。你可以指定他的默认值，或者在MINIT或者RINIT中分配资源来初始化它。要记得在对应的MSHUTDOWN或者RSHUTDOWN中及时释放这些资源。

    然而在线程版本中，一个新的结构会在一个新线程spun的时候被分配。为了知道怎样初始化和关闭扩展中的全局变量，需要向ZE引擎提供回调函数。在前面我们在调用ts_allocate_id()的时候是是以NULL来作为这个值的，接下来我们添加2个一会需要在MINIT调用的方法：

    1. static void php_sample4_globals_ctor(zend_sample4_globals *sample4_globals TSRMLS_DC)
    2. {
    3.     /* Initialize a new zend_sample4_globals struct
    4.      * During thread spin-up */
    5.      sample4_globals->counter = 0;
    6. }
    8. static void php_sample4_globals_dtor(zend_sample4_globals *sample4_globals TSRMLS_DC)
    9. {
    10.      * May be freed here */
    11. }
    1. PHP_MINIT_FUNCTION(sample4) {
    2.     REGISTER_STRING_CONSTANT("SAMPLE4_VERSION", PHP_SAMPLE4_EXTVER, CONST_CS | CONST_PERSISTENT);
    3. #ifdef ZTS
    4.     ts_allocate_id(&sample4_globals_id,
    5.                         sizeof(zend_sample4_globals),
    6.                         (ts_allocate_ctor)php_sample4_globals_ctor,
    7.                         (ts_allocate_dtor)php_sample4_globals_dtor);
    8. #else
    9.     php_sample4_globals_ctor(&sample4_globals TSRMLS_CC);
    10. #endif
    11.     return SUCCESS;
    12. }
    14. PHP_MSHUTDOWN_FUNCTION(sample4) {
    15. #ifndef ZTS
    16.     php_sample4_globals_dtor(&sample4_globals TSRMLS_CC);
    17. #endif
    19. }

    现在我们已经知道如何在扩展中创建全局变量了，在不是ZTS的环境中，使用它们很简单，我们还来看前面定义的那个计数器的递增功能如何实现：

    是不是看起来很简单，但是，在线程版本中将无法正常工作。那么我们来看看怎么在线程环境中完成这个功能吧：

    1. {
    2. #ifdef ZTS
    3.         RETURN_LONG(++TSRMG(sample4_globals_id, \
    4.                 zend_sample4_globals*, counter));
    5. #else
    6.         /* non-ZTS */
    7.         RETURN_LONG(++sample4_globals.counter);
    8. #endif
    9. }

    看起来很丑对吗？想象一下，在你的整个代码库中，这些IFDEF指令在每一个线程安全的全局访问时穿插。它会看起来比Perl更糟糕！这就是为什么所有的核心扩展，都有使用一个额外的宏观层抽象这种情况。我们可以在php_sample4.h中找到下面这段代码：

    1. #ifdef ZTS
    2. #include "TSRM.h"
    3. #define SAMPLE4_G(v) TSRMG(sample4_globals_id, zend_sample4_globals*, v)
    4. #else
    5. #define SAMPLE4_G(v) (sample4_globals.v)
    6. #endif

    使用它们会让你的方法看起来更简洁：

    1. PHP_FUNCTION(sample4_counter) {
    2.     RETURN_LONG(++SAMPLE4_G(counter));

    看到*G()这样的宏是不是有种似曾相识的感觉？也许以前你看到过EG()、CG()等宏，了解他们会让你对PHP的了解更深一步：