变量也是nginx的一大亮点,这也使得nginx更加灵活了,变量的语法格式为 $XXX 或 ${xxxx}
首先说下变量的分类,变量分为内置和自定义,网络不少对变量的描述都不太准确,他们认为但凡不是nginx原生的变量都是属于自定义,这么说其实也可以,但严格来说,
内置变量应该是但凡编译到代码里的都是内置,通用性强
自定义的仅限于配置文件中,局限性小
编译进代码的不仅包含ng原生的,也含我们的第三方模块定义的变量。
自定义的如set $my_var "hello world";
location / {
add_header My-Var $my_var;
}
内置的都是需要编译到代码中的
ng原生变量的就太多了,实现文件在ngx_http_variables.c 和 ngx_stream_variables.c
内置变量需要在代码里定义,并且调用对应的接口
ngx_http_add_variable 或ngx_stream_add_variable添加到全局中去,内置变量由ng框架进行维护和管理。
变量的抽象定义如下(以下都http为例,stream类同):
struct ngx_http_variable_s {
ngx_str_t name ;//变量名
ngx_http_set_variable_pt set_handler ;//变量的set方法,即写
ngx_http_get_variable_pt get_handler;//变量的get方法,即读
uintprt_t data ;//调用方法时,传递的参数,即变量挂载的任意数据指针,调用get和set的时候会透传
ngx_uint_t flags; //变量标签特性,NGX_HTTP_VAR_CHANGEABLE ,NGX_HTTP_VAR_NOCACHEABLE
ngx_uint_t index;//变量的索引值,内置变量都在存储在一个全局的数组中的,通过下标去读取变量是最快的,nginx在启动的时候会初始化
}
有了变量,就肯定要涉及到变量的类型。先看
表示变量值的结构体:
typedef ngx_variable_value_t ngx_http_variable_value_t;
typedef struct {
unsigned len:28;
unsigned valid:1;
unsigned no_cacheable:1;
unsigned not_found:1;
unsigned escape:1;
u_char *data;
} ngx_variable_value_t;
结构体并未指出变量的类型,其实变量其本质就是一块内存,nginx无法确定变量的具体类型,于是通过长度确定,由使用者去“强转”
在c语言内,任何类型 变量其实就是一块内存,有了内存首地址,还有长度,就够了。
比如是int类型,对data指向的字符串进行转整数即可
还是可以二进制的,比如
v->len = sizeof(in_addr_t);
v->data = (u_char *) &sin->sin_addr;
ng有几个原生的地址变量就是二进制的。
ngx_http_add_variable 或ngx_stream_add_variable添加到全局中后,任意模块任何地方都可以使用之。
变量有了,变量主要就是拿来使用的,否则就没意义,使用最基本肯定是读,变量存储了我们想存储的数据
再看下读写方法定义
读:
typedef ngx_int_t (*ngx_http_get_variable_pt ) (ngx_http_request* r,ngx_http_variable_value_t *v , uintptr_t data) ;
写:
typedef void (*ngx_http_set_variable_pt )(ngx_http_request* r,ngx_http_variable_value_t *v , uintptr_t data)
第二个参数就是变量值,需要我们填充该结构体,data则是我们在ngx_http_add_variable时,填充到ngx_http_variable_s 结构体中的data,在某个地方使用了你的变量,那么ng就会调用 你定义好的 get_handler来获取变量的值
代码实例:
配置:
server {
listen 9999;
location / {
proxy_pass ${my_http_url} ;
}
}
访问9999端口,ng则会代理到 ${my_http_url}存储的url地址去。
在代码里 实现get方法
ngx_str_t myurl = ngx_string("127.0.0.1:6666") ;
ngx_int_t my_get_handler(ngx_http_request* r,ngx_http_variable_value_t *v , uintptr_t data)
{
v->len = myurl .len;
v->data = myurl .data ;
v->valid = 1 ;//这个必须置1
v->not_found=0;//必须置0
v->no_cachebale = 0 ;
return NGX_OK ;
}
当有人访问9999端口时,ng就会调用我们定义好的get方法来取这个url地址,该地址ng自己去解析使用,如此可以实现动态的代理,比如可以根据不同的 请求r 来实现不同的代理地址。
ng的变量具体框架实现 其实还是很复杂的,代码量也是比较大的