Nginx重要结构request_t解析之http请求的获取

请在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

本文主要参考为《深入理解nginx模块开发与架构解析》一书，处理用户请求部分，是一篇包含作者理解的读书笔记。欢迎指正，讨论。

handler函数的定义模型如下：

 static ngx_int_t
 ngx_http_hello_handler(ngx_http_request_t *r)
 {}

请求的所有信息都可以在传入的ngx_http_request_t类型指针参数 r 中获得。Ngx_http_request_t结构体包含的内容很多，这里只讨论其中获取HTTP请求的部分,相关定义如下:

  struct ngx_http_request_s {
      ...
  　　//请求头
      ngx_buf_t                        *header_in;

      ngx_http_headers_in_t             headers_in;
      ngx_http_headers_out_t            headers_out;
  　　//请求体
      ngx_http_request_body_t          *request_body;
 　　//请求行
     ngx_uint_t                        method;
     ngx_uint_t                        http_version;

     ngx_str_t                         request_line;
     ngx_str_t                         uri;
     ngx_str_t                         args;
     ngx_str_t                         exten;
     ngx_str_t                         unparsed_uri;

     ngx_str_t                         method_name;
     ngx_str_t                         http_protocol;
     ...
     /*
24      * a memory that can be reused after parsing a request line
25      * via ngx_http_ephemeral_t
26      */

     u_char                           *uri_start;
     u_char                           *uri_end;
     u_char                           *uri_ext;
     u_char                           *args_start;
     u_char                           *request_start;
     u_char                           *request_end;
     u_char                           *method_end;
     u_char                           *schema_start;
     u_char                           *schema_end;
     u_char                           *host_start;
     u_char                           *host_end;
     u_char                           *port_start;
     u_char                           *port_end;
     ...
 };

相关定义全在上面列出，

下面，我们先从请求行的获取来解释：

http请求行定义如下：

<method><request-URL><version>

首先，需要解析method：

• method的定义类型为ngx_uint_t，Nginx中通过宏定义，给所有method赋予了不同的整型值。这里的method是Nginx解析了用户请求之后得到的整型值，可以用来判断method。
• method_name则是ngx_str_t类型，内容是方法名字符串，其使用方式区别于常用str类型，这点一定要注意。
• 还可以使用request_start和method_end指针取得方法名，request_start指向用户请求的首地址，同时也是方法名的地址，method_end则指向方法名的最后一个字符（注意：这点与其他xxx_end指针不同）。

然后，解析URI：

• ngx_str_t类型的uri指向用户请求的URI。

• uchar*类型的uri_start和uri_end也和method的用法类似。不同的是，method_end指向的是方法名的最后一个字符，而uri_end指向URI结束之后的下一个字符。也就是最后一个字符的下一个字符地址。Nginx中大部分的u_char*类型指针变量中的“xxx_start”和“xxx_end”都是这样使用的。

• ngx_str_t类型的extern类型指向用户请求的文件的扩展名。例如：在访问“GET /a.txt HTTP/1.1”时，extern的值为{len=3，data=“txt”}。

• uri_ext指针指向的地质与extern.data相同unparsed_uri表示没有进行uri解码的原始请求。例如：“/a b”的原始请求为“/a%20b”（空格字符的编码为%20）。

接着，解析URI参数：

• Arg指向用户请求中的URL参数。

• Args_start和配合uri_end使用可以获得URL的参数。

最后，协议版本的获取：

• http_protocol指向用户请求中的HTTP的起始地址。

• http_version是nginx解析过得协议版本，他的取值范围如下：

　　

#define NGX_HTTP_VERSION_9                 9
#define NGX_HTTP_VERSION_10                1000
#define NGX_HTTP_VERSION_11                1001

• 建议使用http_version分析HTTP协议的版本。

• 最后使用request_start 和 request_end可以获取原始的用户请求。

请求行的获取到此结束，下面是请求头的获取：

head_in指向nginx收到的未经解析的HTTP头部。这里先不关注。

ngx_http_request_t中ngx_http_headers_in_t类型的headers_in则储存已经解析过得HTTP头部。结构体定义如下：

 typedef struct {
     ngx_list_t                        headers;

     ngx_table_elt_t                  *host;
     ngx_table_elt_t                  *connection;
     ngx_table_elt_t                  *if_modified_since;
     ngx_table_elt_t                  *if_unmodified_since;
     ngx_table_elt_t                  *if_match;
     ngx_table_elt_t                  *if_none_match;
     ngx_table_elt_t                  *user_agent;
     ngx_table_elt_t                  *referer;
     ngx_table_elt_t                  *content_length;
     ngx_table_elt_t                  *content_type;

     ngx_table_elt_t                  *range;
     ngx_table_elt_t                  *if_range;

     ngx_table_elt_t                  *transfer_encoding;
     ngx_table_elt_t                  *expect;
     ngx_table_elt_t                  *upgrade;

 #if (NGX_HTTP_GZIP)
     ngx_table_elt_t                  *accept_encoding;
     ngx_table_elt_t                  *via;
 #endif

     ngx_table_elt_t                  *authorization;

     ngx_table_elt_t                  *keep_alive;

 #if (NGX_HTTP_X_FORWARDED_FOR)
     ngx_array_t                       x_forwarded_for;
 #endif

 #if (NGX_HTTP_REALIP)
     ngx_table_elt_t                  *x_real_ip;
 #endif

 #if (NGX_HTTP_HEADERS)
     ngx_table_elt_t                  *accept;
     ngx_table_elt_t                  *accept_language;
 #endif

 #if (NGX_HTTP_DAV)
     ngx_table_elt_t                  *depth;
     ngx_table_elt_t                  *destination;
     ngx_table_elt_t                  *overwrite;
     ngx_table_elt_t                  *date;
 #endif

     ngx_str_t                         user;
     ngx_str_t                         passwd;

     ngx_array_t                       cookies;

     ngx_str_t                         server;
     off_t                             content_length_n;
     time_t                            keep_alive_n;

     unsigned                          connection_type:;
     unsigned                          chunked:;
     unsigned                          msie:;
     unsigned                          msie6:;
     unsigned                          opera:;
     unsigned                          gecko:;
     unsigned                          chrome:;
     unsigned                          safari:;
     unsigned                          konqueror:;
 } ngx_http_headers_in_t;

结构体中，后面定义了很多ngx_table_elt_t类型的指针变量，ngx_table_elt_t类型是Nginx定义的字典类型。内容都指向Nginx已经解析过得标准常见的HTTP头部，可以直接使用。这些解析过了的头部其实都储存在headers链表中，所以，对于headers_in结构体中未定义的不常用的HTTP头部，就需要遍历headers链表，解析其值。

下面是一个解析的例子（源于《深入理解》一书）：

下面尝试在一个用户请求中找到“Rpc-Description”头部，首先判断其值是否为“uploadFile”，再决定后续的服务器行为。

ngx_list_part_t *part = &r->headers_in.headers.part;
ngx_table_elt_t *header = part->elts;

//开始遍历链表
for(i = ;/*void*/;i++){
    //判断是否到达链表中当前数组结尾
    if(i>=part->nelts){
        //是否还有下一个链表数组元素
        if(part->next == NULL){
            break;
        }
        //part设置为next来访问下一个链表数组；header也指向下一个链表数组的首地址，设置i为0，表示从头开始遍历新的链表数组。
        part = part->next;
        header = part->elts;
        i=;
    }
    //hash为0表示不是合法的头部
    if(header[i].hash == ){
        continue;
    }

    //判断当前头部是否是“Rpc-Description”，如果想要忽略大小写，则应先用header[i].lowcase_key代替header[i].key.data，然后比较字符串。

    if( == ngx_strncasecmp(header[i].key.data,
                    (u_char*) "Rpc-Description",
                    header[i].key.len))
    {
        //判断头部的值是否是“uploadFile”
        if( == ngx_strncmp(header[i].key.data,
                "uploadFile",
                header[i].value.len))
                {
                //找到之后继续处理
                }
    }
}

获取headers的方法讲完了，下面是获取请求体（包体）的方法：

HTTP框架提供了一种方法可以异步接受包体：

ngx_int_t
ngx_http_read_client_request_body(ngx_http_request_t *r,
    ngx_http_client_body_handler_pt post_handler)

它的返回并不表示已经接受完成所有包体，只表示Nginx已经知道这个任务。所以一般返回为NGX_DONE（含义请自查，不赘述）。接受完所有包体之后，会调用post_handler函数指针指向的函数。其原型定义如下：

typedef void (*ngx_http_client_body_handler_pt)(ngx_http_request_t *r);

如果不想处理包体内容，可用如下方式将包体内容丢掉：

ngx_int_t rc = ngx_http_discard_request_body(r);
    if (rc != NGX_OK) {
        return rc;
    }

以上。欢迎留言讨论，联系方式：rwhsysu@163.com