Nginx 定义自己的 http 模块

1
2
    config文件其实是一个可执行的Shell脚本，如果只想开发一个HTTP模块，需要定义三个变量：

1
2
3
4
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"  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
#include <ngx_config.h>  
#include <ngx_core.h>  
#include <ngx_http.h>  
  
  
static char *  
ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);  
  
static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r);  
  
  
//处理配置项    
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  
};  
//模块上下文  
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 */  
};  
//新模块定义    
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  
};  
  
//配置项对应的回调函数   
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;  
}  
  
//实际完成处理的回调函数    
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);  
}  

1
2
3
4
location /test {  
        mytest;  
} 

1
2
3
4
./configure  --add-module=/home/nginx（这个路径是上面的conf和ngx_http_mytest_module.c文件所在的路径）  
make  
make install  

1
2
    然后在浏览器输入：http://localhost/test即可看到Hello World字样。