Nginx_handler模块发开（hello模块结构解析）

声明：请在文章页面明显位置给出原文连接 http://www.cnblogs.com/paulweihan/p/4654173.html，否则保留追究法律责任的权利。

近期查了非常多资料。入门的样例都是ngx_http_hello(or mytest)_module.

最主要是參考http://tengine.taobao.org/book/chapter_03.html#config 站点以及

《深入理解Nginx模块发开与架构解析》一书。但感觉讲的都不够清楚。书上讲的太复杂，側重结构体解析，以下贴出我的理解，欢迎大家谈论。联系方式：rwhsysu@163.com 。

（读本日志，希望你首先对于Nginx有个基本了解。其次，手头有一份Nginx源代码，一份gx_http_hello(or mytest)_module.c源代码）

本文不涉及hello模块文件夹下的config文件以及编译时加入的add-module指令，注重对于模块源代码的结构的理解，用于理清作者本人和您的思路。

对于上面站点上和书上强调的非常清楚的各个结构的定义，本文不做赘述。（太占篇幅-_-|||），參考资料里面讲的非常详细非常清楚，本文着重描写叙述自己的理解。如有对结构定义疑问。请读者自行參考上面提到的书以及站点

对于ngx_http_hello(or mytest)_module内定义的数据结构与函数的理解见下图：

上面图里包含了我对这个入门模块的结构的理解，解释例如以下：

实现一个handler的步骤:

1. 编写模块基本结构。包含模块的定义，模块上下文结构，模块的配置结构等。
2. 假设有loc_conf，须要定义自己loc_conf结构，以及conf结构创建。赋值函数。

3. 实现handler的挂载函数。依据模块的需求选择正确的挂载方式。
4. 编写handler处理函数。

   模块的功能主要通过这个函数来完毕。

这些结构域函数之间的包含关系见上面的图。

以下说说我个人对这些模块和函数的理解。

Num 1：模块定义结构

ngx_module_t ngx_http_hello_module;

对于开发一个模块来说。我们都须要定义一个ngx_module_t类型的变量来说明这个模块本身的信息。从某种意义上来说。这是这个模块最重要的一个信息，它告诉了nginx这个模块的一些信息，上面定义的配置信息。还有模块上下文信息。都是通过这个结构来告诉nginx系统的，也就是载入模块的上层代码，都须要通过定义的这个结构。来获取这些信息。

这个模块中最主要要定义的就是CTX上下文结构与commands配置结构数组。

Num 2：上下文结构

ngx_http_module_t ngx_http_hello_module_ctx;

这是一个ngx_http_module_t类型的静态变量。

这个变量实际上是提供一组回调函数指针，这些函数有在创建存储配置信息的对象的函数，也有在创建前和创建后会调用的函数。这些函数都将被nginx在合适的时间进行调用。

这个样例中，该结构最重要的是

• 调用了一个handler挂载函数ngx_http_hello_init
• 调用了一个loc_conf创建函数ngx_http_hello_create_loc_conf

Num 3：模块的配置结构

ngx_command_t ngx_http_hello_commands[];

在我的理解里，这个数组实现的功能是将我们在nginx.conf文件里定义的配置读取并存储进loc_conf结构中。conf结构已经在上下文结构中被创建。

Num 4：loc_conf与其创建赋值函数

本样例中，定义了一个结构体：

typedef struct
{
        ngx_str_t hello_string;
        ngx_int_t hello_counter;
}ngx_http_hello_loc_conf_t;

该结构体储存了本模块的配置变量。通过上下文结构中的调用的ngx_http_hello_create_loc_conf函数创建。通过配置结构中的ngx_http_hello_string以及ngx_http_hello_counter函数赋值。

（详细实现代码不贴了，请读者自行查询hello模块源代码）

Num 5：handler 挂载函数

ngx_int_t ngx_http_hello_init

该函数在上下文结构中被调用，决定了handler函数详细在11个PHASE中的哪个PHASE被调用。关于PHASE定义以及函数详细实现參看站点以及hello模块源代码。

Num 6：handler函数

static ngx_int_t
ngx_http_hello_handler(ngx_http_request_t *r)
{
}

关于这个函数，没什么好说的，他实现了对于整个request的处理，依据loc_conf的不同，处理方式也不同。

待续：上面仅仅介绍了hello模块涉及的数据结构以及函数的关系以及其相关功能，理清了hello模块是怎样工作的：详细体如今，在哪些结构中调用了哪些函数。

对于基本的两个数据结构ngx_conf_t ngx_http_request_t是怎样传递和实现的并未解释。同一时候，并未联系上nginx的main函数进行总体的分析。

希望对你有帮助，欢迎讨论。