http static module · Nginx開發從入門到精通

### http static module[](http://tengine.taobao.org/book/chapter_03.html#http-static-module "永久鏈接至標題") 從某種程度上來說，此模塊可以算的上是“最正宗的”，“最古老”的content handler。因為本模塊的作用就是讀取磁盤上的靜態文件，并把文件內容作為產生的輸出。在Web技術發展的早期，只有靜態頁面，沒有服務端腳本來動態生成HTML的時候。恐怕開發個Web服務器的時候，第一個要開發就是這樣一個content handler。 http static module的代碼位于src/http/modules/ngx_http_static_module.c中，總共只有兩百多行近三百行。可以說是非常短小。我們首先來看一下該模塊的模塊上下文的定義。 [](http:// "點擊提交Issue,反饋你的意見...") ngx_http_module_t ngx_http_static_module_ctx = { NULL, /* preconfiguration */ ngx_http_static_init, /* 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 */ }; 是非常的簡潔吧，連任何與配置相關的函數都沒有。對了，因為該模塊沒有提供任何配置指令。大家想想也就知道了，這個模塊做的事情實在是太簡單了，也確實沒什么好配置的。唯一需要調用的函數是一個ngx_http_static_init函數。好了，來看一下這個函數都干了寫什么。 [](http:// "點擊提交Issue,反饋你的意見...") static ngx_int_t ngx_http_static_init(ngx_conf_t *cf) { ngx_http_handler_pt *h; ngx_http_core_main_conf_t *cmcf; cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module); h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers); if (h == NULL) { return NGX_ERROR; } *h = ngx_http_static_handler; return NGX_OK; } 僅僅是掛載這個handler到NGX_HTTP_CONTENT_PHASE處理階段。簡單吧？下面我們就看一下這個模塊最核心的處理邏輯所在的ngx_http_static_handler函數。該函數大概占了這個模塊代碼量的百分之八九十。 [](http:// "點擊提交Issue,反饋你的意見...") static ngx_int_t ngx_http_static_handler(ngx_http_request_t *r) { u_char *last, *location; size_t root, len; ngx_str_t path; ngx_int_t rc; ngx_uint_t level; ngx_log_t *log; ngx_buf_t *b; ngx_chain_t out; ngx_open_file_info_t of; ngx_http_core_loc_conf_t *clcf; if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST))) { return NGX_HTTP_NOT_ALLOWED; } if (r->uri.data[r->uri.len - 1] == '/') { return NGX_DECLINED; } log = r->connection->log; /* * ngx_http_map_uri_to_path() allocates memory for terminating '\0' * so we do not need to reserve memory for '/' for possible redirect */ last = ngx_http_map_uri_to_path(r, &path, &root, 0); if (last == NULL) { return NGX_HTTP_INTERNAL_SERVER_ERROR; } path.len = last - path.data; ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0, "http filename: \"%s\"", path.data); clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module); ngx_memzero(&of, sizeof(ngx_open_file_info_t)); of.read_ahead = clcf->read_ahead; of.directio = clcf->directio; of.valid = clcf->open_file_cache_valid; of.min_uses = clcf->open_file_cache_min_uses; of.errors = clcf->open_file_cache_errors; of.events = clcf->open_file_cache_events; if (ngx_http_set_disable_symlinks(r, clcf, &path, &of) != NGX_OK) { return NGX_HTTP_INTERNAL_SERVER_ERROR; } if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool) != NGX_OK) { switch (of.err) { case 0: return NGX_HTTP_INTERNAL_SERVER_ERROR; case NGX_ENOENT: case NGX_ENOTDIR: case NGX_ENAMETOOLONG: level = NGX_LOG_ERR; rc = NGX_HTTP_NOT_FOUND; break; case NGX_EACCES: #if (NGX_HAVE_OPENAT) case NGX_EMLINK: case NGX_ELOOP: #endif level = NGX_LOG_ERR; rc = NGX_HTTP_FORBIDDEN; break; default: level = NGX_LOG_CRIT; rc = NGX_HTTP_INTERNAL_SERVER_ERROR; break; } if (rc != NGX_HTTP_NOT_FOUND || clcf->log_not_found) { ngx_log_error(level, log, of.err, "%s \"%s\" failed", of.failed, path.data); } return rc; } r->root_tested = !r->error_page; ngx_log_debug1(NGX_LOG_DEBUG_HTTP, log, 0, "http static fd: %d", of.fd); if (of.is_dir) { ngx_log_debug0(NGX_LOG_DEBUG_HTTP, log, 0, "http dir"); ngx_http_clear_location(r); r->headers_out.location = ngx_palloc(r->pool, sizeof(ngx_table_elt_t)); if (r->headers_out.location == NULL) { return NGX_HTTP_INTERNAL_SERVER_ERROR; } len = r->uri.len + 1; if (!clcf->alias && clcf->root_lengths == NULL && r->args.len == 0) { location = path.data + clcf->root.len; *last = '/'; } else { if (r->args.len) { len += r->args.len + 1; } location = ngx_pnalloc(r->pool, len); if (location == NULL) { return NGX_HTTP_INTERNAL_SERVER_ERROR; } last = ngx_copy(location, r->uri.data, r->uri.len); *last = '/'; if (r->args.len) { *++last = '?'; ngx_memcpy(++last, r->args.data, r->args.len); } } /* * we do not need to set the r->headers_out.location->hash and * r->headers_out.location->key fields */ r->headers_out.location->value.len = len; r->headers_out.location->value.data = location; return NGX_HTTP_MOVED_PERMANENTLY; } #if !(NGX_WIN32) /* the not regular files are probably Unix specific */ if (!of.is_file) { ngx_log_error(NGX_LOG_CRIT, log, 0, "\"%s\" is not a regular file", path.data); return NGX_HTTP_NOT_FOUND; } #endif if (r->method & NGX_HTTP_POST) { return NGX_HTTP_NOT_ALLOWED; } rc = ngx_http_discard_request_body(r); if (rc != NGX_OK) { return rc; } log->action = "sending response to client"; r->headers_out.status = NGX_HTTP_OK; r->headers_out.content_length_n = of.size; r->headers_out.last_modified_time = of.mtime; if (ngx_http_set_content_type(r) != NGX_OK) { return NGX_HTTP_INTERNAL_SERVER_ERROR; } if (r != r->main && of.size == 0) { return ngx_http_send_header(r); } r->allow_ranges = 1; /* we need to allocate all before the header would be sent */ b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t)); if (b == NULL) { return NGX_HTTP_INTERNAL_SERVER_ERROR; } b->file = ngx_pcalloc(r->pool, sizeof(ngx_file_t)); if (b->file == NULL) { return NGX_HTTP_INTERNAL_SERVER_ERROR; } rc = ngx_http_send_header(r); if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) { return rc; } b->file_pos = 0; b->file_last = of.size; b->in_file = b->file_last ? 1: 0; b->last_buf = (r == r->main) ? 1: 0; b->last_in_chain = 1; b->file->fd = of.fd; b->file->name = path; b->file->log = log; b->file->directio = of.is_directio; out.buf = b; out.next = NULL; return ngx_http_output_filter(r, &out); } 首先是檢查客戶端的http請求類型（r->method），如果請求類型為NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST，則繼續進行處理，否則一律返回NGX_HTTP_NOT_ALLOWED從而拒絕客戶端的發起的請求。其次是檢查請求的url的結尾字符是不是斜杠‘/’，如果是說明請求的不是一個文件，給后續的handler去處理，比如后續的ngx_http_autoindex_handler（如果是請求的是一個目錄下面，可以列出這個目錄的文件），或者是ngx_http_index_handler（如果請求的路徑下面有個默認的index文件，直接返回index文件的內容）。然后接下來調用了一個ngx_http_map_uri_to_path函數，該函數的作用是把請求的http協議的路徑轉化成一個文件系統的路徑。然后根據轉化出來的具體路徑，去打開文件，打開文件的時候做了2種檢查，一種是，如果請求的文件是個symbol link，根據配置，是否允許符號鏈接，不允許返回錯誤。還有一個檢查是，如果請求的是一個名稱，是一個目錄的名字，也返回錯誤。如果都沒有錯誤，就讀取文件，返回內容。其實說返回內容可能不是特別準確，比較準確的說法是，把產生的內容傳遞給后續的filter去處理。