安装模块 并且运行成功 补充开发文档

Author: wujunze

README.md

@@ -1,4 +1,4 @@
-# Practical development Nginx Module
+# Practical development ginx Module
 **[简体中文](http://git.oschina.net/wujunze/nginx_module_echo/blob/master/README_zh.md)**
 ## nginx_module_echo
 echo string
@@ -55,6 +55,28 @@ typedef struct {
 ## Combination Nginx module
 ![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjjo2l11jj31en0g4gq1.jpg)
 
+## Finishing module code According to the Nginx official specification
+![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjnxy9ikvj31yx12jwr3.jpg)
+
+## Write the config file
+```shell
+ngx_addon_name=ngx_http_echo_module
+HTTP_MODULES="$HTTP_MODULES ngx_http_echo_module"
+NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/src/ngx_http_echo_module.c"
+```
+## make && make install
+```shell
+ ./configure --prefix=/usr/local/nginx/ --add-module=/root/ngx_dev && make && make install
+```
+## Successful installation
+![image](https://ws3.sinaimg.cn/large/005LOzcmly1fgjnvxyqx4j30w40f0tbw.jpg)
+
+## Modify the Nginx configuration file test Module
+![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjnz17rh7j30jl07yaai.jpg)
+
+## Nginx echo Module The successful running
+![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjo0r1a5dj30yf06tmxv.jpg)
+
 >reference
  [1] Evan Miller, Emiller's Guide To Nginx Module Development. http://www.evanmiller.org/nginx-modules-guide.html, 2009
  [2] http://wiki.nginx.org/Configuration

README_zh.md

@@ -54,6 +54,28 @@ typedef struct {
 ## 组合Nginx Module
 ![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjjo2l11jj31en0g4gq1.jpg)
 
+## 整理模块代码 按照Nginx官方规范
+![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjnxy9ikvj31yx12jwr3.jpg)
+
+## 编写config文件
+```shell
+ngx_addon_name=ngx_http_echo_module
+HTTP_MODULES="$HTTP_MODULES ngx_http_echo_module"
+NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/src/ngx_http_echo_module.c"
+```
+## 编译安装echo模块
+```shell
+ ./configure --prefix=/usr/local/nginx/ --add-module=/root/ngx_dev && make && make install
+```
+## 安装成功
+![image](https://ws3.sinaimg.cn/large/005LOzcmly1fgjnvxyqx4j30w40f0tbw.jpg)
+
+## 修改Nginx配置文件测试Module
+![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjnz17rh7j30jl07yaai.jpg)
+
+## Nginx echo Module 运行成功
+![image](https://ws2.sinaimg.cn/large/005LOzcmly1fgjo0r1a5dj30yf06tmxv.jpg)
+
 >参考文献
  [1] Evan Miller, Emiller's Guide To Nginx Module Development. http://www.evanmiller.org/nginx-modules-guide.html, 2009
  [2] http://wiki.nginx.org/Configuration

config

@@ -0,0 +1,3 @@
+ngx_addon_name=ngx_http_echo_module
+HTTP_MODULES="$HTTP_MODULES ngx_http_echo_module"
+NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/src/ngx_http_echo_module.c"

src/nginx_moudle_echo.c renamed to src/ngx_http_echo_module.c

@@ -1,12 +1,12 @@
 /*
- * @file:    nginx_moufle_echo.c
+ * @file:    nginx_http_echo_module.c
  * @brief:   Nginx echo command output a string
- * @author:  Panda <vozlt@vozlt.com>
+ * @author:  Panda <itwujunze@163.com>
  * @version: 1.0.1
  * @date:    2017/6/12
  *
  * Compile:
- *           shell> ./configure --add-module=/path/to/nginx_moudle_echo.c
+ *           shell> ./configure --add-module=/path/to/nginx_http_echo_module.c
  *
  */
 
@@ -34,7 +34,7 @@ static ngx_command_t ngx_http_echo_commands[] = {
                 NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1,
                 ngx_http_echo,
                 NGX_HTTP_LOC_CONF_OFFSET,
-                offsetof(ngx_http_echo_oc_conf_t, ed),
+                offsetof(ngx_http_echo_loc_conf_t, ed),
                 NULL,
         },
         ngx_null_command,
@@ -123,11 +123,11 @@ ngx_http_echo_handler(ngx_http_request_t *r)
     b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
     if(b == NULL)
     {
-        ngx_log_error(NGX_LOG_ERROR, r->connection->log, 0, "Failed to allocate response buffer.");
+        ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, "Failed to allocate response buffer.");
         return NGX_HTTP_INTERNAL_SERVER_ERROR;
     }
     out.buf = b;
-    put.next = NULL;
+    out.next = NULL;
     b->pos = elcf->ed.data;
     b->last = elcf->ed.data + (elcf->ed.len);
     b->memory = 1;
@@ -148,12 +148,12 @@ ngx_http_echo_handler(ngx_http_request_t *r)
  * @return ngx status code
  */
 static char *
-ngx_http_echo(ngx_conf_t *f,ngx_command_t *cmd , void *conf)
+ngx_http_echo(ngx_conf_t *cf,ngx_command_t *cmd , void *conf)
 {
         ngx_http_core_loc_conf_t *clcf;
-        clcf = ngx_http_conf_get_module_loc_conf(cf,ngx_http_core_module);
-        clcf->handle = ngx_http_echo_handler;  //修改核心模块配置(也就是当前location),将其handler替换为我们自己定义的ngx_http_echo_handler
-        ngx_conf_set_str_slot(cf,cmf,conf);
+        clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
+        clcf->handler = ngx_http_echo_handler;  //修改核心模块配置(也就是当前location),将其handler替换为我们自己定义的ngx_http_echo_handler
+        ngx_conf_set_str_slot(cf,cmd,conf);
         return NGX_CONF_OK;
 }
 
@@ -164,7 +164,7 @@ ngx_http_echo(ngx_conf_t *f,ngx_command_t *cmd , void *conf)
  * @param cf
  * @return
  */
-static char *
+static void *
 ngx_http_echo_create_loc_conf(ngx_conf_t *cf)
 {
         ngx_http_echo_loc_conf_t *conf;
@@ -202,18 +202,6 @@ ngx_http_echo_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
 static ngx_int_t
 ngx_http_echo_init(ngx_conf_t *cf)
 {
-    ngx_http_handler_pt       *h;
-    ngx_http_core_main_conf_t *cmcf;
-
-    cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
-
-    h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
-    if (h == NULL) {
-        return NGX_ERROR;
-    }
-
-    *h = ngx_http_echo_handler;
-
     return NGX_OK;
 }