nginx 开发简单的http模块

心已赠人 2022-02-01 17:21 287阅读 0赞

[https://blog.csdn.net/zhangxiao93/article/details/52836128][https_blog.csdn.net_zhangxiao93_article_details_52836128]

武侠世界的高手一般都是从扫地僧做起的，程序员学一门技术都是从hello world开始。

本文介绍开发一个简单的hello world模块。

（一）如何将自己的http模块编译进Nginx  
首先创建源码目录：

mkdir /home/zhangxiao/nginx/nginx-1.0.15/src/test/  
1  
在编译Nginx之前，执行configure脚本时，添加--add-module=PATH例如：

./configure --add-module=/home/zhangxiao/nginx/nginx-1.0.15/src/test  
1  
1.编写config文件  
config文件在上述目录中，这个文件将通知如何编译本模块。  
config文件其实是一个可执行的Shell脚本，如果只想开发一个HTTP模块，需要定义三个变量：  
（1）ngx\_adon\_name  
仅在configure执行时使用，一般设置为模块名称。  
（2）HTTP\_MODULES  
保存所有的HTTP模块名称。每个模块间由空格相连。在重新设置这个变量时，不要直接覆盖，因此要如下设置：

"$HTTP\_MODULES ngx\_http\_mytest\_module"  
1  
（3）NGX\_ADDON\_SRCS  
用于指定新模块的源代码，多个待编译的源代码之间可以用空格相连。  
注意，在设置这个变量时可以使用$ngx\_addon\_dir变量，它等价于configure执行时–add-module=PATH的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"  
1  
2  
3  
2.修改nginx.conf配置文件  
sudo vi /usr/local/nginx/conf/nginx.conf  
1  
在server 配置块下添加location 配置块，并在新添加的location配置块中添加mytest配置项：

\# nginx.conf 删去一部分内容

http \{  
server \{  
listen 80;  
server\_name localhost;

\#\#\#\#\#\#\#\#\#\#\#添加部分\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#  
location = /zxtest\{  
\#mytest配置项  
mytest;  
\}  
\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#\#

location / \{  
proxy\_pass http://localhost:8080;  
\}

\}  
1  
2  
3  
4  
5  
6  
7  
8  
9  
10  
11  
12  
13  
14  
15  
16  
17  
18  
19  
20  
21  
22  
3.定义http模块处理用户请求  
\#include <ngx\_config.h>  
\#include <ngx\_core.h>  
\#include <ngx\_http.h>

static ngx\_int\_t ngx\_http\_mytest\_handler(ngx\_http\_request\_t \*r);  
static char \*ngx\_http\_mytest(ngx\_conf\_t \*cf, ngx\_command\_t \*cmd, void \*conf);  
//处理配置项  
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, //类型 type  
ngx\_http\_mytest, //set 函数  
NGX\_HTTP\_LOC\_CONF\_OFFSET,//偏移  
0,  
NULL  
\},  
ngx\_null\_command  
\};

//回调函数，出现my\_test配置项后调用  
static char \*  
ngx\_http\_mytest(ngx\_conf\_t \*cf, ngx\_command\_t \*cmd, void \*conf)  
\{  
ngx\_http\_core\_loc\_conf\_t \*clcf;  
//找到mytest所属配置块  
clcf=ngx\_http\_conf\_get\_module\_loc\_conf(cf,ngx\_http\_core\_module);

//主机域名、URI与mytest所在配置块匹配时，将调用handler  
clcf->handler=ngx\_http\_mytest\_handler;  
return NGX\_CONF\_OK;  
\}  
//ngx\_http\_module\_t接口，模块上下文  
//如果没有什么工作是必须在HTTP框架初始化时完成，则不必实现8个回调  
static ngx\_http\_module\_t ngx\_http\_mytest\_module\_ctx=\{  
NULL,  
NULL,  
NULL,  
NULL,  
NULL,  
NULL,  
NULL,  
NULL  
\};

//新模块定义  
ngx\_module\_t ngx\_http\_mytest\_module=\{  
NGX\_MODULE\_V1,  
&ngx\_http\_mytest\_module\_ctx,  
ngx\_http\_mytest\_commands,  
NGX\_HTTP\_MODULE,  
NULL,  
NULL,  
NULL,  
NULL,  
NULL,  
NULL,  
NULL,  
NGX\_MODULE\_V1\_PADDING  
\};

//处理实际用户请求  
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(NGX\_OK!=rc)  
\{  
return rc;  
\}

//设置返回的Content-Type ngx\_string是一个宏可以初始化data字段和len字段  
ngx\_str\_t type=ngx\_string("text/plain");  
ngx\_str\_t response=ngx\_string("Hello ZhangXiao World");  
//响应包体内容和状态码设置  
r->headers\_out.status=NGX\_HTTP\_OK;  
r->headers\_out.content\_length\_n=response.len;  
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(NULL==b)  
\{  
return NGX\_HTTP\_INTERNAL\_SERVER\_ERROR;  
\}  
//拷贝响应报文  
ngx\_memcpy(b->pos,response.data,response.len);  
b->last=b->pos+response.len;  
//声明这是最后一块缓冲区  
b->last\_buf=1;

//构造发送时的ngx\_chain\_t结构体  
ngx\_chain\_t out;  
out.buf=b;  
out.next=NULL;  
//发送响应，结束后HTTP框架会调用ngx\_http\_finalize\_request方法结束请求  
return ngx\_http\_output\_filter(r,&out);

\}  
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  
4.编译测试  
./configure --add-module=/home/zhangxiao/nginx/nginx-1.0.15/src/test  
make  
sudo make install  
1  
2  
3  
重启nginx

./usr/local/nginx/sbin  
1  
在浏览器输入localhost/zxtest进行测试验证

（二）参考  
1.深入理解Nginx  
2.http://blog.csdn.net/xiajun07061225/article/details/9130237  
3.http://kb.cnblogs.com/page/98352/  
\---------------------  
作者：NearXDU  
来源：CSDN  
原文：https://blog.csdn.net/zhangxiao93/article/details/52836128  
版权声明：本文为博主原创文章，转载请附上博文链接！

[https_blog.csdn.net_zhangxiao93_article_details_52836128]: https://blog.csdn.net/zhangxiao93/article/details/52836128