模块开发高级篇(30%)

变量(80%)

综述

在Nginx中同一个请求需要在模块之间数据的传递或者说在配置文件里面使用模块动态的数据一般来说都是使用变量，比如在HTTP模块中导出了host/remote_addr等变量，这样我们就可以在配置文件中以及在其他的模块使用这个变量。在Nginx中，有两种定义变量的方式，一种是在配置文件中,使用set指令，一种就是上面我们提到的在模块中定义变量，然后导出.

在Nginx中所有的变量都是与HTTP相关的(也就是说赋值都是在请求阶段)，并且基本上是同时保存在两个数据结构中，一个就是hash表(可选)，另一个是数组. 比如一些特殊的变量，比如arg_xxx/cookie_xxx等，这些变量的名字是不确定的(因此不能内置)，而且他们还是只读的(不能交由用户修改)，如果每个都要放到hash表中的话(不知道用户会取多少个),会很占空间的，因此这些变量就没有hash,只有索引.这里要注意，用户不能定义这样的变量，这样的变量只存在于Nginx内部.

对应的变量结构体是这样子(每一个变量都是一个ngx_http_variable_s结构体)的：

  1. struct ngx_http_variable_s {
  2.     ngx_str_t                     name;   /* must be first to build the hash */
  3.     ngx_http_set_variable_pt      set_handler;
  4.     ngx_http_get_variable_pt      get_handler;
  5.     uintptr_t                     data;
  6.     ngx_uint_t                    flags;
  7.     ngx_uint_t                    index;
  8. };

其中name表示对应的变量名字，set/get_handler表示对应的设置以及读取回调，而data是传递给回调的参数，flags表示变量的属性，index提供了一个索引(数组的脚标)，从而可以迅速定位到对应的变量。set/get_handler只有在真正读取设置变量的时候才会被调用.

这里要注意flag属性,flag属性就是由下面的几个属性组合而成:

  1. #define NGX_HTTP_VAR_CHANGEABLE   1
  2. #define NGX_HTTP_VAR_NOCACHEABLE  2
  3. #define NGX_HTTP_VAR_INDEXED      4
  4. #define NGX_HTTP_VAR_NOHASH       8
  5.  
  • NGX_HTTP_VAR_CHANGEABLE表示这个变量是可变的.Nginx有很多内置变量是不可变的，比如arg_xxx这类变量，如果你使用set指令来修改，那么Nginx就会报错.
  • NGX_HTTP_VAR_NOCACHEABLE表示这个变量每次都要去取值，而不是直接返回上次cache的值(配合对应的接口).
  • NGX_HTTP_VAR_INDEXED表示这个变量是用索引读取的.
  • NGX_HTTP_VAR_NOHASH表示这个变量不需要被hash.

而变量在Nginx中的初始化流程是这样的:

  • 首先当解析HTTP之前会调用ngx_http_variables_add_core_vars(pre_config)来将HTTP core模块导出的变量(http_host/remote_addr…)添加进全局的hash key链中.
  • 解析完HTTP模块之后，会调用ngx_http_variables_init_vars来初始化所有的变量(不仅包括HTTP core模块的变量，也包括其他的HTTP模块导出的变量,以及配置文件中使用set命令设置的变量),这里的初始化包括初始化hash表,以及初始化数组索引.
  • 当每次请求到来时会给每个请求创建一个变量数组(数组的个数就是上面第二步所保存的变量个数)。然后只有取变量值的时候，才会将变量保存在对应的变量数组位置。

创建变量

在Nginx中，创建变量有两种方式，分别是在配置文件中使用set指令，和在模块中调用对应的接口，在配置文件中创建变量比较简单，因此我们主要来看如何在模块中创建自己的变量。

在Nginx中提供了下面的接口，可以供模块调用来创建变量。

  1. ngx_http_variable_t *ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name, ngx_uint_t flags);

这个函数所做的工作就是将变量 “name”添加进全局的hash key表中,然后初始化一些域，不过这里要注意，对应的变量的get/set回调，需要当这个函数返回之后，显式的设置,比如在split_clients模块中的例子:

  1. var = ngx_http_add_variable(cf, &name, NGX_HTTP_VAR_CHANGEABLE);
  2. if (var == NULL) {
  3.         return NGX_CONF_ERROR;
  4. }
  5. //设置回调
  6. var->get_handler = ngx_http_split_clients_variable;
  7. var->data = (uintptr_t) ctx;

而对应的回调函数原型是这样的:

  1. typedef void (*ngx_http_set_variable_pt) (ngx_http_request_t *r,
  2.     ngx_http_variable_value_t *v, uintptr_t data);
  3. typedef ngx_int_t (*ngx_http_get_variable_pt) (ngx_http_request_t *r,
  4.     ngx_http_variable_value_t *v, uintptr_t data);

回调函数比较简单，第一个参数是当前请求，第二个是需要设置或者获取的变量值，第三个是初始化时的回调指针，这里我们着重来看一下ngx_http_variable_value_t,下面就是这个结构体的原型:

  1. typedef struct {
  2.     unsigned    len:28;
  3.  
  4.     unsigned    valid:1;
  5.     unsigned    no_cacheable:1;
  6.     unsigned    not_found:1;
  7.     unsigned    escape:1;
  8.     u_char     *data;
  9. } ngx_variable_value_t;

这里主要是data域，当我们在get_handle中设置变量值的时候，只需要将对应的值放入到data中就可以了，这里data需要在get_handle中分配内存,比如下面的例子(ngx_http_fastcgi_script_name_variable),就是fastcgi_script_name变量的get_handler代码片段:

  1. v->len = f->script_name.len + flcf->index.len;
  2.  
  3. v->data = ngx_pnalloc(r->pool, v->len);
  4. if (v->data == NULL) {
  5.         return NGX_ERROR;
  6. }
  7.  
  8. p = ngx_copy(v->data, f->script_name.data, f->script_name.len);
  9. ngx_memcpy(p, flcf->index.data, flcf->index.len);

使用变量

Nginx的内部变量指的就是Nginx的官方模块中所导出的变量，在Nginx中，大部分常用的变量都是CORE HTTP模块导出的。而在Nginx中，不仅可以在模块代码中使用变量，而且还可以在配置文件中使用。

假设我们需要在配置文件中使用http模块的host变量，那么只需要这样在变量名前加一个$符号就可以了($host).而如果需要在模块中使用host变量，那么就比较麻烦，Nginx提供了下面几个接口来取得变量:

  1. ngx_http_variable_value_t *ngx_http_get_indexed_variable(ngx_http_request_t *r,
  2.     ngx_uint_t index);
  3. ngx_http_variable_value_t *ngx_http_get_flushed_variable(ngx_http_request_t *r,
  4.     ngx_uint_t index);
  5. ngx_http_variable_value_t *ngx_http_get_variable(ngx_http_request_t *r,
  6.     ngx_str_t *name, ngx_uint_t key);

他们的区别是这样子的，ngx_http_get_indexed_variable和ngx_http_get_flushed_variable都是用来取得有索引的变量，不过他们的区别是后一个会处理 NGX_HTTP_VAR_NOCACHEABLE这个标记，也就是说如果你想要cache你的变量值，那么你的变量属性就不能设置NGX_HTTP_VAR_NOCACHEABLE,并且通过ngx_http_get_flushed_variable来获取变量值.而ngx_http_get_variable和上面的区别就是它能够得到没有索引的变量值.

通过上面我们知道可以通过索引来得到变量值，可是这个索引该如何取得呢，Nginx也提供了对应的接口：

  1. ngx_int_t ngx_http_get_variable_index(ngx_conf_t *cf, ngx_str_t *name);

通过这个接口，就可以取得对应变量名的索引值。

接下来来看对应的例子，比如在http_log模块中，如果在log_format中配置了对应的变量，那么它会调用ngx_http_get_variable_index来保存索引:

  1. static ngx_int_t
  2. ngx_http_log_variable_compile(ngx_conf_t *cf, ngx_http_log_op_t *op,
  3.     ngx_str_t *value)
  4. {
  5.     ngx_int_t  index;
  6.     //得到变量的索引
  7.     index = ngx_http_get_variable_index(cf, value);
  8.     if (index == NGX_ERROR) {
  9.         return NGX_ERROR;
  10.     }
  11.  
  12.     op->len = 0;
  13.     op->getlen = ngx_http_log_variable_getlen;
  14.     op->run = ngx_http_log_variable;
  15.     //保存索引值
  16.     op->data = index;
  17.  
  18.     return NGX_OK;
  19.  }

然后http_log模块会使用ngx_http_get_indexed_variable来得到对应的变量值,这里要注意，就是使用这个接口的时候，判断返回值，不仅要判断是否为空，也需要判断value->not_found,这是因为只有第一次调用才会返回空，后续返回就不是空，因此需要判断value->not_found:

  1. static u_char *
  2. ngx_http_log_variable(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op)
  3. {
  4.     ngx_http_variable_value_t  *value;
  5.     //获取变量值
  6.     value = ngx_http_get_indexed_variable(r, op->data);
  7.  
  8.     if (value == NULL || value->not_found) {
  9.             *buf = '-';
  10.             return buf + 1;
  11.     }
  12.  
  13.     if (value->escape == 0) {
  14.             return ngx_cpymem(buf, value->data, value->len);
  15.  
  16.     } else {
  17.             return (u_char *) ngx_http_log_escape(buf, value->data, value->len);
  18.     }
  19.  }

upstream

使用subrequest访问upstream

超越upstream

event机制

例讲（主动健康检查模块）

使用lua模块