nginx phase handler的原理和选择

最新推荐文章于 2022-07-30 00:51:29 发布

原创最新推荐文章于 2022-07-30 00:51:29 发布 · 6k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#nginx #数据结构 #架构 #服务器

nginx 专栏收录该内容

13 篇文章

订阅专栏

本文深入探讨了Nginx phasehandler的概念、种类及其在HTTP请求处理流程中的执行顺序。重点分析了如何注册自定义模块以挂载在不同阶段，以及如何选择合适的阶段以实现特定功能。同时，详细介绍了不同阶段的功能和它们之间的相互作用，为开发者提供了优化Nginx配置和提高性能的指导。

nginx phase handler的原理和选择

PHASE HANDLER的种类

nginx在接收并解析完请求行，请求头之后，就会依次调用各个phase handler。 phase handler是完成nginx主要功能的阶段。

Nginx有如下11种phase，phase会依次执行。同一个phase，可能会挂载多个handler。其中斜体加粗的phase，不允许挂载用户自定义的handler

PHASE	备注
NGX_HTTP_POST_READ_PHASE	读取请求内容阶段
NGX_HTTP_SERVER_REWRITE_PHASE	Server请求地址重写阶段
*NGX_HTTP_FIND_CONFIG_PHASE*	配置查找阶段
NGX_HTTP_REWRITE_PHASE	Location请求地址重写阶段
*NGX_HTTP_POST_REWRITE_PHASE*	请求地址重写提交阶段
NGX_HTTP_PREACCESS_PHASE	访问权限检查准备阶段
NGX_HTTP_ACCESS_PHASE	访问权限检查阶段
*NGX_HTTP_POST_ACCESS_PHASE*	访问权限检查提交阶段
*NGX_HTTP_TRY_FILES_PHASE*	配置项try_files处理阶段
NGX_HTTP_CONTENT_PHASE	内容产生阶段
NGX_HTTP_LOG_PHASE	日志模块处理阶段

如何注册phase handler

一般情况下，我们自定义的模块，大多数是挂载在NGX_HTTP_CONTENT_PHASE阶段的。挂载的动作一般是在模块上下文调用的postconfiguration函数中。

挂载的代码示例如下：

static ngx_int_t
ngx_http_hello_init(ngx_conf_t *cf)    // postconfiguration hook点
{
        ngx_http_handler_pt        *h;
        ngx_http_core_main_conf_t  *cmcf;

        cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);

        h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
        if (h == NULL) {
                return NGX_ERROR;
        }

        *h = ngx_http_hello_handler;

        return NGX_OK;
}

cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers 是content phase阶段的handler数组，类似的:

cmcf->phases[NGX_HTTP_SERVER_REWRITE_PHASE].handlers
cmcf->phases[NGX_HTTP_REWRITE_PHASE].handlers
cmcf->phases[NGX_HTTP_PREACCESS_PHASE].handlers
。。。
每个可挂载的phase，都有一个phase handler数组, 你可以选择挂载在不同的phase数组里

Nginx在解析http的配置时，会将多个phase handler数组，合成为一个数组

static char *
ngx_http_block(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)  // http指令的hook函数
{
    。。。 
    for (m = 0; ngx_modules[m]; m++) {
        if (ngx_modules[m]->type != NGX_HTTP_MODULE) {
            continue;
        }

        module = ngx_modules[m]->ctx;

        if (module->postconfiguration) {
            if (module->postconfiguration(cf) != NGX_OK) {// 执行各模块的postconfigure hook, phase handler就在此时挂载
                return NGX_CONF_ERROR;
            }
        }
　　}
　　。。。
　　
　　if (ngx_http_init_phase_handlers(cf, cmcf) != NGX_OK) {// 将多个phase handler数组，合成为一个数组
　　    return NGX_CONF_ERROR;
　　}
   。。。
}

ngx_http_init_phase_handlers(cf, cmcf) 函数将(除log phase以外的)几个phase handler数组，合成为一个ngx_http_phase_handler_t类型的数组

struct ngx_http_phase_handler_s {
    ngx_http_phase_handler_pt  checker; // 检查handler返回结果，决定下一个执行的handler
    ngx_http_handler_pt        handler; // handler 钩子
    ngx_uint_t                 next;    // 指向下一个phase的第一个handler
};

以下是不同的phase，对应不同的checker函数

PHASE	checker
NGX_HTTP_POST_READ_PHASE	ngx_http_core_generic_phase
NGX_HTTP_SERVER_REWRITE_PHASE	ngx_http_core_rewrite_phase
*NGX_HTTP_FIND_CONFIG_PHASE*	ngx_http_core_find_config_phase
NGX_HTTP_REWRITE_PHASE	ngx_http_core_rewrite_phase
*NGX_HTTP_POST_REWRITE_PHASE*	ngx_http_core_post_rewrite_phase
NGX_HTTP_PREACCESS_PHASE	ngx_http_core_generic_phase
NGX_HTTP_ACCESS_PHASE	ngx_http_core_access_phase
*NGX_HTTP_POST_ACCESS_PHASE*	ngx_http_core_post_access_phase
*NGX_HTTP_TRY_FILES_PHASE*	ngx_http_core_try_files_phase
NGX_HTTP_CONTENT_PHASE	ngx_http_core_content_phase
NGX_HTTP_LOG_PHASE	ngx_http_core_generic_phase

Phase handler如何执行

nginx在接收并解析完请求行，请求头之后，就会依次调用各个phase handler.

void
ngx_http_core_run_phases(ngx_http_request_t *r)
{
    ngx_int_t                   rc;
    ngx_http_phase_handler_t   *ph;
    ngx_http_core_main_conf_t  *cmcf;
    cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
    ph = cmcf->phase_engine.handlers;
    while (ph[r->phase_handler].checker) {
        rc = ph[r->phase_handler].checker(r, &ph[r->phase_handler]);
        if (rc == NGX_OK) {
            return;
        }
    }
}

可以看到，其实依次执行的就是我们在初始化阶段，生成的ngx_http_phase_handler_t 数组

我们通过debug，来看一下ngx_http_phase_handler_t数组的实际内容

运行中时ph数组的内容
数组下标	checker	handler	next
0	ngx_http_core_rewrite_phase	ngx_http_rewrite_handler	1
1	ngx_http_core_find_config_phase	0	0
2	ngx_http_core_rewrite_phase	ngx_http_rewrite_handler	3
3	ngx_http_core_post_rewrite_phase	0	1
4	ngx_http_core_generic_phase	ngx_http_l7waf_handler	7
5	ngx_http_core_generic_phase	ngx_http_limit_req_handler	7
6	ngx_http_core_generic_phase	ngx_http_limit_conn_handler	7
7	ngx_http_core_access_phase	ngx_http_access_handler	10
8	ngx_http_core_access_phase	ngx_http_auth_basic_handler	10
9	ngx_http_core_post_access_phase	0	10
10	ngx_http_core_try_files_phase	0	0
11	ngx_http_core_content_phase	ngx_http_index_handler	14
12	ngx_http_core_content_phase	ngx_http_autoindex_handler	14
13	ngx_http_core_content_phase	ngx_http_static_handler	14
14	0	0	0

我们来看一个具体的checker函数

ngx_int_t
ngx_http_core_generic_phase(ngx_http_request_t *r, ngx_http_phase_handler_t *ph)
{
    ngx_int_t  rc;

    /*
     * generic phase checker,
     * used by the post read and pre-access phases
     */

    ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
                   "generic phase: %ui", r->phase_handler);

    rc = ph->handler(r);          // 执行挂载的handler

    if (rc == NGX_OK) {           // 返回值是NGX_OK，说明这个phase执行完了，跳到下一个phase的第一个handler去
        r->phase_handler = ph->next;
        return NGX_AGAIN;
    }

    if (rc == NGX_DECLINED) {     // 返回值NGX_DECLINED，继续执行这个phase的下一个handler
        r->phase_handler++;
        return NGX_AGAIN;
    }

    if (rc == NGX_AGAIN || rc == NGX_DONE) { //说明请求处理完了。下面所有的phase handler都不需要再执行了
        return NGX_OK;
    }

    /* rc == NGX_ERROR || rc == NGX_HTTP_...  */

    ngx_http_finalize_request(r, rc);        // 返回错误，结束请求，返回相应的错误页

    return NGX_OK;
}