nginx 模块组成

潇洒紫焰

编写模块，需要实现下面5个部分

• 定义 ngx_module_t 模块结构体
  
• 定义commands
  
• 定义cxn
  
• 实现commands里对应的实现函数
  
• 实现handler函数 (command实现函数依赖handler函数)  (这个才是真正干活的)
  

说明各个函数部分的意义

commands
eg:

static ngx_command_t  ngx_echo_commands[] = {
{
ngx_string("echo"),  //指令名称
NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1, //指令适合出现位置 和 参数个数设置
ngx_echo_readconf,            //指令的回调函数.这个函数通常来替换核心模块的配置，指定自己的handler
NGX_HTTP_LOC_CONF_OFFSET,    //将数据保存在loc conf部分
offsetof(ngx_echo_loc_conf_t, ecdata), //接收的参数保存在结构体位置
NULL  //一般为空
},
ngx_null_command  //command结束标识
};

nginx提供了几个默认的转换函数:
ngx_conf_set_flag_slot：把“on”和“off”转成1和0
ngx_conf_set_str_slot：把字符串格式化为以ngx_str_t类型
ngx_conf_set_num_slot：解析数字并转换为一个整型
ngx_conf_set_size_slot：解析表示大小的值（“8k”，“1m”等）并格式化成size_t格式

commands实现函数 （command的回调函数）

• 这个函数一般是将配置文件中相关指令的参数转化成需要的格式并存入配置结构体
  
• 这个函数还将修改了核心模块配置（也就是这个location的配置），将其handler替换为我们编写的handler。这样就屏蔽了此location的默认handler，使用ngx_http_echo_handler产生HTTP响应。
  

static char *                                                           
ngx_http_circle_gif(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)     
{/*{{{*/                                                               
ngx_http_core_loc_conf_t  *clcf;                                    
ngx_http_circle_gif_loc_conf_t *cglcf = conf;                       
clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
clcf->handler = ngx_http_circle_gif_handler;                                                                                                
cglcf->enable = 1;                                                  
return NGX_CONF_OK;                                                
}/*}}}*/                                                               

context
这个机构主要是定义各个hook函数

static ngx_http_module_t  ngx_echo_module_ctx = {
NULL,           /* preconfiguration 读入配置前调用*/      ??? 全局配置读取前？
NULL,           /* postconfiguration 读入配置后调用*/     ??? 全局配置读取后?
NULL,          /* create main configuration 创建全局部分配置时调用*/
NULL,          /* init main configuration 初始化全局部分配置时调用*/
NULL,          /* create server configuration 创建虚拟主机部分时调用*/
NULL,          /* merge server configuration 与全局部分配置合并时调用*/
ngx_echo_create_loc_conf,  /* create location configuration  创建位置部分的配置时调用*/
ngx_echo_merge_loc_conf   /* merge location configuration    与主机部分配置合并时调用*/
};


create_loc_conf用于初始化一个配置结构体，如为配置结构体分配内存等工作；
merge_loc_conf用于将其父block的配置信息合并到此结构体中，也就是实现配置的继承。

handler
该函数的职责:

• 读入模块配置
  
• 处理功能业务
  
• 产生HTTP header
  
• 产生HTTP body
  

handler会接收一个ngx_http_request_t指针类型的参数，这个参数指向一个ngx_http_request_t结构体，此结构体存储了这次HTTP请求的一些信息

static ngx_int_t ngx_echo_handler(ngx_http_request_t *r)                                         
{                                                                                                
ngx_int_t     rc;                                                                           
ngx_buf_t    *b;                                                                             
ngx_chain_t   out;                                                                           
ngx_echo_loc_conf_t  *cglcf;                                                                 
cglcf = ngx_http_get_module_loc_conf(r, ngx_module_echo);                                    
if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD))) {                                          
return NGX_HTTP_NOT_ALLOWED;                                                            
}                                                                                            
if (r->headers_in.if_modified_since) {                                                      
return NGX_HTTP_NOT_MODIFIED;                                                            
}                                                                                            
r->headers_out.content_type.len = sizeof("text/html") - 1;                                   
r->headers_out.content_type.data = (u_char *) "text/html";                                   
r->headers_out.status = NGX_HTTP_OK;                                                         
r->headers_out.content_length_n = cglcf->ecdata.len;                                         
if (r->method == NGX_HTTP_HEAD) {                                                            
rc = ngx_http_send_header(r);                                                            
if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {                                 
return rc;                                                                           
}                                                                                       
}
b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));                                                
if (b == NULL) {                                                                             
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, "Failed to allocate response buffer.");
return NGX_HTTP_INTERNAL_SERVER_ERROR;                                                   
}
out.buf = b;  
out.next = NULL;                                                                             
b->pos = cglcf->ecdata.data;                                                                 
b->last = cglcf->ecdata.data+(cglcf->ecdata.len);                                            
b->memory = 1;                                                                              
b->last_buf = 1;                                                                             
rc = ngx_http_send_header(r);                                                               
if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {                                      
return rc;                                                                              
}                                                                                            
return ngx_http_output_filter(r, &out);                                                      
}                                                                                                

  ngx-module_t
组合Nginx Module

ngx_module_t  ngx_http_circle_gif_module = {               
NGX_MODULE_V1,                                          
&ngx_http_circle_gif_module_ctx, /* module context */   
ngx_http_circle_gif_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                                   
};