error_page的用法
- 微信公衆號：鄭爾多斯
- 關注「鄭爾多斯」公衆號 ，回覆「領取資源」，獲取IT資源500G乾貨。
升職加薪、當上總經理、出任CEO、迎娶白富美、走上人生巔峯！想一想還有點小激動- 關注可瞭解更多的
Nginx知識。任何問題或建議，請公衆號留言;
關注公衆號，有趣有內涵的文章第一時間送達！
一、從文檔看一下error_page的用法
error_page 404 =200 /404.txt
typedef struct {
ngx_int_t status; // error後面的錯誤碼,如上面的404
// 被改寫以後的code，如上面的200，
// 若是是 error_page 404 = /404.php 這種形式的，那麼 overrite = 0
// 若是是 error_page 404 /404.txt 這種直接沒有等號的，那麼若是error_page後面的錯誤碼爲NGX_HTTP_TO_HTTPS（497）,NGX_HTTPS_NO_CERT（496），NGX_HTTPS_CERT_ERROR（495）, 那麼overrite = 400，其餘狀況下 overrite = -1
ngx_int_t overwrite; // response
// value和args的值最終有如下幾種狀況：
1、error_page 後面沒有等號，即error_page code uri; 這時overrite就會按照上面的狀況進行賦值，若是code=NGX_HTTP_TO_HTTPS（497）,NGX_HTTPS_NO_CERT（496），NGX_HTTPS_CERT_ERROR（495）,那麼最終overwrite=40，這個時候value和args都是空的。
2、其餘狀況下，value和args表示uri中的path和參數
ngx_http_complex_value_t value;// 編譯以後的value
ngx_str_t args;
} ngx_http_err_page_t;
複製代碼
// 格式：error_page code ... [=[response]] uri;
static char * ngx_http_core_error_page(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_http_core_loc_conf_t *clcf = conf;
// error_page
u_char *p;
ngx_int_t overwrite;
ngx_str_t *value, uri, args;
ngx_uint_t i, n;
ngx_http_err_page_t *err;
ngx_http_complex_value_t cv;
ngx_http_compile_complex_value_t ccv;
if (clcf->error_pages == NULL) {
clcf->error_pages = ngx_array_create(cf->pool, 4, sizeof(ngx_http_err_page_t));
}
value = cf->args->elts;
i = cf->args->nelts - 2;
if (value[i].data[0] == '=') { // 看一下倒數第二個參數是不是以等號開頭的
if (i == 1) {// 判斷參數的合法性
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "invalid value \"%V\"", &value[i]);
return NGX_CONF_ERROR;
}
if (value[i].len > 1) { // 錯誤碼被重寫，好比 error_page 404 =200 /empty.gif
// overrite表示被重寫以後的響應code
overwrite = ngx_atoi(&value[i].data[1], value[i].len - 1);
if (overwrite == NGX_ERROR) {// 忽略錯誤處理邏輯
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "invalid value \"%V\"", &value[i]);
return NGX_CONF_ERROR;
}
} else {
overwrite = 0;
}
// 這裏的n表示的是從後往前數，第幾個參數是code,如 error_pages 302 304 =404 /404.html，那麼n=2
n = 2;
} else { // 這種狀況說明沒有重寫錯誤碼
overwrite = -1;
n = 1;
}
uri = value[cf->args->nelts - 1]; // 最後一個參數，uri參數,uri能夠包含參數
ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t));
ccv.cf = cf;
ccv.value = &uri;
ccv.complex_value = &cv;
// 編譯uri的參數
if (ngx_http_compile_complex_value(&ccv) != NGX_OK) {
return NGX_CONF_ERROR;
}
ngx_str_null(&args);
// uri 有三種格式，分別爲：
// ① 斜線開頭的一個uri
// ② 以@開頭的uri
// ③ 以非上述兩種方式開頭的uri
if (cv.lengths == NULL && uri.data[0] == '/') {
p = (u_char *) ngx_strchr(uri.data, '?');
if (p) {
cv.value.len = p - uri.data;
cv.value.data = uri.data;
p++;
args.len = (uri.data + uri.len) - p;
args.data = p;
}
}
for (i = 1; i < cf->args->nelts - n; i++) {
err = ngx_array_push(clcf->error_pages);
if (err == NULL) {
return NGX_CONF_ERROR;
}
err->status = ngx_atoi(value[i].data, value[i].len);
if (err->status == NGX_ERROR || err->status == 499) {
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
"invalid value \"%V\"", &value[i]);
return NGX_CONF_ERROR;
}
if (err->status < 300 || err->status > 599) {
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
"value \"%V\" must be between 300 and 599",
&value[i]);
return NGX_CONF_ERROR;
}
err->overwrite = overwrite;
if (overwrite == -1) {
switch (err->status) {
case NGX_HTTP_TO_HTTPS:
case NGX_HTTPS_CERT_ERROR:
case NGX_HTTPS_NO_CERT:
err->overwrite = NGX_HTTP_BAD_REQUEST;
default:
break;
}
}
err->value = cv;
err->args = args;
}
return NGX_CONF_OK;
}
複製代碼
發送的函數：php
ngx_int_t ngx_http_filter_finalize_request(ngx_http_request_t *r, ngx_module_t *m,
ngx_int_t error)
{
void *ctx;
ngx_int_t rc;
ngx_http_clean_header(r);
ctx = NULL;
if (m) { // 若是m不爲空，那麼ctx就保存了m這個module的模塊上下文
ctx = r->ctx[m->ctx_index];
}
/* clear the modules contexts, 清空全部模塊的ctx*/
ngx_memzero(r->ctx, sizeof(void *) * ngx_http_max_module);
if (m) { // 將上面保存的模塊上下文信息從新賦值給r->ctx，因此這裏的參數m表示要保存m的模塊上下文
r->ctx[m->ctx_index] = ctx;
}
r->filter_finalize = 1;
// 下面調用 ngx_http_special_response_handler 函數來發送最終的結果
rc = ngx_http_special_response_handler(r, error);
/* NGX_ERROR resets any pending data */
switch (rc) {
case NGX_OK:
case NGX_DONE:
return NGX_ERROR;
default:
return rc;
}
}
複製代碼
必定要忽略旁枝末節，抓住最主要的內容。必定要這樣
必定要忽略旁枝末節，抓住最主要的內容。必定要這樣
必定要忽略旁枝末節，抓住最主要的內容。必定要這樣
重要的事情說三遍
ngx_int_t ngx_http_special_response_handler(ngx_http_request_t *r, ngx_int_t error)
{
ngx_uint_t i, err;
ngx_http_err_page_t *err_page;
ngx_http_core_loc_conf_t *clcf;
r->err_status = error;
// 下面的兩段代碼是用來設置keepalive和lingering_close的，說真的，不用關心這些細節，等到下一次分析源碼的時候在關注這些東西
if (r->keepalive) {
switch (error) {
case NGX_HTTP_BAD_REQUEST:
case NGX_HTTP_REQUEST_ENTITY_TOO_LARGE:
case NGX_HTTP_REQUEST_URI_TOO_LARGE:
case NGX_HTTP_TO_HTTPS:
case NGX_HTTPS_CERT_ERROR:
case NGX_HTTPS_NO_CERT:
case NGX_HTTP_INTERNAL_SERVER_ERROR:
r->keepalive = 0;
}
}
if (r->lingering_close) {
switch (error) {
case NGX_HTTP_BAD_REQUEST:
case NGX_HTTP_TO_HTTPS:
case NGX_HTTPS_CERT_ERROR:
case NGX_HTTPS_NO_CERT:
r->lingering_close = 0;
}
}
r->headers_out.content_type.len = 0;
clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
// 全局搜索error_page,發現只有在recursive_error_pages = true的時候纔會設置r->error_page。
// clcf->error_pages 是一個數組，表示的是error_page後面的每一個code.
// r->uri_changes 表示的是內部重定向的次數。
if (!r->error_page && clcf->error_pages && r->uri_changes != 0) {
if (clcf->recursive_error_pages == 0) {
r->error_page = 1;
}
err_page = clcf->error_pages->elts;
// 遍歷全部的error_pages的元素，試圖找到一個code和當前的error的code相同
for (i = 0; i < clcf->error_pages->nelts; i++) {
if (err_page[i].status == error) {
// 最終調用 ngx_http_send_error_page() 函數來發送錯誤碼
return ngx_http_send_error_page(r, &err_page[i]);
}
}
}
r->expect_tested = 1;
if (ngx_http_discard_request_body(r) != NGX_OK) {
error = NGX_HTTP_INTERNAL_SERVER_ERROR;
}
// msie_refresh 和 msie 表示的是ie瀏覽器。顯然這裏是對ie瀏覽器的特殊處理，
// 咱們並不須要關心這些特殊邏輯，因此忽略這部分便可
if (clcf->msie_refresh
&& r->headers_in.msie
&& (error == NGX_HTTP_MOVED_PERMANENTLY
|| error == NGX_HTTP_MOVED_TEMPORARILY))
{
return ngx_http_send_refresh(r);
}
// 根據參數中的error錯誤碼，計算一個err碼。
// 其實err的值就是在ngx_http_error_pages數組中的索引
if (error == NGX_HTTP_CREATED) {
/* 201 */
err = 0;
} else if (error == NGX_HTTP_NO_CONTENT) {
/* 204 */
err = 0;
} else if (error >= NGX_HTTP_MOVED_PERMANENTLY
&& error < NGX_HTTP_LAST_3XX)
{
/* 3XX */
err = error - NGX_HTTP_MOVED_PERMANENTLY + NGX_HTTP_OFF_3XX;
} else if (error >= NGX_HTTP_BAD_REQUEST
&& error < NGX_HTTP_LAST_4XX)
{
/* 4XX */
err = error - NGX_HTTP_BAD_REQUEST + NGX_HTTP_OFF_4XX;
} else if (error >= NGX_HTTP_NGINX_CODES
&& error < NGX_HTTP_LAST_5XX)
{
/* 49X, 5XX */
err = error - NGX_HTTP_NGINX_CODES + NGX_HTTP_OFF_5XX;
switch (error) {
case NGX_HTTP_TO_HTTPS:
case NGX_HTTPS_CERT_ERROR:
case NGX_HTTPS_NO_CERT:
case NGX_HTTP_REQUEST_HEADER_TOO_LARGE:
r->err_status = NGX_HTTP_BAD_REQUEST;
break;
}
} else {
/* unknown code, zero body */
err = 0;
}
return ngx_http_send_special_response(r, clcf, err);
}
複製代碼
// 發送錯誤代碼
// err_page 是符合當前錯誤碼的error配置
static ngx_int_t ngx_http_send_error_page(ngx_http_request_t *r, ngx_http_err_page_t *err_page)
{
ngx_int_t overwrite;
ngx_str_t uri, args;
ngx_table_elt_t *location;
ngx_http_core_loc_conf_t *clcf;
// overwrite是設置的response code
overwrite = err_page->overwrite;
if (overwrite && overwrite != NGX_HTTP_OK) {
r->expect_tested = 1;
}
if (overwrite >= 0) { // 若是配置了合適的response code，那麼就發送這個錯誤碼
r->err_status = overwrite;
}
// 計算uri中的值，咱們使用最簡單的方式，那就是uri中不包含變量，因此咱們能夠完美的忽略這一個步驟，
// 計算變量的值是很是複雜的，可是這裏並非咱們最主要的關注點，因此忽略這一個步驟。
// 由於不管如何，最終都會造成一個符合要求的uri用於跳轉
if (ngx_http_complex_value(r, &err_page->value, &uri) != NGX_OK) {
return NGX_ERROR;
}
// 若是最終的uri是以slash開頭的
if (uri.data[0] == '/') {
if (err_page->value.lengths) {
ngx_http_split_args(r, &uri, &args);
} else {
args = err_page->args;
}
if (r->method != NGX_HTTP_HEAD) {
r->method = NGX_HTTP_GET;
r->method_name = ngx_http_get_name;
}
return ngx_http_internal_redirect(r, &uri, &args);
}
// 若是是以 @ 開頭的，表示這是一個內部跳轉
if (uri.data[0] == '@') {
return ngx_http_named_location(r, &uri);
}
// 若是uri既不是以slash開頭的，也不是以 @ 開頭的，那麼就表示這是一個普通的uri，要進行302跳轉，具體能夠看一下nginx官方文檔中相應的說明
location = ngx_list_push(&r->headers_out.headers);
if (location == NULL) {
return NGX_ERROR;
}
if (overwrite != NGX_HTTP_MOVED_PERMANENTLY
&& overwrite != NGX_HTTP_MOVED_TEMPORARILY
&& overwrite != NGX_HTTP_SEE_OTHER
&& overwrite != NGX_HTTP_TEMPORARY_REDIRECT)
{
r->err_status = NGX_HTTP_MOVED_TEMPORARILY;
}
location->hash = 1;
ngx_str_set(&location->key, "Location");
location->value = uri;
ngx_http_clear_location(r);
r->headers_out.location = location;
clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
if (clcf->msie_refresh && r->headers_in.msie) {
return ngx_http_send_refresh(r);
}
return ngx_http_send_special_response(r, clcf, r->err_status
- NGX_HTTP_MOVED_PERMANENTLY
+ NGX_HTTP_OFF_3XX);
}
複製代碼
上面咱們分析了，若是uri以slash開頭，則會調用 ngx_http_internal_redirect().
若是以 @ 開頭，則會調用 ngx_http_named_location()。
這兩個函數都很是簡單，仔細分析一下就好了，下面咱們看一下剩下的一個函數 ngx_http_send_special_response.html
static ngx_int_t ngx_http_send_special_response(ngx_http_request_t *r,
ngx_http_core_loc_conf_t *clcf, ngx_uint_t err)
{
u_char *tail;
size_t len;
ngx_int_t rc;
ngx_buf_t *b;
ngx_uint_t msie_padding;
ngx_chain_t out[3];
// 從nginx.org的文檔中能夠看到，server_tokens 配置參數用於表示響應中是否包含nginx服務器的詳細版本信息
if (clcf->server_tokens) {
len = sizeof(ngx_http_error_full_tail) - 1;
tail = ngx_http_error_full_tail;
} else {
len = sizeof(ngx_http_error_tail) - 1;
tail = ngx_http_error_tail;
}
msie_padding = 0;
if (ngx_http_error_pages[err].len) {
r->headers_out.content_length_n = ngx_http_error_pages[err].len + len;
// 從nginx.org文檔中看了一下 msie_padding的用法，這個配置是專門針對IE瀏覽器的，和咱們分析代碼沒有關係，略過便可
if (clcf->msie_padding
&& (r->headers_in.msie || r->headers_in.chrome)
&& r->http_version >= NGX_HTTP_VERSION_10
&& err >= NGX_HTTP_OFF_4XX)
{
r->headers_out.content_length_n +=
sizeof(ngx_http_msie_padding) - 1;
msie_padding = 1;
}
r->headers_out.content_type_len = sizeof("text/html") - 1;
ngx_str_set(&r->headers_out.content_type, "text/html");
r->headers_out.content_type_lowcase = NULL;
} else {
r->headers_out.content_length_n = 0;
}
if (r->headers_out.content_length) {
r->headers_out.content_length->hash = 0;
r->headers_out.content_length = NULL;
}
// 下面的兩個方法是用來清空響應頭中的accept_range和last_modified
ngx_http_clear_accept_ranges(r);
ngx_http_clear_last_modified(r);
// 調用ngx_http_send_header() 發送響應頭
rc = ngx_http_send_header(r);
if (rc == NGX_ERROR || r->header_only) {
return rc;
}
if (ngx_http_error_pages[err].len == 0) {
return ngx_http_send_special(r, NGX_HTTP_LAST);
}
// 下面的代碼就是根據錯誤信息，構建一個ngx_chain_t，而後將信息發送出去
b = ngx_calloc_buf(r->pool);
b->memory = 1;
b->pos = ngx_http_error_pages[err].data;
b->last = ngx_http_error_pages[err].data + ngx_http_error_pages[err].len;
out[0].buf = b;
out[0].next = &out[1];
b = ngx_calloc_buf(r->pool);
if (b == NULL) {
return NGX_ERROR;
}
b->memory = 1;
b->pos = tail;
b->last = tail + len;
out[1].buf = b;
out[1].next = NULL;
if (msie_padding) { // 針對MSIE的特殊處理邏輯，可有可無，忽略
b = ngx_calloc_buf(r->pool);
if (b == NULL) {
return NGX_ERROR;
}
b->memory = 1;
b->pos = ngx_http_msie_padding;
b->last = ngx_http_msie_padding + sizeof(ngx_http_msie_padding) - 1;
out[1].next = &out[2];
out[2].buf = b;
out[2].next = NULL;
}
if (r == r->main) {
b->last_buf = 1;
}
b->last_in_chain = 1;
// ngx_http_ouput_filter能夠把響應發送出去，這個函數很簡單，再也不分析
return ngx_http_output_filter(r, &out[0]);
}
複製代碼
相關文章
- 1. nginx error_page
- 2. nginx下error_page 和 proxy_intercept_errors 設置
- 3. nginx優化-錯誤頁面的優雅顯示error_page
- 4. Nginx配置error_page 404 500等自定義的錯誤頁面
- 5. css3 calc()的用法 css3 calc()的用法
- 6. mysqli_query 的用法和my_sqliconnect的用法
- 7. display:table的用法
- 8. stylus的用法
- 9. powersploit的用法
- 10. iScroll.js的用法
- 更多相關文章...
- • Redis哨兵（Sentinel）模式的配置方法及其在Java中的用法 - Redis教程
- • Spring中Bean的作用域 - Spring教程
- • C# 中 foreach 遍歷的用法
- • 適用於PHP初學者的學習線路和建議
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
歡迎關注本站公眾號,獲取更多信息
