nginx モジュール開発 - nginx 組み込み変数の追加

ご存知のとおり、nginx の set $xxx 'hello'; は、set 命令を使用して変数 xxx に hello の文字列値を設定することです。nginx で値を呼び出す場合、この変数を使用するために必要なのは $xxx だけです。

ただし、nginx では、次の変数を直接使用して、対応する値を直接取得することもできます。

$arg_parameter name location?name=123 でクライアントによって要求されたパラメータ xx を取得します。その場合、$arg_name は、対応する値 123 です
$args、name=123&age=24 などのリクエスト内のパラメータ文字列
$content_length、HTTP "リクエスト情報のContent-Length"
$content_type、リクエスト情報の"Content-Type"
$host、リクエスト情報の"Host"。リクエストにHost行がない場合は、設定したサーバーと同じになります。 name
$request_method、「GET」、「POST」などのリクエストメソッド。
$remote_addr、クライアントアドレス
$remote_port、クライアントポート番号
$remote_user、認証用のクライアントユーザー名
$request_filename、現在リクエストされている。ファイルパス名
$request_uri、リクエストの URI、パラメータ
$query_string、$args と同じ
$scheme、http や https などの使用されるプロトコル、書き換え ^(.+)$ $scheme: //example.com$1 redirect
$server_protocol、リクエストのプロトコル バージョン、「HTTP/1.0」または「HTTP/1.1」
$server_addr、サーバー アドレス
$server_name、リクエストが到着するサーバーの名前
$server_port、リクエストが到着するサーバーのポート番号
$uri、リダイレクト後など、リクエストされたURIは元の値と異なる場合があります。
$http_headerパラメータ名を使用して、たとえば、$http_user_agent はヘッダー内の UA を取得するためのものです。
...
これらの変数は nginx の組み込み変数と呼ばれ、nginx の起動時にロードされます。 -in変数。

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 を定義するときに、構成後のフェーズで組み込み変数をロードする関数を定義します。

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 N GX_HTTP_VAR_NOHASH 8
NGX_HTTP_VAR_CHANGEABLE
NGX_HTTP_VAR_NOCACHEABLE は、この変数が毎回使用されることを示します最後のキャッシュの値を直接返すのではなく、値を取得する必要があります (対応するインターフェースと連携します)。
NGX_HTTP_VAR_INDEXED は、この変数がインデックスを使用して読み取られることを意味します。
NGX_HTTP_VAR_NOHASH は、この変数をハッシュする必要がないことを意味します。

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;//
}

は、構成後のコールバックで 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 チュートリアルに興味のある友人に役立つことを願っています。