nginx模块开发-增加nginx内置变量
然而在nginx中，我们还可以直接用下面的变量，直接就可以获取对应的值。
$arg_参数名 在location中获取客户端请求的参数xx?name=123 那$arg_name就是对应的值123
$args, 请求中的参数字符串 比如 name=123&age=24
$content_length, HTTP请求信息里的"Content-Length"
$content_type, 请求信息里的"Content-Type"
$host, 请求信息中的"Host"，如果请求中没有Host行，则等于设置的服务器名
$request_method, 请求的方法，比如"GET"、"POST"等
$remote_addr, 客户端地址
$remote_port, 客户端端口号
$remote_user, 客户端用户名，认证用;
$request_filename, 当前请求的文件路径名
$request_uri, 请求的URI，带参数
$query_string, 与$args相同
$scheme, 所用的协议，比如http或者是https，比如rewrite ^(.+)$ $scheme://example.com$1 redirect
$server_protocol, 请求的协议版本，"HTTP/1.0"或"HTTP/1.1"
$server_addr, 服务器地址
$server_name, 请求到达的服务器名
$server_port, 请求到达的服务器端口号
$uri, 请求的URI，可能和最初的值有不同，比如经过重定向之类的
$http_header参数名 可以用来获得header的值，比如$http_user_agent 就是获取header中的UA
...
上述的一堆变量，被称为nginx的内置变量，这些变量是在nginx启动的时候就被加载进去的，而且不同的模块会加载不同的内置变量。
static ngx_http_module_t ngx_http_x_module_ctx = {
NULL, /* preconfiguration 在创建和读取该模块的配置信息之前被调用。*/
ngx_http_x_post_config, /* postconfiguration 在创建和读取该模块的配置信息之后被调用。*/
NULL, /* create main configuration 调用该函数创建本模块位于http block的配置信息存储结构。该函数成功的时候，返回创建的配置对象。失败的话，返回NULL。*/
NULL, /* init main configuration 调用该函数初始化本模块位于http block的配置信息存储结构。该函数成功的时候，返回NGX_CONF_OK。失败的话，返回NGX_CONF_ERROR或错误字符串*/
NULL, /* create server configuration 调用该函数创建本模块位于http server block的配置信息存储结构，每个server block会创建一个。该函数成功的时候，返回创建的配置对象。失败的话，返回NULL。*/
NULL, /* merge server configuration 因为有些配置指令既可以出现在http block，也可以出现在http server block中。那么遇到这种情况，每个server都会有自己存储结构来存储该server的配置，
但是在这种情况下http block中的配置与server block中的配置信息发生冲突的时候，就需要调用此函数进行合并，该函数并非必须提供，当预计到绝对不会发生需要合并的情况的时候，就无需提供。当然为了安全起见还是建议提供。
该函数执行成功的时候，返回NGX_CONF_OK。失败的话，返回NGX_CONF_ERROR或错误字符串。*/
NULL, /* create location configuration 调用该函数创建本模块位于location block的配置信息存储结构。每个在配置中指明的location创建一个。该函数执行成功，返回创建的配置对象。失败的话，返回NULL。*/
NULL /* merge location configuration 与merge_srv_conf类似，这个也是进行配置值合并的地方。该函数成功的时候，返回NGX_CONF_OK。失败的话，返回NGX_CONF_ERROR或错误字符串。*/
};定义模块的ctx的时候在postconfiguration阶段定义加载内置变量的函数。
static ngx_http_variable_t ngx_http_x_variables[] = {// 定义echo模块的变量
{ ngx_string("x_request_method"), NULL,
ngx_http_x_request_method_variable, 0,
NGX_HTTP_VAR_NOCACHEABLE, 0 },
{ ngx_string("x_request_uri"), NULL,
ngx_http_x_request_uri_variable, 0,
0, 0 },
...
{ ngx_null_string, NULL, NULL, 0, 0, 0 }
} ngx_http_variable_t 的定义在ngx_http_variables.h中
typedef struct ngx_http_variable_s ngx_http_variable_t;
struct ngx_http_variable_s {
ngx_str_t name; //变量的名称
ngx_http_set_variable_pt set_handler;//变量的设置函数回调
ngx_http_get_variable_pt get_handler;//变量的获取函数回调
uintptr_t data;//传递给回调的参数
ngx_uint_t flags;//flags表示变量的属性，index提供了一个索引(数组的脚标)
ngx_uint_t index;
};flag属性就是由下面的几个属性组合而成:#define NGX_HTTP_VAR_CHANGEABLE 1
#define NGX_HTTP_VAR_NOCACHEABLE 2
#define NGX_HTTP_VAR_INDEXED 4
#define NGX_HTTP_VAR_NOHASH 8
NGX_HTTP_VAR_CHANGEABLE
NGX_HTTP_VAR_NOCACHEABLE表示这个变量每次都要去取值，而不是直接返回上次cache的值(配合对应的接口).
NGX_HTTP_VAR_INDEXED表示这个变量是用索引读取的.
NGX_HTTP_VAR_NOHASH表示这个变量不需要被hash.
static ngx_int_t
ngx_http_x_post_config(ngx_conf_t *cf)
{
...
增加自己的var 变量到nginx里面
ngx_http_variable_t *var, *v;
for (v = ngx_http_x_variables; v->name.len; v++) {
var = ngx_http_add_variable(cf, &v->name, v->flags);
if (var == NULL) {
return NGX_ERROR;
}
var->get_handler = v->get_handler;
var->data = v->data;
}
return NGX_OK;//
}在postconfiguration的回调中将自定义的变量加入nginx中，这样就可以直接在配置文件中用$x_request_uri获得ngx_http_x_request_uri_variable函数的返回值。
最后看一下获取变量值的函数
ngx_int_t ngx_http_x_request_uri_variable(ngx_http_request_t *r,
ngx_http_variable_value_t *v, uintptr_t data)
{
if (r->uri.len) {
v->len = r->uri.len;
v->valid = 1;
v->no_cacheable = 1;
v->not_found = 0;
v->data = r->uri.data;
} else {
v->not_found = 1;
}
return NGX_OK;
}
以上就介绍了nginx模块开发-增加nginx内置变量，包括了方面的内容，希望对PHP教程有兴趣的朋友有所帮助。