本例子实现了一个简单的hello world程序。运行效果:

虚拟机Ubuntu中:

Nginx学习之一-第一个程序Hello World_配置项

win7中chrome浏览器:

Nginx学习之一-第一个程序Hello World_编译安装_02

 

 


一、config文件编写


Nginx提供了一种简单的方式将第三方的模块编译到Nginx中。首先把源代码文件全部放到一个目录下,同时在该目录中编写一个文件用于通知Nginx如何编译本模块,这个文件名必须为config。


然后,在configure脚本执行时加入参数--add-module=PATH(新模块源代码以及config文件存放目录),就可以在执行政策编译安装流程时完成Nginx编译工作。


 


config文件格式


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


(1)ngx_adon_name。


仅在configure执行时使用,一般设置为模块名称。


(2)HTTP_MODULES。


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


"$HTTP_MODULES ngx_http_mytest_module"


(3)NGX_ADDON_SRCS。


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


注意,在设置这个变量时可以使用$ngx_addon_dir变量,它等价于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"  


 


 


二、修改配置文件


/usr/local/nginx/conf/nginx.conf


添加下面内容:


Nginx学习之一-第一个程序Hello World_配置项_03

 

 

 


三、定义HTTP模块及处理用户请求


源代码:




[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. }  


 

四、编译安装新模块

编译安装新模块的命令如下:

 




[cpp] ​​view plain​​​​copy​​​​print​​​​?​

 


  1. ./configure --prefix=/usr/local/nginx(指定安装部署后的根目录) --add-module=/home/nginx(新模块存放目录)  
  2. make  
  3. sudo make install