合规国际互联网加速 OSASE为企业客户提供高速稳定SD-WAN国际加速解决方案。 广告
## 前言 我们经常使用的一些扩展,有的会在php.ini文件中会有一些配置项。这些配置项控制扩展的行为。如 opcache扩展,经常使用的配置项如下: ```ini [opcache] ; 模块地址 zend_extension=opcache.so ; 开关打开 opcache.enable=1 ; 开启CLI opcache.enable_cli=1 ; 可用内存, 酌情而定, 单位为:Mb opcache.memory_consumption=528 ; Zend Optimizer + 暂存池中字符串的占内存总量.(单位:MB) opcache.interned_strings_buffer=8 ; 对多缓存文件限制, 命中率不到 100% 的话, 可以试着提高这个值 opcache.max_accelerated_files=10000 ; Opcache 会在一定时间内去检查文件的修改时间, 这里设置检查的时间周期, 默认为 2, 定位为秒 opcache.revalidate_freq=60 ; 打开快速关闭, 打开这个在PHP Request Shutdown的时候回收内存的速度会提高 opcache.fast_shutdown=1 ``` 那么如何实现读取配置文件中的配置项,并应用到扩展中呢?这个是本节要讨论的话题。本文将定义几个配置项,并演示如何读取和修改配置项。配置项如下: ```ini [say] extension=say.so say.number=101 say.string=abc say.boolean=1 ``` ## 代码 ### 基础代码 这个扩展,我们将在say扩展上增加相关代码。say扩展相关代码大家请看这篇博文。PHP7扩展开发之hello word 文中已经详细介绍了如何创建一个扩展和提供了源码下载。 ### 代码实现 使用ext_skel命令生成的代码默认已经有配置项相关的代码,只是出于被注释状态。配置项的实现分以下几步。 #### 第一步:声明变量 这一步声明的变量用于存储从配置文件中读取的配置项值。 ``` //定义一个全局变量类型,代码在php_say.h文件中 ZEND_BEGIN_MODULE_GLOBALS(say) zend_long global_number; char *global_string; zend_bool global_boolean; ZEND_END_MODULE_GLOBALS(say) //声明一个全局变量 ZEND_DECLARE_MODULE_GLOBALS(say) ``` #### 第二步:设置配置项参数 这一步主要是指定一些处理配置项的参数。 所有的配置项参数都必须在`PHP_INI_BEGIN() `和 `PHP_INI_END()`之间。代码如下: ```c PHP_INI_BEGIN() STD_PHP_INI_ENTRY("say.number", "100", PHP_INI_ALL, OnUpdateLong, global_value, zend_say_globals, say_globals) STD_PHP_INI_ENTRY("say.string", "ab", PHP_INI_ALL, OnUpdateString, global_string, zend_say_globals, say_globals) STD_PHP_INI_ENTRY("say.boolean", "0", PHP_INI_ALL, OnUpdateBool, global_string, zend_say_globals, say_globals) PHP_INI_END() ``` #### 第三步:加载配置项 这一步主要是把配置项从配置文件中读取出来,根据第二步设置的参数,赋值给第一步声明的变量。 宏方法`REGISTER_INI_ENTRIES();`是用于加载配置文件的。这个宏方法默认是被注释掉,在`PHP_MINIT_FUNCTION`方法中。只要把注释给去掉即可。 ``` PHP_MINIT_FUNCTION(say) { ...... REGISTER_INI_ENTRIES(); } ``` #### 第四步:读取配置项 在PHP扩展中读取配置项值,需要使用一个宏方法`SAY_G()`。这个宏方法定义在php_say.h中。 现在,我们定义一个方法`show_ini()`来显示配置项内容。代码如下: ```c PHP_FUNCTION(show_ini) { zval arr; array_init(&arr); add_assoc_long_ex(&arr, "say.number", 10, SAY_G(global_number)); add_assoc_string_ex(&arr, "say.string", 10, SAY_G(global_string)); add_assoc_bool_ex(&arr, "say.boolean", 11, SAY_G(global_boolean)); RETURN_ZVAL(&arr, 0, 1); } ``` 调用show_ini()方法 ``` <?php $ini = show_ini(); var_dump($ini); ?> ``` 输出结果如下: ``` $ php ./test.php array(3) { ["say.number"]=> int(101) ["say.string"]=> string(3) "abc" ["say.boolean"]=> bool(true) } ``` #### 第五步:销毁配置项 这一步主要是为了在PHP进程结束时,释放配置项占用的资源。 销毁配置项是通过宏方法`UNREGISTER_INI_ENTRIES()`来实现的。这个方法默认在`PHP_MSHUTDOWN_FUNCTION`方法中。默认是被注释掉的。只要把注释去掉就可以了。代码如下: ```c PHP_MSHUTDOWN_FUNCTION(say) { UNREGISTER_INI_ENTRIES(); ...... } ``` ### 代码解读 `ZEND_BEGIN_MODULE_GLOBALS() `和 `ZEND_END_MODULE_GLOBALS()` 用于定义一个全局变量结构体类型。把宏方法展开后的代码如下: ```c typedef struct _zend_say_globals { zend_long global_number; //数字 char *global_string; //字符串 zend_bool global_boolean; //布尔 } zend_say_globals; ``` `ZEND_DECLARE_MODULE_GLOBALS()`是使用上面定义的类型,声明一个全局变量。展开后如下: ```c zend_say_globals say_globals; ``` 定义了一个全局变量`say_globals`。 `STD_PHP_INI_ENTRY()`用于设置每个配置项的参数。这个宏方法有这么几个参数: - 第一个参数:配置项在配置文件ini中的名称 - 第二个参数:默认值。当ini文件中不存在这个配置项时,使用这个默认值 - 第三个参数:修改范围。就是设置都在那些场景下可以修改。详细的可以查 PHP_INI_ALL - 第四个参数:当赋值给全局变量前,会调用的函数。PHP内核已经给出了常用的几个函数。如OnUpdateLong。 - 第五个参数:全局变量的成员名。对应zend_say_globals结构体中的成员。表明读取的值会赋值给这个成员。 - 第六个参数:全局变量的类型。就是上面定义的结构体。 - 第七个参数:全局变量名称。 `SAY_G()`用于读取全局变量的值。如,`SAY_G(global_number)`展开后的代码如下: ```c say_globals.global_number ```