Nginx之error_page模块解读

2023-09-24 08:51:35 浏览数 (1)


error_page的概念

error_page是nginx一个重要的指令,作用是定制化服务器错误页面。当nginx发生内部错误时,比如说404、403、500等错误,默认会跳转到nginx自带的错误页面。但是使用error_page指令可以修改默认错误页面,并且可以指定跳转的url或者文件路径。

语法:

代码语言:javascript复制
error_page code [ code... ] [ = | =answer-code ] uri | @named_location 

默认值:

代码语言:javascript复制
no 

使用字段:http, server, location, location 中的if字段

使用举例

跳转到指定页面

其原理是响应到错误代码后,导向指定的路由,然后再由指定的路由处理,如下当错误代码是404时,相当于访问http://localhost:80/50x.html,正好被内部传送给 location = /50x.html让其来进行处理(需要注意必须有50x.html这个页面)

代码语言:javascript复制
        error_page 404 403 500 /50x.html;
        location = /50x.html {
                root /usr/share/nginx/html;
        }

跳转到指定网址

其原理是响应到错误代码后,302(临时重定向到目标网址),如下当错误代码为404时,导向https://www.csdn.net

代码语言:javascript复制
       error_page 404 403 500 https://www.csdn.net;

使用location的@符合完成错误信息展示

代码语言:javascript复制
server{
	error_page 404 @jump_to_error;
	location @jump_to_error {
		default_type text/plain;
		return 404 'Not Found Page...';
	}
}

​更改反馈状态码

本来遇到404找不到文件的错误,但是nginx可以把它状态码改为200返回给用户(例子如下) ​

代码语言:javascript复制
        error_page 404 =200 /50x.html;#注意这里的缩进不是随便的
        location = /50x.html {
                root /usr/share/nginx/html;
        }

error_page配置小提示

注意 error_page 配置时加 = 和不加 = 的区别,加了 = 表示响应为指定的 http status code ,默认为 200,不加 = 为原错误的状态码~

代码语言:javascript复制
# 这样可以访问错误页面时 http status 为 404 ,并且页面内容是 404.html 的内容
error_page 404 /404.html
error_page 404 500 /404.html;

# 这样配置访问错误页面时 http status 为 200 ,但页面内容是 404.html 的内容
error_page 404 500 = /404.html;

# 这样配置访问错误页面时 http status 为 404 ,但页面内容是 404.html 的内容
error_page 404 500 =404 /404.html;

# 也可以把404请求直接301到某个域上
error_page 404 =301 https://xuexb.com/404;

这样就可以根据自己需求配置错误页为指定的状态码,因为非 200 的状态码可能会被浏览器拦截。

  • error_page 404 /404.html 可显示自定义404页面内容,正常返回404状态码。
  • error_page 404 = /404.html 可显示自定义404页面内容,但返回默认200状态码。
  • error_page 404 /404.php 如果是动态404错误页面,包含 header 代码(例如301跳转),将无法正常执行。正常返回404代码。
  • error_page 404 = /404.php 如果是动态404错误页面,包含 header 代码(例如301跳转),加等号配置可以正常执行,返回php中定义的状态码。但如果php中定义返回404状态码,404状态码可以正常返回,但无法显示自定义页面内容(出现系统默认404页面),这种情况可以考虑用410代码替代( header("HTTP/1.1 410 Gone"); 正常返回410状态码,且可正常显示自定义内容)。

实战应用解读

限流应用

由于在nginx配置中,设置了limit_req的流量限制,导致许多请求返回503错误代码,在限流的条件下,为提高用户体验,希望返回正常Code 200,且返回操作频繁的信息:

代码语言:javascript复制
location  /test {
  ... 
  limit_req zone=zone_ip_rm burst=1 nodelay; 
  error_page 503 =200 /dealwith_503?callback=$arg_callback;
}
location /dealwith_503{ 
  set $ret_body '{"code": "V00006","msg": "操作太频繁了,请坐下来喝杯茶。"}';
   if ( $arg_callback != "" ) 
   { 
       return 200 'try{$arg_callback($ret_body)}catch(e){}'; 
   } 
   return 200 $ret_body; 
}

寻找错误码对应的文件

error_page后面跟的/error/404.html就相当于其访http://localhost:80/error/404.html其被location /error捕获

代码语言:javascript复制
        error_page 404 /error/404.html;
        error_page 403 /error/403.html;
        location /error {
                alias /var/www/html;
        }

​​​​​​我正在参与2023腾讯技术创作特训营第二期有奖征文,瓜分万元奖池和键盘手表

0 人点赞