Nginx基础篇之二—Nginx简单的HTTP程序

本例基于上篇文章中介绍的手动安装的Ubuntu环境，编写一个简单的HTTP程序，打印出Hello World！字样，运行效果如下：

现在介绍开发此简单HTTP程序的步骤，这里暂不介绍各个类型、结构等，只是开发个简单实例来给个直观的印象。

一、基本依赖

1) nginx源码

要手动重新编译安装一遍源码，不同的是此次编译安装要加入开发的模块的源码和路径。

2) 模块代码

要提供一份模块相关的代码，包括一个名为config的文件以及.c的模块源码文件。

二、开发实现

1. 创建模块目录

mkdir一个文件夹，随意创建，这里随意创建了一个全路径为/home/afei/WorkSpace/nginx_space/mytest，简写为PATH_A

2. 编写程序源代码

在上述路径PATH_A中新建一个文件，这里随意起名字为ngx_http_mytest_module.c（后面会有介绍名字的规则），文件内容如下：

[cpp]  view plain copy print ?

1. #include <ngx_config.h>  
2. #include <ngx_core.h>  
3. #include <ngx_http.h>  
4.   
5. static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r);  
6. static char *   
7. ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);  
8. //处理配置项  
9. static ngx_command_t ngx_http_mytest_commands[] = {  
10.     {  
11.         ngx_string("mytest"),  
12.         NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_HTTP_LMT_CONF|NGX_CONF_NOARGS,  
13.         ngx_http_mytest,  
14.         NGX_HTTP_LOC_CONF_OFFSET,  
15.         0,  
16.         NULL  
17.     },  
18.     ngx_null_command  
19. };  
20. //模块上下文  
21. static ngx_http_module_t ngx_http_mytest_module_ctx = {  
22.     NULL,  
23.     NULL,  
24.     NULL,  
25.     NULL,  
26.     NULL,  
27.     NULL,  
28.     NULL,  
29.     NULL  
30. };  
31. //新模块定义  
32. ngx_module_t ngx_http_mytest_module = {  
33.     NGX_MODULE_V1,  
34.     &ngx_http_mytest_module_ctx,  
35.     ngx_http_mytest_commands,  
36.     NGX_HTTP_MODULE,  
37.     NULL,  
38.     NULL,  
39.     NULL,  
40.     NULL,  
41.     NULL,  
42.     NULL,  
43.     NULL,  
44.     NGX_MODULE_V1_PADDING  
45. };  
46.   
47. //配置项对应的回调函数  
48. static char *   
49. ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)  
50. {  
51.     ngx_http_core_loc_conf_t *clcf;  
52.   
53.     clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);  
54.   
55.     clcf->handler = ngx_http_mytest_handler;  
56.   
57.     return NGX_CONF_OK;  
58. }  
59.   
60. //实际完成处理的回调函数  
61. static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r)  
62. {  
63.     if (!(r->method & (NGX_HTTP_GET | NGX_HTTP_HEAD))) {  
64.         return NGX_HTTP_NOT_ALLOWED;  
65.     }  
66.   
67.     ngx_int_t rc = ngx_http_discard_request_body(r);  
68.     if (rc != NGX_OK) {  
69.         return rc;  
70.     }  
71.   
72.     ngx_str_t type = ngx_string("text/plain");  
73.     ngx_str_t response = ngx_string("Hello World");  
74.     r->headers_out.status = NGX_HTTP_OK;  
75.     r->headers_out.content_length_n = response.len;  
76.     r->headers_out.content_type = type;  
77.   
78.     rc = ngx_http_send_header(r);  
79.     if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {  
80.         return rc;  
81.     }  
82.   
83.     ngx_buf_t *b;  
84.     b = ngx_create_temp_buf(r->pool, response.len);  
85.     if (b == NULL) {  
86.         return NGX_HTTP_INTERNAL_SERVER_ERROR;  
87.     }  
88.   
89.     ngx_memcpy(b->pos, response.data, response.len);  
90.     b->last = b->pos + response.len;  
91.     b->last_buf = 1;  
92.   
93.     ngx_chain_t out;  
94.     out.buf = b;  
95.     out.next = NULL;  
96.   
97.     return ngx_http_output_filter(r, &out);  
98. }  

3.编写模块配置文件

在上述路径PATH_A中，新建一个名为config的文件，其实质为一个shell脚本，如果只想开发一个HTTP模块，需要定义三个变量：

1）ngx_adon_name

仅在重新编译nginx源码时，configure执行时使用，一般设置为模块名称。

2）HTTP_MODULES

保存所有的HTTP模块名称。每个模块间由空格相连。在重新设置这个变量时，不要直接覆盖，因此要如下设置：

"$HTTP_MODULES ngx_http_mytest_module"

3）NGX_ADDON_SRCS

用于指定新模块的源代码，多个待编译的源代码之间可以用空格相连。

注意，在设置这个变量时可以使用$ngx_addon_dir变量，它等价于nginx源码configure执行时--add-module=PATH的PATH参数。

因此，config文件的内容如下：

[cpp]  view plain copy print ?

1. ngx_addon_name=ngx_http_mytest_module  
2. HTTP_MODULES="$HTTP_MODULES ngx_http_mytest_module"  
3. NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_mytest_module.c"  

这样，PATH_A文件夹下就有两个文件，如下所示：

4.编译nginx源码

[cpp]  view plain copy print ?

1. ./configure --add-module=/home/afei/WorkSpace/nginx_space/mytest（新模块存放目录）  
2. make  
3. sudo make install  

5.添加配置项

在nginx的配置文件nginx.conf中添加配置项，这里为/usr/local/nginx/conf目录下的nginx.conf文件，在其中添加如下内容，行48-51：

6.启动nginx，并在浏览器中输入http://localhost:8080/test，回车后将会出现本文开头的运行效果。