Nginx编写Hello World模块

142次阅读

共计 4292 个字符，预计需要花费 11 分钟才能阅读完成。

几个重要组成部分
ngx_command_t 数组

对于我们在 nginx.conf 中编写的配置项 mytest 来说，nginx 首先会遍历所有的模块（modules），而对于每个模块，会遍历他所对应的 ngx_command_t 数组，试图找到关于我们的配置项 mytest 的解析方式。
这里编写的 hello 模块的代码部分如下：

static ngx_command_t  ngx_http_mytest_commands[] =
{
  {ngx_string("mytest"),
      NGX_HTTP_MAIN_CONF | NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_HTTP_LMT_CONF | NGX_CONF_NOARGS,
      ngx_http_mytest,
      NGX_HTTP_LOC_CONF_OFFSET,
      0,
      NULL
  },
  ngx_null_command
};

command 中用于处理配置项参数的 set 方法

static char *
ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
  ngx_http_core_loc_conf_t  *clcf;

  // 首先找到 mytest 配置项所属的配置块，clcf 貌似是 location 块内的数据
// 结构，其实不然，它可以是 main、srv 或者 loc 级别配置项，也就是说在每个
//http{}和 server{}内也都有一个 ngx_http_core_loc_conf_t 结构体
  clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);

  //http 框架在处理用户请求进行到 NGX_HTTP_CONTENT_PHASE 阶段时，如果
// 请求的主机域名、URI 与 mytest 配置项所在的配置块相匹配，就将调用我们
// 实现的 ngx_http_mytest_handler 方法处理这个请求
  clcf->handler = ngx_http_mytest_handler;

  return NGX_CONF_OK;
}

关于 ngx_http_conf_get_module_loc_conf 的定义可以参考：http://lxr.nginx.org/source/src/http/ngx_http_config.h#0065 本质：就是设置 ngx_http_mytest_handler, 匹配项被选中的时候，应该如何解析。
定义 ngx_http_module_t 接口
这部分的代码，是用于 http 框架的，相当于 http 框架的回掉函数，由于这里并不需要框架做任何操作，所以全部设置成 NULL 即可。

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

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

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

  NULL,                   /* create location configuration */
  NULL                    /* merge location configuration */
};

定义 mytest 模块
mytest 模块的详细内容解析

这里的模块只需要设置三个内容：

ngx_module_t  ngx_http_mytest_module =
{
    NGX_MODULE_V1,
    &ngx_http_mytest_module_ctx,           /* module context */
    ngx_http_mytest_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
};

设置完成 ngx_module_t 数组后，mytest 模块在编译的时候，就可以被加入到 ngx_modules 的全局数组中了

处理用户请求的 hello world handler
该方法是配置项匹配之后的处理方法：

static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r)
{
    // 必须是 GET 或者 HEAD 方法，否则返回 405 Not Allowed
    if (!(r->method & (NGX_HTTP_GET | NGX_HTTP_HEAD)))
    {return NGX_HTTP_NOT_ALLOWED;}

    // 丢弃请求中的包体
    ngx_int_t rc = ngx_http_discard_request_body(r);
    if (rc != NGX_OK)
    {return rc;}

    // 设置返回的 Content-Type。注意，ngx_str_t 有一个很方便的初始化宏
//ngx_string，它可以把 ngx_str_t 的 data 和 len 成员都设置好
    ngx_str_t type = ngx_string("text/plain");
    // 返回的包体内容
    ngx_str_t response = ngx_string("Hello World!");
    // 设置返回状态码
    r->headers_out.status = NGX_HTTP_OK;
    // 响应包是有包体内容的，所以需要设置 Content-Length 长度
    r->headers_out.content_length_n = response.len;
    // 设置 Content-Type
    r->headers_out.content_type = type;

    // 发送 http 头部
    rc = ngx_http_send_header(r);
    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only)
    {return rc;}

    // 构造 ngx_buf_t 结构准备发送包体
    ngx_buf_t                 *b;
    b = ngx_create_temp_buf(r->pool, response.len);
    if (b == NULL)
    {return NGX_HTTP_INTERNAL_SERVER_ERROR;}
    // 将 Hello World 拷贝到 ngx_buf_t 指向的内存中
    ngx_memcpy(b->pos, response.data, response.len);
    // 注意，一定要设置好 last 指针
    b->last = b->pos + response.len;
    // 声明这是最后一块缓冲区
    b->last_buf = 1;

    // 构造发送时的 ngx_chain_t 结构体
    ngx_chain_t     out;
    // 赋值 ngx_buf_t
    out.buf = b;
    // 设置 next 为 NULL
    out.next = NULL;

    // 最后一步发送包体，http 框架会调用 ngx_http_finalize_request 方法
// 结束请求
    return ngx_http_output_filter(r, &out);
}

模块的源代码应该和 config 文件放到一个目录下面，然后在编译的时候加入参数，–add-module=PATH。其中 config 文件的内容如下所示：

ngx_addon_name=ngx_http_mytest_module
HTTP_MODULES="$HTTP_MODULES ngx_http_mytest_module"
NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_mytest_module.c"

配置 nginx.conf