Nginx-编写自己的http模块（引入第三方模块的方法）

爱被打了一巴掌 2022-02-24 01:18 310阅读 0赞

Nginx将第三方模块编译到nginx中的方法：将源代码文件和config放在一个目录中，然后执行configure --add-module=PATH （以上文件的地址） ，就可以在执行正常编译安装流程时完成nginx编译工作；

通过编写配置mytest模块，可以在http\{\},server\{\},location\{\}块中声明配置mytest，如

location /mytest/ \{  
   
    mytest;  
   
\}  
那么当用户请求的URI中匹配到/mytest/ ，就会调用我们自定义的ngx\_mytest\_handle方法来处理这个用户请求；

1、编写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"

ngx\_addon\_name：仅在configure执行时使用，一般设置为模块

HTTP\_MODULES：保存所有的HTTP模块名称，每个HTTP模块间由空格符相连。在重新设置HTTP\_MODULES变量时，不要直接覆盖它，因为configure调用到自定义的config脚本前，已经将各个HTTP模块设置到HTTP\_MODULES变量中了，因此，要像如下这样设  
"$HTTP\_MODULES ngx\_http\_mytest\_module"

NGX\_ADDON\_SRCS：用于指定新增模块的源代码，多个待编译的源代码间以空格符相连。注意，在设置NGX\_ADDON\_SRCS时可以使用$ngx\_addon\_dir变量，它等价于configure执行时--add-module=PATH的PATH参数。

2、编写ngx\_http\_mytest\_module.c  
\#include <ngx\_config.h>  
\#include <ngx\_core.h>  
\#include <ngx\_http.h>  
   
//mytest配置项处理  
   
   
static ngx\_int\_t ngx\_http\_mytest\_handle(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(rc!=NGX\_OK)\{  
                return rc;  
        \}  
   
        //设置返回的Content-Type  
        ngx\_str\_t type = ngx\_string("text/html;application/json;charset=utf-8");  
   
        //返回的包体的内容  
        ngx\_str\_t response = ngx\_string("Hello World!");  
   
        //设置返回的状态码  
        r->headers\_out.status = NGX\_HTTP\_OK;  
   
        //响应包体是有包体内容的，需要设置Contetn-Length长度  
        r->headers\_out.content\_length\_n = response.len;  
   
        //设置contetn-type  
        r->headers\_out.content\_type = type;  
   
        //发送自定义头部  
        ngx\_table\_elt\_t\* h = ngx\_list\_push(&r->headers\_out.headers);  
        if(h == NULL)\{  
                return NGX\_ERROR;  
        \}  
   
        h->hash = 1;  
        h->key.len = sizeof("TestHead")-1;  
        h->key.data = (u\_char \*) "TestHead";  
        h->value.len = sizeof("TestValue") - 1;  
        h->value.data = (u\_char \*) "TestValue";  
   
        //发送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 (b == NULL)\{  
                return NGX\_HTTP\_INTERNAL\_SERVER\_ERROR;  
        \}  
   
        //将responser复制到ngx\_buf\_t指向的内存中  
        ngx\_memcpy(b->pos,response.data,response.len);  
        //注意，一定要设置好last指针  
        b->last = b->pos + response.len;  
        //声明这是最后一块缓存区  
        b->last\_buf = 1;  
   
        //构造发送时的ngx\_chain\_t结构体  
        ngx\_chain\_t out;  
        //赋值ngx\_buf\_t  
        out.buf = b;  
        //设置next为null  
        out.next = NULL;  
   
        //最后一步为发送包体，发送结束后http框架会调用ngx\_http\_finalize\_request方法结束请求  
        return ngx\_http\_output\_filter(r,&out);  
\}  
   
   
static char \*  
ngx\_http\_mytest(ngx\_conf\_t \*cf,ngx\_command\_t \*cmd,void \*conf)\{  
        //首先找到mytest配置项所属的配置块；  
        ngx\_http\_core\_loc\_conf\_t \*clcf;  
        clcf = ngx\_http\_conf\_get\_module\_loc\_conf(cf,ngx\_http\_core\_module);  
   
        //如果请求的主机域名、URI、与mytest配置项所在的配置块相匹配，会调用我们实现的ngx\_http\_mytest\_handle  
        clcf->handler = ngx\_http\_mytest\_handle;  
        return NGX\_CONF\_OK;  
\}  
   
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,  
   
          //处理配置项的参数，当配置块中出现mytest配置项时，Nginx会调用ngx\_http\_mytest方法   
          ngx\_http\_mytest,  
   
          //在配置文件中的偏移量  
          NGX\_HTTP\_LOC\_CONF\_OFFSET,  
          0,  
          NULL  
        \},  
   
        ngx\_null\_command  
\};  
   
   
   
//第三方模块可以介入HTTP框架7个阶段处理请求，如果有什么需要在http框架初始化完成的，就可以在这里设置  
static ngx\_http\_module\_t ngx\_http\_mytest\_module\_ctx = \{  
        NULL,   /\* preconfiguration \*/  
        NULL,   /\* postconfiguration \*/  
        NULL,   /\* create main configuration \*/  
        NULL,   /\* init main configuration \*/  
        NULL,   /\* create server configuration \*/  
        NULL,   /\* merge server configuration \*/  
        NULL,   /\* create location configuration \*/  
        NULL,   /\* merge location configuration \*/  
\};  
   
//定义mytest模块  
ngx\_module\_t ngx\_http\_mytest\_module = \{  
        NGX\_MODULE\_V1,  
        &ngx\_http\_mytest\_module\_ctx,    /\* module context  \*/  
        ngx\_http\_mytest\_commands,       /\* modele directives \*/  
        NGX\_HTTP\_MODULE,                /\* module type \*/  
        NULL,                           /\* init master \*/  
        NULL,                           /\* init module \*/  
        NULL,                           /\* init process \*/  
        NULL,                           /\* init thread \*/  
        NULL,                           /\* exit thread \*/  
        NULL,                           /\* exit process \*/  
        NULL,                           /\* exit master \*/  
        NGX\_MODULE\_V1\_PADDING  
\};

3、编译该模块  
\#运行configure文件，使用--add-module=PATH（config和ngx\_module\_http\_mytest\_module所在的问文件夹）  
   
./configure --add-module=/usr/local/nginx-1.14.2/nginx-module/mytest-module  
   
make  
   
nginx -s stop  
   
cp objs/nginx ../../nginx/sbin  
   
\#启动nginx  
nginx