《深入剖析ngx》——变量机制

1. ngx对变量性质的定义

用户可以在配置文件中使用变量，如

http_user_agent 就是变量，如上会根据若使用IE访问重写url。
ngx变量只有字符串类型，可以有用户定义的配置赋值，也可以由 ngx 自动赋值（如上，每次收到请求自动对 http_user_agent 赋值）。
变量在配置文件的标志是使用 $。
ngx使用惰性求值赋值变量，即当使用变量时，才求值。这样的好处是 ngx可能定义了上百个变量，但是配置文件中只使用了几个，所以只需要求那几个变量。

2. 变量实现

ngx定义了变量类型 ngx_http_variable_value_t , 变量值类型 ngx_variable_value_t

在解析配置前，ngx会统计所有支持的变量。
在每个模块的 moulde->preconfiguration 回调函数，将自己支持的变量加入 http核心配置 ngx_http_core_main_conf_t 的 variables_keys字段

如 ngx_http_core_module 在 preconfiguration 回调函数统计自己的变量

ngx_hash_add_key() 实际上是往变量 cmcf->variables_keys 新增元素。
其他模块也是向 cmcf->variables_keys 添加变量

总之，当ngx配置解析完成，cmcf->variables_keys 记录了所有支持的变量。

解析配置文件时，将被使用的变量添加到 cmcf->variables
若配置文件出现 set $file aa; 则先定义变量，再对其赋值。
有些变量在ngx内部被使用，也会添加到 cmcf->variables

最后，cmcf->variables 记录了可能被使用的变量，所以需要对其合法性进行验证。在 ngx_http_variable_init_var() 实现，
遍历所有 cmcf->variables 变量，是否在 cmcf->variables_keys 中，
对于有些变量不需要在 cmcf->variables_keys中也合法，如 http_ , sent_http_, upstream_http_, cookie_ , arg_ 开头的变量，
因为这些变量数量庞大且不可预知，
如 arg_, 当请求为 http://192.168.1.1/?pageid=2 则自动生成 $arg_pageid 变量.

ngx_http_variable_init_var() 不止检查合法性，还对 cmcf->variables 的变量进行赋值，即 get_handler , data, flags 字段。

ngx_http_variable_s 的个字段意义：
name 变量名
index 在 cmcf->variable 的下标
set_handler 目前只在使用set配置指令才用的上
下面三个字段从 cmcf->variables_keys 拷贝值
flags 有两个值：
NGX_HTTP_VAR_CHANGEABLE ，表示变量是否可重复添加
比如有如下配置

set $file t_a;
set $file t_b;

若file变量被设置为 NGX_HTTP_VAR_CHANGEABLE , 那么 file 最终的值为 t_b，但若没有使用 NGX_HTTP_VAR_CHANGEABLE ，则ngx会提示 the duplicate "t_var" variable 然后退出

NGX_HTTP_VAR_NOCACHEABLE，表示变量是否可以缓存，

如$http_user_agent 变量，对于同一个连接，前面的请求和后面的请求，值都是一样的，所以可以只计算一次，之后用缓存的值。

data 表示存放变量值的地方，具体为变量值在 ngx_http_request_t 的偏移量。
我们知道 ngx的变量通常是和 r 相关，对于直接相关（如 $http_user_agent 值在r内）的变量，可以直接从r中获得值，所以data记录变量有效值在 ngx_http_request_t结构体中的偏移量。对于简介相关（如 $remote_port）的变量，r中不能直接获得值，所以data无效，通常设置为0。
如下