菜鸟学习nginx之接收HTTP Header

最新推荐文章于 2024-07-28 11:26:22 发布
最新推荐文章于 2024-07-28 11:26:22 发布
阅读量5.6k 收藏 2
点赞数
分类专栏： 开源软件 Nginx 文章标签： Nginx接收HTTP Header
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xxb249/article/details/85102814
版权

上一篇介绍了《菜鸟学习nginx之接收HTTP请求行》，本篇介绍Nginx接收HTTP Header处理流程。

一、HTTP Header处理流程

处理Header与上一篇处理HTTP请求行很类似，比较容易理解

1.1、流程图

1.2、代码

/**
 * 处理HTTP Header
 * @param rev 读事件
 */
static void
ngx_http_process_request_headers(ngx_event_t *rev)
{
    u_char *p;
    size_t len;
    ssize_t n;
    ngx_int_t rc, rv;
    ngx_table_elt_t *h;
    ngx_connection_t *c;
    ngx_http_header_t *hh;
    ngx_http_request_t *r;
    ngx_http_core_srv_conf_t *cscf;
    ngx_http_core_main_conf_t *cmcf;

    c = rev->data;
    r = c->data;

    ngx_log_debug0(NGX_LOG_DEBUG_HTTP, rev->log, 0,
                   "http process request header line");

    if (rev->timedout)
    {
        ngx_log_error(NGX_LOG_INFO, c->log, NGX_ETIMEDOUT, "client timed out");
        c->timedout = 1;
        ngx_http_close_request(r, NGX_HTTP_REQUEST_TIME_OUT);
        return;
    }

这部分代码是处理定时器超时事件，与解析HTTP请求行是相同的，不在多说。

 

    cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);

    rc = NGX_AGAIN;

    for (;;)
    {

        if (rc == NGX_AGAIN)
        {

            if (r->header_in->pos == r->header_in->end)
            {//表示分配的内存不足 需要申请更大内存

                rv = ngx_http_alloc_large_header_buffer(r, 0);

                if (rv == NGX_ERROR)
                {
                    ngx_http_close_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR);
                    return;
                }

                if (rv == NGX_DECLINED)
                {
                    p = r->header_name_start;

                    r->lingering_close = 1;

                    if (p == NULL)
                    {
                        ngx_log_error(NGX_LOG_INFO, c->log, 0,
                                      "client sent too large request");
                        ngx_http_finalize_request(r,
                                                  NGX_HTTP_REQUEST_HEADER_TOO_LARGE);
                        return;
                    }

                    len = r->header_in->end - p;

                    if (len > NGX_MAX_ERROR_STR - 300)
                    {
                        len = NGX_MAX_ERROR_STR - 300;
                    }

                    ngx_log_error(NGX_LOG_INFO, c->log, 0,
                                  "client sent too long header line: \"%*s...\"",
                                  len, r->header_name_start);

                    ngx_http_finalize_request(r,
                                              NGX_HTTP_REQUEST_HEADER_TOO_LARGE);
                    return;
                }
            }
            //接收 HTTP Header
            n = ngx_http_read_request_header(r);

            if (n == NGX_AGAIN || n == NGX_ERROR)
            {
                return;
            }
        }

这部分代码说明：

1、 判断内存是否足够，若不足则申请最大内存(默认8k)。由于HTTP报文是不定长报文，所以无法一次性申请足够内存。

2、调用ngx_http_read_request_header方法接收报文

        /* the host header could change the server configuration context */
        cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
        /**
         * http协议解析 
         * 返回值 : NGX_OK: 解析完header中的一行时返回
         *          NGX_HTTP_PARSE_HEADER_DONE: 解析完整个header时返回; 
         *          NGX_HTTP_PARSE_INVALID_HEADER: 解析出错时返回; 
         *          NGX_AGAIN: 表示需要读取新的请求头内容
         */
        rc = ngx_http_parse_header_line(r, r->header_in,
                                        cscf->underscores_in_headers);

 ngx_http_parse_header_line是纯粹解析HTTP报文的，将解析出的报文保存到header_in中。ngx_http_parse_header_line，返回值如下表：

返回值含义
NGX_OK当前header line解析成功（一个http请求中可以有多个header line）
NGX_HTTP_PARSE_HEADER_DONE表示所有HTTP Header都已经成功解析完毕
NGX_AGAIN表是当前header line没有接收完毕，需要再次接收
NGX_HTTP_PARSE_INVALID_HEADER解析失败，结束htt request

根据上表，我们来看一下具体处理内容：

        if (rc == NGX_OK)
        {//返回 NGX_OK 处理解析后数据

            r->request_length += r->header_in->pos - r->header_name_start;

            if (r->invalid_header && cscf->ignore_invalid_headers)
            {

                /* there was error while a header line parsing */

                ngx_log_error(NGX_LOG_INFO, c->log, 0,
                              "client sent invalid header line: \"%*s\"",
                              r->header_end - r->header_name_start,
                              r->header_name_start);
                continue;
            }

            /* a header line has been parsed successfully */

            h = ngx_list_push(&r->headers_in.headers);
            if (h == NULL)
            {
                ngx_http_close_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR);
                return;
            }

            h->hash = r->header_hash;

            h->key.len = r->header_name_end - r->header_name_start;
            h->key.data = r->header_name_start;
            h->key.data[h->key.len] = '\0';

            h->value.len = r->header_end - r->header_start;
            h->value.data = r->header_start;
            h->value.data[h->value.len] = '\0';

            h->lowcase_key = ngx_pnalloc(r->pool, h->key.len);
            if (h->lowcase_key == NULL)
            {
                ngx_http_close_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR);
                return;
            }

            if (h->key.len == r->lowcase_index)
            {
                ngx_memcpy(h->lowcase_key, r->lowcase_header, h->key.len);
            }
            else
            {
                ngx_strlow(h->lowcase_key, h->key.data, h->key.len);
            }

            hh = ngx_hash_find(&cmcf->headers_in_hash, h->hash,
                               h->lowcase_key, h->key.len);

            if (hh && hh->handler(r, h, hh->offset) != NGX_OK)
            {
                return;
            }

            ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
                           "http header: \"%V: %V\"",
                           &h->key, &h->value);

            continue;
        }

        if (rc == NGX_HTTP_PARSE_HEADER_DONE)
        {

            /**
             * a whole header has been parsed successfully 
             * 所有header行都解析成功 准备处理该http请求
             * 1、没有body则对该http请求进行后续处理
             * 2、如果有body则接收body
             */

            ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
                           "http header done");

            r->request_length += r->header_in->pos - r->header_name_start;

            r->http_state = NGX_HTTP_PROCESS_REQUEST_STATE;
            //http header解析完毕 进行处理request header
            rc = ngx_http_process_request_header(r);

            if (rc != NGX_OK)
            {
                return;
            }
            /* 处理http请求 */
            ngx_http_process_request(r);

            return;
        }

 这段代码比较重要，该代码段主要处理request header请求以及处理http request。

        if (rc == NGX_AGAIN)
        {

            /* a header line parsing is still not complete */

            continue;
        }

        /* rc == NGX_HTTP_PARSE_INVALID_HEADER */

        ngx_log_error(NGX_LOG_INFO, c->log, 0,
                      "client sent invalid header line");

        ngx_http_finalize_request(r, NGX_HTTP_BAD_REQUEST);
        return;
}

 这段代码针对NGX_AGAIN和NGX_HTTP_PARSE_INVALID_HEADER处理流程，比较简单。

二、ngx_http_process_request_header函数

该函数处理相对简单，主要针对header中参数合法性校验以及request对象相关成员进行再次赋值，例如：content_length_n、keep_alive等

ngx_int_t
ngx_http_process_request_header(ngx_http_request_t *r)
{
    if (r->headers_in.server.len == 0 && ngx_http_set_virtual_server(r, &r->headers_in.server) == NGX_ERROR)
    {
        return NGX_ERROR;
    }

    if (r->headers_in.host == NULL && r->http_version > NGX_HTTP_VERSION_10)
    {
        ngx_log_error(NGX_LOG_INFO, r->connection->log, 0,
                      "client sent HTTP/1.1 request without \"Host\" header");
        ngx_http_finalize_request(r, NGX_HTTP_BAD_REQUEST);
        return NGX_ERROR;
    }

    if (r->headers_in.content_length)
    {//如果body不空 则需要设置body长度
        r->headers_in.content_length_n =
            ngx_atoof(r->headers_in.content_length->value.data,
                      r->headers_in.content_length->value.len);

        if (r->headers_in.content_length_n == NGX_ERROR)
        {
            ngx_log_error(NGX_LOG_INFO, r->connection->log, 0,
                          "client sent invalid \"Content-Length\" header");
            ngx_http_finalize_request(r, NGX_HTTP_BAD_REQUEST);
            return NGX_ERROR;
        }
    }

    if (r->method == NGX_HTTP_TRACE)
    {
        ngx_log_error(NGX_LOG_INFO, r->connection->log, 0,
                      "client sent TRACE method");
        ngx_http_finalize_request(r, NGX_HTTP_NOT_ALLOWED);
        return NGX_ERROR;
    }

    if (r->headers_in.transfer_encoding)
    {
        if (r->headers_in.transfer_encoding->value.len == 7 && ngx_strncasecmp(r->headers_in.transfer_encoding->value.data,
                                                                               (u_char *)"chunked", 7) == 0)
        {
            r->headers_in.content_length = NULL;
            r->headers_in.content_length_n = -1;
            r->headers_in.chunked = 1;
        }
        else if (r->headers_in.transfer_encoding->value.len != 8 || ngx_strncasecmp(r->headers_in.transfer_encoding->value.data,
                                                                                    (u_char *)"identity", 8) != 0)
        {
            ngx_log_error(NGX_LOG_INFO, r->connection->log, 0,
                          "client sent unknown \"Transfer-Encoding\": \"%V\"",
                          &r->headers_in.transfer_encoding->value);
            ngx_http_finalize_request(r, NGX_HTTP_NOT_IMPLEMENTED);
            return NGX_ERROR;
        }
    }

    if (r->headers_in.connection_type == NGX_HTTP_CONNECTION_KEEP_ALIVE)
    {//处理长连接 设置超时时间
        if (r->headers_in.keep_alive)
        {
            r->headers_in.keep_alive_n =
                ngx_atotm(r->headers_in.keep_alive->value.data,
                          r->headers_in.keep_alive->value.len);
        }
    }

    return NGX_OK;
}

三、ngx_http_read_request_header函数

本篇和上一篇都有该函数，该函数主要功能就是接收HTTP报文，功能也比较简单。

/**
 * 获取request header
 * @param r http请求
 */
static ssize_t
ngx_http_read_request_header(ngx_http_request_t *r)
{
    ssize_t n;
    ngx_event_t *rev;
    ngx_connection_t *c;
    ngx_http_core_srv_conf_t *cscf;

    c = r->connection;
    rev = c->read;

    n = r->header_in->last - r->header_in->pos;

    if (n > 0)
    {/* 表示header_in中有数据 不需要从socket中获取数据 */
        return n;
    }

    if (rev->ready)
    {//获取报文
        n = c->recv(c, r->header_in->last,
                    r->header_in->end - r->header_in->last);
    }
    else
    {
        n = NGX_AGAIN;
    }

    if (n == NGX_AGAIN)
    {//加入事件驱动
        if (!rev->timer_set)
        {
            cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
            ngx_add_timer(rev, cscf->client_header_timeout);
        }

        if (ngx_handle_read_event(rev, 0) != NGX_OK)
        {
            ngx_http_close_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR);
            return NGX_ERROR;
        }

        return NGX_AGAIN;
    }

    if (n == 0)
    {
        ngx_log_error(NGX_LOG_INFO, c->log, 0,
                      "client prematurely closed connection");
    }

    if (n == 0 || n == NGX_ERROR)
    {
        c->error = 1;
        c->log->action = "reading client request headers";

        ngx_http_finalize_request(r, NGX_HTTP_BAD_REQUEST);
        return NGX_ERROR;
    }

    r->header_in->last += n; /* 获取到数据 */

    return n;
}

四、总结

本篇介绍了Nginx如何接收HTTP Header以及处理Header，下一篇介绍如何处理当前HTTP Request请求，即ngx_http_process_request。

xxb249
关注
专栏目录
nginx 处理http（发送http响应头数据篇 ----- ngx_http_header_filter_module模块处理）
huzilinitachi的专栏
04-16 4811
http状态行 响应头 Server //响应server名 Date //响应头日期 Content-Length //内容长度 Content-Encoding //内容编...
一篇文章带你入门Docker + Nginx.
ZhenXinMa
07-24 4397
Docker And Nginx. 简单学习Docker。 先理解一个问题：什么是容器？ 我以前简单学Docker的时候，用Docker部署Redis和MySQL的时候，我以为容器仅仅只是一个容器，在这里我首先要纠正一点就是，不要把容器想成简单的容器，可以把每一个容器想象成一个Linux环境，我认为这一点也是Docker比较牛的地方. ???? 一、Docker学习。 参考：Docker 教程 | 菜鸟教程 (runoob.com) ???? 1.1 什么是Docker. Doc
nginx(二十六)ngx_http_headers_nodule模块
wzj_110的博客
04-01 5053
一 add_header指令 ① 基本解读 细节点：nginx配置中'子块[eg:location]'中的'add_header'会'覆盖父块[eg:server全局]',而'不是'继承 补充：同一'level',不能有相同的'响应头' 1) add_header 指令用于添加返回头字段;如果没有'always'参数,当且仅当'状态码为图中列出'的那些时有效 2) 如果提供了'第三个参数 always',那么'无论状态码'是多少,'都会'带上 -->即使是'404的错误页面'...
nginx中使用if指令判断是否包含指定的请求头决定是否执行特定的指令（比如auth_request）
最新发布
liaomingwu的专栏
07-28 430
在nginx转发应用中，需要对请求进行身份识别，只有具有身份识别信息的请求，才需要执行身份识别，此时就可以根据请求中是否含有身份识别请求头信息，只有包含身份识别请求头的请求才转发到身份认证服务进行身份认证，其它请求直接转发到应用服务器，这样就避免了每个请求都转发到身份认证服务造成的性能下降。
nginx 自定义http header
weixin_34050427的博客
07-31 132
用NGINX做负载，但后端有N多服务器，请求过去不知道到哪台服务器，为了便于定位问题，我们自定义http header加入后端服务器，先看下配置upstreambackend{ server172.29.88.226:8080weight=1; server172.29.88.227:8080weight=1; sticky;} ##CustomHeader...
「Nginx」- 记录 HTTP 请求头到日志 @20210223
k4nz
02-23 1678
问题描述 我们希望在日志中记录 HTTP 请求头信息，以查看请求信息、进行请求调试等等。 该笔记将记录：在 Nginx 中，如何在日志中记录 HTTP 请求头信息。 解决方案 简单说：目前（01/11/2021），没有直接的方案（变量），需要变通处理。 方案一、枚举变量 我们自定义日志格式，并在日志中打印这些变量。如下示例，输出部分与客户端网络地址有关的变量： log_format client_ip_address '[$time_local] Host="$http_host", '.
nginx http header [Connection: keep-alive]的实现原理
weixin_38597669的博客
05-04 2087
http keep-alive实现了对同一tcp连接的复用，即可以在一个TCP连接中发送多个HTTP请求，这种技术叫做HTTP复用（HTTP Multiplexing），与TCP连接复用是完全不同的技术，不要混淆了。HTTP复用(对同一tcp连接的复用)只是针对同一个客户端来说的，对于不同的客户端是无法做到的，要想实现就需要TCP复用技术了。
nginx 部署前端项目的详细步骤（vue项目build打包+nginx部署）_前端工程打包部署到nginx(2)
2401_84437170的博客
04-28 515
函数式编程其实是一种编程思想，它追求更细的粒度，将应用拆分成一组组极小的单元函数，组合调用操作数据流；它提倡着 纯函数 / 函数复合 / 数据不可变， 谨慎对待函数内的 状态共享 / 依赖外部 / 副作用；
配置nginx+uwsgi+django遇到的那些坑
qq_40298054的博客
12-07 740
问题一：uwsgi--配置出错 bind(): Address already in use [core/socket.c line 769] uwsgi已经启动，之前并没有彻底清除进程 #.pid文件中存储的是PID，也可用kill进行清除 uwsgi --stop uwsgi.pid #8000为使用uwsgi绑定的端口号 sudo fuser -k 8000/tcp 问题二：nginx转发WebSocket请求 502 Bad Gateway 阿里云的网络问题 uwsgi.ini配置里的
nginx+Redis+tomcat实现session共享测试代码
01-30
首先，Nginx作为反向代理服务器，它负责接收来自用户的请求，并根据配置将这些请求转发到适当的后端服务，如Tomcat。Nginx的配置文件（通常为`nginx.conf`）中，可以通过`proxy_pass`指令来指定目标服务器。为了实现...
PHP 学习路线
墨鱼菜鸡
07-11 3480
PHP 官网文档(中文)：https://www.php.net/manual/zh/langref.php ThinkPhp (官方手册、入门教程)：https://sites.thinkphp.cn/1556331 ​W3School PHP 教程：http://www.w3school.com.cn/php/index.asp w3cschool...
详解nginx请求头数据读取流程
09-29
主要介绍了详解nginx请求头数据读取流程，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
详解Nginx服务器中HTTP Headers相关的模块配置使用
01-20
ngx_http_headers_module模块 一. 前言 ngx_http_headers_module模块提供了两个重要的指令add_header和expires，来添加 “Expires” 和 “Cache-Control” 头字段，对响应头添加任何域字段。add_header可以用来标示请求访问到哪台服务器上，这个也可以通过nginx模块nginx-http-footer-filter研究使用来实现。expires指令用来对浏览器本地缓存的控制。 二. add_header指令 语法: add_header name value; 默认值: — 配置段: http, server,
http header 详解
12-25
HTTP Headers是HTTP请求和相应的核心，它承载了关于客户端浏览器，请求页面，服务器等相关的信息， 此文档帮助你分析HTTP headers
Nginx 获取自定义请求header头和URL参数
热门推荐
JineD的博客
06-23 1万+
1、自定义请求header (Jquery为例) 2、在Nginx中获取请求header在nginx的location配置中，在获取header配置时，须要在header名称前面加上固定前缀“http_“，并将header名称中的“-”中划线变为下划线，举例说明： 自定义的header名称为X-TimerLocal，那在nginx中使用$http_x_timerlocal 来获取到X-TimerLocal的值。 if ($http_x_timerlocal  = 'B
conn.recv()参数值设置 缓存_Nginx常用模块---ngx_http_headers_module设置HTTP响应头
weixin_39630440的博客
12-18 216
Nginx常用模块---ngx_http_headers_module设置HTTP响应头HTTP头信息，是实际业务中一个很重要的功能。例如，如果需要将请求结果在浏览器上缓存一段时间，或者在请求代理到后端服务器的过程中生成一个唯一的 ID进行识别。通过对 Nginx进行配置，可以轻松实现这些功能。ngx_http_headers_module是在 Nginx编译时默认自带的模块，主要包含 add_h...
nginx处理HTTP header问题
weixin_34319999的博客
09-22 261
在实际开发中遇到http header 自定义key中包含下划线（_）时服务端header丢失的问题，解决办法详细见以下网页内容，感谢原博主 http://blog.csdn.net/dac55300424/article/details/48155919 转载于:https://www.cnblogs.com/houhaihu/p/7573964.html...
30.Nginx HTTP之读取处理请求头函数ngx_http_process_request_headers
疯哥哥带你飞
11-16 1962
在HTTP >= 1.0的版本中，读取处理完HTTP请求行后，紧接着就应该是读取处理HTTP请求头了，Nginx使用ngx_http_process_request_headers来完成这个工作。 /* http/ngx_http_request.c */ /* 处理HTTP请求头 * param r: 待处理的HTTP请求 * return : */ static ngx_i
nginx添加header
xinhuixu博客
07-29 2800
参考配置如下 '"http_Authorization":"$http_Authorization",' key Value “http_Authorization” “$http_Authorization”
nginx http header
06-06
在 Nginx 中，可以通过在 server 和 location 块中使用 add_header 指令来设置 HTTP 头部。例如，以下是一个设置 Content-Type 头部的示例： ``` server { listen 80; server_name example.com; location / { ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值