Nginx源码分析之变量

最新推荐文章于 2024-03-31 15:38:51 发布

Leopard_89

最新推荐文章于 2024-03-31 15:38:51 发布

阅读量326

点赞数

分类专栏： nginx

本文链接：https://blog.csdn.net/Leopard_89/article/details/109563785

版权

nginx 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

变量的使用示例

server {
    listen 80;
    server_name www.test.com;


    set $var1 "test";

    location ~* ^/([0-9]+)/ {
        if ($1 = 200) {
            return 200;
        }

        content_by_lua_block {
            ngx.print(ngx.var.var1)
            ngx.print(ngx.var.http_host)
        }
    }
}

map $host $var_2 {
    default '-';
    \S "test2";
}

关于nginx的变量

变量的定义方法有三种，var1是用set指令定义的；变量$1 是正则匹配出来的；变量var_2是用map指令定义的。

http_host并不是前面三种方法定义的变量，它是属于"前缀变量"，它的前缀是"http_"，表示从请求头中取值。常见的前缀有"http_" ，"sent_http_"从响应头中取值的前缀，"arg_"从参数取值的前缀，"cookie_"从cookie中取值的前缀。

变量的添加函数

无论用那种方法定义变量，在nginx代码中都调用相同的函数ngx_http_add_variable。

首先检查flags判断变量是否属于"前缀变量"，如果添加的变量属于前缀变量，会加到cmcf->prefix_variables中。

如果不是前缀变量则在cmcf->variables_keys里面找，找到则返回，找不到则调用ngx_hash_add_key，将变量加到cmcf->variables_keys数组。

ngx_http_variable_t
ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name, ngx_uint_t flags)
{
    if (flags & NGX_HTTP_VAR_PREFIX) {
        return ngx_http_add_prefix_variable(cf, name, flags);
    }

    cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);

    key = cmcf->variables_keys->keys.elts;
    for (i = 0; i < cmcf->variables_keys->keys.nelts; i++) {
        
        if (name->len != key[i].key.len
            || ngx_strncasecmp(name->data, key[i].key.data, name->len) != 0)
        {
            continue;
        }
        
        //... 查找变量名name是否已经被定义，如果找到则直接返回
        
    }

    //...

    rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v, 0);
}

ngx_hash_add_key 都干了什么

变量值的获取

调用函数ngx_http_get_variable。

ngx_http_variable_value_t *
ngx_http_get_variable(ngx_http_request_t *r, ngx_str_t *name, ngx_uint_t key)
{
    v = ngx_hash_find(&cmcf->variables_hash, key, name->data, name->len);
    if (v) {
        if (v->flags & NGX_HTTP_VAR_INDEXED) {
            return ngx_http_get_flushed_variable(r, v->index);
        }

        if (ngx_http_variable_depth == 0) {
            ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
                          "cycle while evaluating variable \"%V\"", name);
            return NULL;
        }

        ngx_http_variable_depth--;

        vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));

        if (vv && v->get_handler(r, vv, v->data) == NGX_OK) {
            ngx_http_variable_depth++;
            return vv;
        }

        ngx_http_variable_depth++;
        return NULL;
    }

    v = cmcf->prefix_variables.elts;
    n = cmcf->prefix_variables.nelts;

    for (i = 0; i < cmcf->prefix_variables.nelts; i++) {
        if (name->len >= v[i].name.len && name->len > len
            && ngx_strncmp(name->data, v[i].name.data, v[i].name.len) == 0)
        {
            len = v[i].name.len;
            n = i;
        }
    }

    if (n != cmcf->prefix_variables.nelts) {
        if (v[n].get_handler(r, vv, (uintptr_t) name) == NGX_OK) {
            return vv;
        }

        return NULL;
    }
}