nginx http模块数据存储结构小结

发布时间：2024/02/08

以下是关于“nginx http模块数据存储结构小结”的完整攻略：

1. 什么是nginx http模块数据存储结构?

在nginx的http模块中，我们可以通过定义不同的数据结构方便地存储和管理http请求和响应的相关信息。这些结构主要包括：

请求的上下文结构体ngx_http_request_t
请求头部相关的结构体ngx_table_elt_t和ngx_list_t
连接的上下文结构体ngx_connection_t
连接池结构体ngx_cycle_t

2. ngx_http_request_t结构体

ngx_http_request_t结构体是http请求处理过程中非常重要的数据结构。它包含了与请求相关的全部信息，包括请求行、请求头、请求体等等。这个结构体中有很多字段，这些字段包含了与请求相关的大量信息。除了少数需要手工赋值的信息，如请求头中的各种参数，大部分请求信息都是由nginx内部自动解析后填写的。

3. ngx_table_elt_t和ngx_list_t结构体

ngx_table_elt_t结构体代表了一个http请求头中的一项信息，如"Content-Type"、"Content-Length"等。而ngx_list_t结构体则是一个链表结构，用来存储多个ngx_table_elt_t结构体。

通过这些结构体和链表，nginx http模块可以更方便地管理请求头，并提供了一系列相关操作的方法，例如获取请求头元素的值，插入或删除请求头等。

下面是一个ngx_list_t结构体的示例代码块：

typedef struct {
    ngx_uint_t               hash;          // 哈希值
    ngx_str_t                key;           // 请求头名
    ngx_str_t                value;         // 请求头值
    ngx_uint_t               lo_value;      // 全小写的value
    ngx_uint_t               hi_value;      // 全大写的value
    ngx_list_part_t         *part;          // 当前结点所在part
    ngx_uint_t               nelts;         // 当前part中元素个数
    ngx_list_t              *next;          // 下一个list
} ngx_list_t;

4. ngx_connection_t结构体

ngx_connection_t结构体代表了客户端与服务器之间的一个连接。在http请求过程中，nginx会为每一个连接生成一个ngx_connection_t结构体，用来存储当前连接相关的全部信息。

这个结构体中包括了很多重要的字段，例如fd、epoll事件、send、recv流等等。在nginx http模块中，我们可以通过这些字段方便地获取和管理连接的相关信息。

下面是一个ngx_connection_t结构体的示例代码块：

typedef struct ngx_connection_s ngx_connection_t;

struct ngx_connection_s {
    void                 *data;              // 连接关联的请求处理结构体指针
    ngx_event_t          *read;              // 接收网络数据事件
    ngx_event_t          *write;             // 发送网络数据事件
    ngx_socket_t          fd;                // 连接对应socket
    ngx_recv_pt           recv;              // socket接收处理方法
    ngx_send_pt           send;              // socket发送处理方法
    ngx_listening_t      *listening;         // 对应的监听对象
    off_t                 sent;              // 发送的字节数
    ...
};

5. ngx_cycle_t结构体

ngx_cycle_t结构体是nginx http模块使用的连接池，其中包含了多个ngx_connection_t结构体。每当nginx启动时，它会为每一个worker进程生成一个ngx_cycle_t结构体，然后将这些结构体保存在ngx_cycle_modules链表中。

在http请求处理过程中，nginx会从ngx_cycle_t结构体中获取需要使用的连接，并在需要时创建新的连接。所有这些操作都是由nginx自动完成的，无需手动干预。

下面是一个ngx_cycle_t结构体的示例代码块：

typedef struct ngx_cycle_s ngx_cycle_t;

struct ngx_cycle_s {
    void                  ****conf_ctx;      // 存储所有模块配置定义的上下文结构体指针
    ngx_pool_t               *pool;          // 这个cycle使用的内存分配池
    ngx_log_t               *log;            // 日志操作对象指针
    ngx_uint_t               log_use_stderr; // 如果这个标志位是1，日志会输出到标准错误输出
    ngx_connection_t        *connections;    // 连接池中所有连接
    ...
};

6. 总结

以上介绍了nginx http模块中常用的数据存储结构，这些结构包括ngx_http_request_t、ngx_list_t、ngx_table_elt_t、ngx_connection_t和ngx_cycle_t。对于理解nginx http请求的处理过程和实现原理非常有帮助。

示例1：以下是通过ngx_http_request_t获取请求URL的示例代码块：

static ngx_int_t ngx_http_mytest_handler(ngx_http_request_t *r) {
    ...
    ngx_log_error(NGX_LOG_EMERG, r->connection->log, 0, "request uri: \"%V\"", &r->uri);
    ...
}

示例2：以下是通过ngx_list_t获取请求头中的"User-Agent"信息的示例代码块：

ngx_table_elt_t *user_agent = ngx_list_push(&r->headers_in.headers);
user_agent->hash = 1;
ngx_str_set(&user_agent->key, "User-Agent");
ngx_str_set(&user_agent->value, "Mozilla/5.0");