[开发记录]Nginx模块开发(二)

引言：Nginx模块提供了upstream（上游服务器）的异步回调处理模块开发，以memcached 模块为例

commands结构的初始化为相应的命令添加回调函数，用来处理 memcached_pass 这个命令

static ngx_command_t  ngx_http_memcached_commands[] = {

    { ngx_string("memcached_pass"),
      NGX_HTTP_LOC_CONF|NGX_HTTP_LIF_CONF|NGX_CONF_TAKE1,
      ngx_http_memcached_pass,  // 这里添加回调
      NGX_HTTP_LOC_CONF_OFFSET,
      0,
      NULL },
     .....
}

看看 ngx_http_memcached_pass 的实现：

此函数会对 conf 做一些初始化操作

static char *
ngx_http_memcached_pass(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
    ngx_http_memcached_loc_conf_t *mlcf = conf;

    ngx_str_t                 *value;
    ngx_url_t                  u;
    ngx_http_core_loc_conf_t  *clcf;

    if (mlcf->upstream.upstream) {
        return "is duplicate";
    }

    value = cf->args->elts;

    ngx_memzero(&u, sizeof(ngx_url_t));

    u.url = value[1];
    u.no_resolve = 1;

    mlcf->upstream.upstream = ngx_http_upstream_add(cf, &u, 0);
    if (mlcf->upstream.upstream == NULL) {
        return NGX_CONF_ERROR;
    }

    clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);

    clcf->handler = ngx_http_memcached_handler; //为此请求添加回调

    if (clcf->name.data[clcf->name.len - 1] == '/') {
        clcf->auto_redirect = 1;
    }

    mlcf->index = ngx_http_get_variable_index(cf, &ngx_http_memcached_key);

    if (mlcf->index == NGX_ERROR) {
        return NGX_CONF_ERROR;
    }

    return NGX_CONF_OK;
}

整个模块的定义：

ngx_http_memcached_commands 是传入的变量

ngx_http_memcached_module_ctx 是模块的 context 结构

此结构存储了所有的为配置信息初始化的回调函数

ngx_module_t  ngx_http_memcached_module = {
    NGX_MODULE_V1,
    &ngx_http_memcached_module_ctx,        /* module context */
    ngx_http_memcached_commands,           /* module directives */
    NGX_HTTP_MODULE,                       /* module type */
    NULL,                                  /* init master */
    NULL,                                  /* init module */
    NULL,                                  /* init process */
    NULL,                                  /* init thread */
    NULL,                                  /* exit thread */
    NULL,                                  /* exit process */
    NULL,                                  /* exit master */
    NGX_MODULE_V1_PADDING
};

static ngx_http_module_t  ngx_http_memcached_module_ctx = {
    NULL,                                  /* preconfiguration */
    NULL,                                  /* postconfiguration */

    NULL,                                  /* create main configuration */
    NULL,                                  /* init main configuration */

    NULL,                                  /* create server configuration */
    NULL,                                  /* merge server configuration */

    ngx_http_memcached_create_loc_conf,    /* create location configration */
    ngx_http_memcached_merge_loc_conf      /* merge location configration */
};

回调 ngx_http_memcached_create_loc_conf 用来为配置信息分配存储空间并初始化

以后需要使用到配置信息的参数的时候使用方式如下：

    ngx_http_memcached_loc_conf_t  *mlcf;
    mlcf = ngx_http_get_module_loc_conf(r, ngx_http_memcached_module);

其中 ngx_http_memcached_loc_conf_t 是自己定义的配置信息的结构

memcached 模块的定义如下：

typedef struct {
    ngx_http_upstream_conf_t   upstream;
    ngx_int_t                  index;
} ngx_http_memcached_loc_conf_t;

这些都是初始化的操作，看看核心函数：

ngx_http_memcached_handler

static ngx_int_t
ngx_http_memcached_handler(ngx_http_request_t *r)
{
    ngx_int_t                       rc;
    ngx_http_upstream_t            *u;
    ngx_http_memcached_ctx_t       *ctx;
    ngx_http_memcached_loc_conf_t  *mlcf;

    if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD))) {
        return NGX_HTTP_NOT_ALLOWED;
    }

    rc = ngx_http_discard_request_body(r);

    if (rc != NGX_OK) {
        return rc;
    }

    if (ngx_http_set_content_type(r) != NGX_OK) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }
    // 创建一个 upstream
23     if (ngx_http_upstream_create(r) != NGX_OK) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }
    //取得这个 upstream
27     u = r->upstream;

    ngx_str_set(&u->schema, "memcached://");
    u->output.tag = (ngx_buf_tag_t) &ngx_http_memcached_module;

    ngx_http_memcached_loc_conf_t  *mlcf;
    mlcf = ngx_http_get_module_loc_conf(r, ngx_http_memcached_module);

    u->conf = &mlcf->upstream;
    //为 upstream 添加回调
37     u->create_request = ngx_http_memcached_create_request;     //创建到 upstream的后端请求
38     u->reinit_request = ngx_http_memcached_reinit_request;     //失败后再次创建
39     u->process_header = ngx_http_memcached_process_header;     //处理来自后端的数据
40     u->abort_request = ngx_http_memcached_abort_request;       //放弃数据
41     u->finalize_request = ngx_http_memcached_finalize_request; //析构这个请求

    ctx = ngx_palloc(r->pool, sizeof(ngx_http_memcached_ctx_t));
    if (ctx == NULL) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }

    ctx->rest = NGX_HTTP_MEMCACHED_END;
    ctx->request = r;

    ngx_http_set_ctx(r, ctx, ngx_http_memcached_module);

    u->input_filter_init = ngx_http_memcached_filter_init;
    u->input_filter = ngx_http_memcached_filter;
    u->input_filter_ctx = ctx;

    r->main->count++;

59     ngx_http_upstream_init(r);

    return NGX_DONE;
}

其中可以看到， 大部分的回调都是传入参数 ngx_http_request_t *r

static ngx_int_t ngx_http_memcached_create_request(ngx_http_request_t *r);
static ngx_int_t ngx_http_memcached_reinit_request(ngx_http_request_t *r);
static ngx_int_t ngx_http_memcached_process_header(ngx_http_request_t *r);
static ngx_int_t ngx_http_memcached_filter_init(void *data);
static ngx_int_t ngx_http_memcached_filter(void *data, ssize_t bytes);
static void ngx_http_memcached_abort_request(ngx_http_request_t *r);
static void ngx_http_memcached_finalize_request(ngx_http_request_t *r,
    ngx_int_t rc);

函数处理时候会通过 r 取得 upstream并做一番”加工“

create_request 的时候会有 r -> upstream = u ;

设置完这几个回调函数以后，就会为相应的请求添加这个回调，来自下游的服务器的请求会被分发到upstream中去，但是Nginx在本身的转发过程中是不阻塞的