模块目录

可在nginx-1.20.1/下创建目录ext/，专门存放自定义模块
如添加HTTP模块mytest，则在ext/下创建目录mytest

  1. mytest/
  2. ├── config
  3. └── ngx_http_mytest_module.c

步骤

原则：保证与Nginx命名规则一致，且文件目录代码中模块命名一致（太长也不要纠结），demo可修改成自定义模块名 以下全部基于项目目录/根目录：nginx-1.21.3/

一、创建相关文件目录

创建模块文件目录ngx_http_demo_module/

可在任意位置，推荐在nginx-1.21.3/modules/ 或nginx-1.21.3/ext/中

创建模块代码文件ngx_http_demo_module.c
创建config文件config
image.png

二、编辑config文件

配合configure脚本

  1. # 仅在configure执行时使用，一般设置为模块名称
  2. ngx_addon_name="ngx_http_demo_module"
  4. # 保存所有的HTTP模块名称，每个HTTP模块间由空格符相连，在重新设置HTTP_MODULES变量时，不要直接覆盖他，应该使用空格追加模块
  5. HTTP_MODULES="$HTTP_MODULES ngx_http_demo_module"
  7. # 指定扩展模块的源代码
  8. NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_demo_module.c"

三、编辑模块代码文件

  1. 使用static来优化代码

1. 定义HTTP模块ngx_http_demo_module

  1. static ngx_module_t ngx_http_demo_module = {
  2.     NGX_MODULE_V1,    // 固定
  3.     &ngx_http_demo_module_ctx,
  4.     ngx_http_demo_commands,
  5.     NGX_HTTP_MODULE,  // 固定
  6.     NULL,
  7.     NULL,
  8.     NULL,
  9.     NULL,
  10.     NULL,
  11.     NULL,
  12.     NULL,
  13.     NGX_MODULE_V1_PADDING  // 固定
  14. };

2. 定义模块上下文结构ngx_http_demo_module_ctx

  1. static ngx_http_module_t ngx_http_demo_module_ctx = {
  2.     NULL,   // preconfiguration
  3.     NULL,   // postconfiguration
  5.     NULL,   // create_main_conf
  6.     NULL,   // init_main_conf
  8.     NULL,   // create_srv_conf
  9.     NULL,   // merge_srv_conf
  11.     NULL,   // create_loc_conf
  12.     NULL,   // merge_loc_conf
  13. };

3. 定义模块命令结构ngx_http_demo_commands

  1. static ngx_command_t ngx_http_demo_commands[] = {
  2.     {
  3.         ngx_string("http_demo_module_test_cmd"),
  4.         NGX_HTTP_MAIN_CONF | NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_CONF_NOARGS,
  5.         ngx_http_demo_set,
  6.         NGX_HTTP_LOC_CONF_OFFSET,
  7.         0,
  8.         NULL
  9.     },
  10.     ngx_null_command   // 固定, 类似C字符串'\0'
  11. };

4. 编写命令触发回调函数ngx_http_demo_set

  1. // 声明
  2. static char *ngx_http_demo_set(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  4. // 定义
  5. static char *ngx_http_demo_set(ngx_conf_t *cf, ngx_command_t *cmd, void *conf) {
  6.     ngx_http_core_loc_conf_t *clcf;
  8.     clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
  9.     clcf->handler = ngx_http_demo_handler;
  11.     return NGX_OK;
  12. }

5. 编写HTTP请求处理回调函数ngx_http_demo_handler

  1. // 声明
  2. static ngx_int_t ngx_http_demo_handler(ngx_http_request_t *r);
  4. // 定义
  5. static ngx_int_t ngx_http_demo_handler(ngx_http_request_t *r) {
  7.     return NGX_OK;
  8. }
  10. static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r)
  11. {
  12.     // 必须是 GET 获得 HEAD 方法
  13.     if (!(r->method & (NGX_HTTP_GET | NGX_HTTP_HEAD)))
  14.     {
  15.         return NGX_HTTP_NOT_ALLOWED;
  16.     }
  18.     // 丢弃请求中的包体
  19.     ngx_int_t rc = ngx_http_discard_request_body(r);
  20.     if (rc != NGX_OK)
  21.     {
  22.         return rc;
  23.     }
  25.     ngx_str_t type = ngx_string("text/plain");
  26.     ngx_str_t response = ngx_string("Hello mytest Module!\n");
  27.     r->headers_out.status = NGX_HTTP_OK;
  28.     r->headers_out.content_length_n = response.len;
  29.     r->headers_out.content_type = type;
  31.     // 发送HTTP头部
  32.     rc = ngx_http_send_header(r);
  33.     if (rc == NGX_ERROR || rc > NGX_OK || r->header_only)
  34.     {
  35.         return rc;
  36.     }
  38.     // 构造包体
  39.     ngx_buf_t *buf;
  40.     buf = ngx_create_temp_buf(r->pool, response.len);
  41.     if (buf == NULL)
  42.     {
  43.         return NGX_HTTP_INTERNAL_SERVER_ERROR;
  44.     }
  46.     ngx_memcpy(buf->pos, response.data, response.len);
  47.     buf->last = buf->pos + response.len;
  48.     buf->last_buf = 1; // ?
  50.     // 构造发送时的 ngx_chain_t 结构体
  51.     ngx_chain_t out;
  52.     out.buf = buf;
  53.     out.next = NULL;
  55.     // 发送包体
  56.     return ngx_http_output_filter(r, &out);
  57. }

6. 添加头文件

核心3个文件，再缺什么补什么

  1. #include <ngx_config.h>
  2. #include <ngx_core.h>
  3. #include <ngx_http.h>

6. 完整代码

ngx_http_mytest_module.c内容如下：

  1. #include <ngx_config.h>
  2. #include <ngx_core.h>
  3. #include <ngx_http.h>
  5. // 回调函数
  6. static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r);
  7. static char *ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
  9. static ngx_http_module_t ngx_http_mytest_module_ctx = {
  10.     NULL,
  11.     NULL,
  12.     NULL,
  13.     NULL,
  14.     NULL,
  15.     NULL,
  16.     NULL,
  17.     NULL};
  19. static ngx_command_t ngx_http_mytest_commands[] = {
  20.     {
  21.         ngx_string("mytest"),
  22.         NGX_HTTP_MAIN_CONF | NGX_HTTP_SRV_CONF | NGX_HTTP_LOC_CONF | NGX_HTTP_LMT_CONF | NGX_CONF_NOARGS,
  23.         ngx_http_mytest,
  24.         NGX_HTTP_LOC_CONF_OFFSET,
  25.         0,
  26.         NULL,
  27.     },
  28.     ngx_null_command};
  30. ngx_module_t ngx_http_mytest_module = {
  31.     NGX_MODULE_V1,
  32.     &ngx_http_mytest_module_ctx,
  33.     ngx_http_mytest_commands,
  34.     NGX_HTTP_MODULE,
  35.     NULL,
  36.     NULL,
  37.     NULL,
  38.     NULL,
  39.     NULL,
  40.     NULL,
  41.     NULL,
  42.     NGX_MODULE_V1_PADDING};
  44. // 处理nginx.conf配置项参数
  45. static char *ngx_http_mytest(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  46. {
  47.     ngx_http_core_loc_conf_t *clcf;
  49.     // 获取 mytest 配置项所属的配置块
  50.     clcf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
  52.     // 如果请求的主机域名、URI与mytest配置项所在的配置块相匹配，调用该方法
  53.     clcf->handler = ngx_http_mytest_handler;
  55.     return NGX_OK;
  56. }
  58. static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r)
  59. {
  60.     // 必须是 GET 获得 HEAD 方法
  61.     if (!(r->method & (NGX_HTTP_GET | NGX_HTTP_HEAD)))
  62.     {
  63.         return NGX_HTTP_NOT_ALLOWED;
  64.     }
  66.     // 丢弃请求中的包体
  67.     ngx_int_t rc = ngx_http_discard_request_body(r);
  68.     if (rc != NGX_OK)
  69.     {
  70.         return rc;
  71.     }
  73.     ngx_str_t type = ngx_string("text/plain");
  74.     ngx_str_t response = ngx_string("Hello mytest Module!\n");
  75.     r->headers_out.status = NGX_HTTP_OK;
  76.     r->headers_out.content_length_n = response.len;
  77.     r->headers_out.content_type = type;
  79.     // 发送HTTP头部
  80.     rc = ngx_http_send_header(r);
  81.     if (rc == NGX_ERROR || rc > NGX_OK || r->header_only)
  82.     {
  83.         return rc;
  84.     }
  86.     // 构造包体
  87.     ngx_buf_t *buf;
  88.     buf = ngx_create_temp_buf(r->pool, response.len);
  89.     if (buf == NULL)
  90.     {
  91.         return NGX_HTTP_INTERNAL_SERVER_ERROR;
  92.     }
  94.     ngx_memcpy(buf->pos, response.data, response.len);
  95.     buf->last = buf->pos + response.len;
  96.     buf->last_buf = 1; // ?
  98.     // 构造发送时的 ngx_chain_t 结构体
  99.     ngx_chain_t out;
  100.     out.buf = buf;
  101.     out.next = NULL; 
  102.     // 发送包体
  103.     return ngx_http_output_filter(r, &out);
  104. }

四、编译HTTP模块

  1. cd nginx-1.20.1/
  2. ./configure --add-module=ext/mytest/    # 模块目录
  3. make && make install

编译过程

添加自定义模块目录路径：绝对路径or相对路径，如ext/ngx_http_demo_module/

  1. ./configure --add-module={MODULE_DIR_PATH}
  3. make
  5. sudo make install

修改Nginx配置

  1. worker_processes  4;
  3. events {
  4.     worker_connections  1024;
  5. }
  7. http {
  9.     server {
  10.         listen 8080;
  12.         # http://192.168.132.128:8080/http_demo
  13.         location /http_demo {
  14.             demo_cmd;
  15.         }
  16.     }
  17. }

五、测试HTTP模块

  1. 网页访问：127.0.0.1:8080/http_demo
  2. 命令行访问：curl 127.0.0.1;8080/http_demo