詳解nginx請(qǐng)求頭數(shù)據(jù)讀取流程

POST /web/book/read HTTP/1.1
Host: localhost
Connection: keep-alive
Content-Length: 365
Accept: application/json, text/plain, */*

/**
 * 解析客戶(hù)端發(fā)送來(lái)的header數(shù)據(jù)
 */
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;

 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;
 }

 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
 rc = NGX_AGAIN;

 for (;;) {
  if (rc == NGX_AGAIN) {
   // 如果當(dāng)前header緩沖區(qū)中沒(méi)有剩余空間，則申請(qǐng)新的空間
   if (r->header_in->pos == r->header_in->end) {
    // 申請(qǐng)新的空間
    rv = ngx_http_alloc_large_header_buffer(r, 0);
    if (rv == NGX_ERROR) {
     ngx_http_close_request(r, NGX_HTTP_INTERNAL_SERVER_ERROR);
     return;
    }

    // 客戶(hù)端發(fā)送的header太長(zhǎng)，超出了large_client_header_buffers指定的最大大小
    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_http_finalize_request(r, NGX_HTTP_REQUEST_HEADER_TOO_LARGE);
     return;
    }
   }

   // 嘗試讀取連接上客戶(hù)端新發(fā)送來(lái)的數(shù)據(jù)
   n = ngx_http_read_request_header(r);
   if (n == NGX_AGAIN || n == NGX_ERROR) {
    return;
   }
  }

  cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
  // 這里主要是對(duì)讀取到的數(shù)據(jù)進(jìn)行轉(zhuǎn)換
  rc = ngx_http_parse_header_line(r, r->header_in, cscf->underscores_in_headers);

  // NGX_OK表示成功解析得到了一個(gè)header數(shù)據(jù)
  if (rc == NGX_OK) {
   r->request_length += r->header_in->pos - r->header_name_start;
   // 過(guò)濾無(wú)效的header
   if (r->invalid_header && cscf->ignore_invalid_headers) {
    continue;
   }

   // 創(chuàng)建一個(gè)存儲(chǔ)header的結(jié)構(gòu)體
   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;
   // 把header的name作為hash表的key
   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';

   // 把header的value作為hash表的value
   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);
   }

   // headers_in_hash中存儲(chǔ)了所有的header，這里是查找當(dāng)前客戶(hù)端傳的header是否為有效的header
   hh = ngx_hash_find(&cmcf->headers_in_hash, h->hash, h->lowcase_key, h->key.len);
   // 這里的handler是在ngx_http_headers_in中為每一個(gè)header定義的處理方法，經(jīng)過(guò)各個(gè)header的
   // handler()方法處理后，客戶(hù)端傳來(lái)的header就都轉(zhuǎn)換到r->headers_in結(jié)構(gòu)體中的各個(gè)屬性中了
   if (hh && hh->handler(r, h, hh->offset) != NGX_OK) {
    return;
   }

   continue;
  }

  // NGX_HTTP_PARSE_HEADER_DONE表示已經(jīng)將所有的header都處理完成了
  if (rc == NGX_HTTP_PARSE_HEADER_DONE) {
   r->request_length += r->header_in->pos - r->header_name_start;
   r->http_state = NGX_HTTP_PROCESS_REQUEST_STATE;
   // 檢查客戶(hù)端發(fā)送來(lái)的header數(shù)據(jù)的合法性
   rc = ngx_http_process_request_header(r);
   if (rc != NGX_OK) {
    return;
   }

   ngx_http_process_request(r);
   return;
  }

  // NGX_AGAIN表示讀取到的header行數(shù)據(jù)不完全，還需要繼續(xù)讀取
  if (rc == NGX_AGAIN) {
   continue;
  }
  
  ngx_log_error(NGX_LOG_INFO, c->log, 0, "client sent invalid header line");
  ngx_http_finalize_request(r, NGX_HTTP_BAD_REQUEST);
  return;
 }
}

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;

 // 計(jì)算當(dāng)前還有多少數(shù)據(jù)未處理
 n = r->header_in->last - r->header_in->pos;

 // 如果n大于0，說(shuō)明還有讀取到的數(shù)據(jù)未處理，則直接返回n
 if (n > 0) {
  return n;
 }

 // 走到這里，說(shuō)明當(dāng)前讀取到的數(shù)據(jù)都已經(jīng)處理完了，因而這里會(huì)進(jìn)行判斷，如果當(dāng)前事件的ready參數(shù)為1，
 // 則表示當(dāng)前連接的句柄上存儲(chǔ)還未讀取的數(shù)據(jù)，因而調(diào)用c->recv()方法讀取數(shù)據(jù)，否則繼續(xù)將當(dāng)前事件添加到
 // 事件隊(duì)列中，并且繼續(xù)監(jiān)聽(tīng)當(dāng)前連接句柄的讀事件
 if (rev->ready) {
  // 在連接文件描述符上讀取數(shù)據(jù)
  n = c->recv(c, r->header_in->last, r->header_in->end - r->header_in->last);
 } else {
  n = NGX_AGAIN;
 }

 // 如果n為NGX_AGAIN，則將當(dāng)前事件添加到事件監(jiān)聽(tīng)器中，并且繼續(xù)監(jiān)聽(tīng)當(dāng)前epoll句柄的讀事件
 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;
 }

 // 如果n為0，說(shuō)明客戶(hù)端關(guān)閉了連接
 if (n == 0) {
  ngx_log_error(NGX_LOG_INFO, c->log, 0, "client prematurely closed connection");
 }

 // 如果客戶(hù)端關(guān)閉了連接或者讀取異常，則回收當(dāng)前的request結(jié)構(gòu)體
 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;
 }

 // 更新當(dāng)前讀取到的數(shù)據(jù)指針
 r->header_in->last += n;
 return n;
}