扩展的构成

7.3.1 扩展的构成

扩展首先需要创建一个zend_module_entry结构，这个变量必须是全局变量，且变量名必须是：扩展名称_module_entry，内核通过这个结构得到这个扩展都提供了哪些功能，换句话说，一个扩展可以只包含一个zend_module_entry结构，相当于定义了一个什么功能都没有的扩展。

//zend_modules.h
struct _zend_module_entry {
    unsigned short size; //sizeof(zend_module_entry)
    unsigned int zend_api; //ZEND_MODULE_API_NO
    unsigned char zend_debug; //是否开启debug
    unsigned char zts; //是否开启线程安全
    const struct _zend_ini_entry *ini_entry;
    const struct _zend_module_dep *deps;
    const char *name; //扩展名称，不能重复
    const struct _zend_function_entry *functions; //扩展提供的内部函数列表
    int (*module_startup_func)(INIT_FUNC_ARGS); //扩展初始化回调函数，PHP_MINIT_FUNCTION或ZEND_MINIT_FUNCTION定义的函数
    int (*module_shutdown_func)(SHUTDOWN_FUNC_ARGS); //扩展关闭时回调函数
    int (*request_startup_func)(INIT_FUNC_ARGS); //请求开始前回调函数
    int (*request_shutdown_func)(SHUTDOWN_FUNC_ARGS); //请求结束时回调函数
    void (*info_func)(ZEND_MODULE_INFO_FUNC_ARGS); //php_info展示的扩展信息处理函数
    const char *version; //版本
    ...
    unsigned char type;
    void *handle;
    int module_number; //扩展的唯一编号
    const char *build_id;
};

这个结构包含很多成员，但并不是所有的都需要自己定义，经常用到的主要有下面几个：

• name: 扩展名称，不能重复
• functions: 扩展定义的内部函数entry
• module_startup_func: PHP在模块初始化时回调的hook函数，可以使扩展介入module startup阶段
• module_shutdown_func: 在模块关闭阶段回调的函数
• request_startup_func: 在请求初始化阶段回调的函数
• request_shutdown_func: 在请求结束阶段回调的函数
• __info_func:__ php_info()函数时调用，用于展示一些配置、运行信息
• version: 扩展版本

除了上面这些需要手动设置的成员，其它部分可以通过STANDARD_MODULE_HEADER、STANDARD_MODULE_PROPERTIES宏统一设置，扩展提供的内部函数及四个执行阶段的钩子函数是扩展最常用到的部分，几乎所有的扩展都是基于这两部分实现的。有了这个结构还需要提供一个接口来获取这个结构变量，这个接口是统一的，扩展中通过ZEND_GET_MODULE(extension_name)完成这个接口的定义:

//zend_API.h
#define ZEND_GET_MODULE(name) \
    BEGIN_EXTERN_C()\
    ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
    END_EXTERN_C()

展开后可以看到，实际就是定义了一个get_module()函数，返回扩展zend_module_entry结构的地址，这就是为什么这个结构的变量名必须是扩展名称_module_entry这种格式的原因。

有了扩展的zend_module_entry结构以及获取这个结构的接口一个合格的扩展就编写完成了，只是这个扩展目前还什么都干不了：

#include "php.h"
#include "php_ini.h"
#include "ext/standard/info.h"

zend_module_entry mytest_module_entry = {
    STANDARD_MODULE_HEADER,
    "mytest",
    NULL, //mytest_functions,
    NULL, //PHP_MINIT(mytest),
    NULL, //PHP_MSHUTDOWN(mytest),
    NULL, //PHP_RINIT(mytest),
    NULL, //PHP_RSHUTDOWN(mytest),
    NULL, //PHP_MINFO(mytest),
    "1.0.0",
    STANDARD_MODULE_PROPERTIES
};

ZEND_GET_MODULE(mytest)

编译、安装后执行php -m就可以看到my_test这个扩展了。