- 微信公众号：郑尔多斯
- 关注「郑尔多斯」公众号 ，回复「领取资源」，获取IT资源500G干货。
升职加薪、当上总经理、出任CEO、迎娶白富美、走上人生巅峰！想想还有点小激动- 关注可了解更多的
Nginx知识。任何问题或建议，请公众号留言;
关注公众号，有趣有内涵的文章第一时间送达！
1、从文档看一下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;
}
复制代码发送的函数：
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.
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]);
}
复制代码
扫一扫
900
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
