Nginx error_page自定义错误页面设置过程

╰半橙微兮° 2024-03-22 21:28 40阅读 0赞

![0bc386ce3940bb91b162909fc090e030.jpeg][]

本文主要介绍了Nginx error\_page自定义错误页面设置过程，具有很好的参考价值，希望对大家有所帮助。

### Nginx error\_page自定义错误页面设置 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 </td> 
 <td> <code>#fastcgi_intercept_errors on;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#语法：fastcgi_intercept_errors on|off </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#默认值：fastcgi_intercept_errors off </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#使用字段：http, server, location </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#这个指令指定是否传递4xx和5xx错误信息到客户端，或者允许nginx使用error_page处理错误信息。</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#你必须明确的在error_page中指定处理方法使这个参数有效，正如Igor所说“如果没有适当的处理方法，</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#nginx不会拦截一个错误，这个错误不会显示自己的默认页面，这里允许通过某些方法拦截错误。</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#proxy_intercept_errors 为on 表示 nginx按照原response</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#proxy_intercept_errors on|off </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#proxy_intercept_errors off </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#使用字段：http, server, location&nbsp;&nbsp;&nbsp; #code输出，后端是404，就是404.这个变量开启后，我们才能自定义错误页面。</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>proxy_intercept_errors on;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>upstream dev1 { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>server 127.0.0.1:8080;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </code><code>#HessianTest3</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>server { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>listen&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 80;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>server_name&nbsp; kevin.com;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>location / { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>proxy_pass http:</code><code>//dev1</code><code>;&nbsp;&nbsp;&nbsp;&nbsp; </code><code>#HessianTest3</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#参考书本第40页</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#error_page 404 =200 /404.html;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#error_page 500 502 503 504&nbsp; =200 /50x.html;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#location = /404.html { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#&nbsp;&nbsp; root html;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#&nbsp;&nbsp; </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#location = /50x.html { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#&nbsp;&nbsp;&nbsp; root&nbsp;&nbsp; html;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#当页面发生异常的时候可以指定跳转到location中，也可以指定跳转到指定的URL地址上面</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>error_page 404 http:</code><code>//www</code><code>.baidu.com/;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### Nginx error\_page 使用 ###

接触到了error\_page ，这里记录一下

#### 1. error\_page语法 ####

语法：

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>error_page code [ code... ] [ = | =answer-code ] uri | @named_location</code> </td> 
 </tr> 
 </tbody> 
</table>

默认值：

使用字段：

http, server, location, location 中的if字段

#### 2. 实例 ####

nginx指令error\_page的作用是当发生错误的时候能够显示一个预定义的uri，比如：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>error_page 502 503 </code><code>/50x</code><code>.html;</code> <code>location = </code><code>/50x</code><code>.html { </code> <code>&nbsp;&nbsp;&nbsp; </code><code>root </code><code>/usr/share/nginx/html</code><code>;</code> <code>} &nbsp;</code> </td> 
 </tr> 
 </tbody> 
</table>

这样实际上产生了一个内部跳转(internal redirect)，当访问出现502、503的时候就能返回50x.html中的内容，这里需要注意是否可以找到50x.html页面，所以加了个location保证找到你自定义的50x页面。

同时我们也可以自己定义这种情况下的返回状态吗，比如：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>error_page 502 503 =200 </code><code>/50x</code><code>.html;</code> <code>location = </code><code>/50x</code><code>.html { </code> <code>&nbsp;&nbsp;&nbsp; </code><code>root </code><code>/usr/share/nginx/html</code><code>;</code> <code>} &nbsp;&nbsp;</code> </td> 
 </tr> 
 </tbody> 
</table>

这样用户访问产生502 、503的时候给用户的返回状态是200，内容是50x.html。

当error\_page后面跟的不是一个静态的内容的话，比如是由proxyed server或者FastCGI/uwsgi/SCGI server处理的话，server返回的状态(200, 302, 401 或者 404）也能返回给用户。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>error_page 404 = </code><code>/404</code><code>.php;</code> <code>location ~ \.php$ { </code> <code>&nbsp;&nbsp;&nbsp; </code><code>fastcgi_pass 127.0.0.1:9000;</code> <code>&nbsp;&nbsp;&nbsp; </code><code>fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;</code> <code>&nbsp;&nbsp;&nbsp; </code><code>include fastcgi_params;</code> <code>} &nbsp;&nbsp;</code> </td> 
 </tr> 
 </tbody> 
</table>

也可以设置一个named location，然后在里边做对应的处理。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>error_page 500 502 503 504 @jump_to_error;</code> <code>location @jump_to_error { &nbsp; &nbsp;</code> <code>&nbsp;&nbsp;&nbsp; </code><code>proxy_pass http:</code><code>//backend</code><code>;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

同时也能够通过使客户端进行302、301等重定向的方式处理错误页面，默认状态码为302。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>error_page 403 &nbsp; &nbsp; &nbsp;http:</code><code>//example</code><code>.com</code><code>/forbidden</code><code>.html;</code> <code>error_page 404 =301 http:</code><code>//example</code><code>.com</code><code>/notfound</code><code>.html;</code> </td> 
 </tr> 
 </tbody> 
</table>

同时error\_page在一次请求中只能响应一次，对应的nginx有另外一个配置可以控制这个选项：recursive\_error\_pages

默认为false，作用是控制error\_page能否在一次请求中触发多次。

#### 3. Nginx 自定义404错误页面配置中有无等号的区别 ####

*  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，且返回操作频繁的信息：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>location &nbsp;</code><code>/test</code> <code>{ </code> <code>&nbsp;&nbsp;</code><code>...&nbsp;</code> <code>&nbsp;&nbsp;</code><code>limit_req zone=zone_ip_rm burst=1 nodelay;&nbsp;</code> <code>&nbsp;&nbsp;</code><code>error_page 503 =200 </code><code>/dealwith_503</code><code>?callback=$arg_callback;</code> <code>}</code> <code>location </code><code>/dealwith_503</code><code>{&nbsp;</code> <code>&nbsp;&nbsp;</code><code>set</code> <code>$ret_body </code><code>'{"code": "V00006","msg": "操作太频繁了，请坐下来喝杯茶。"}'</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>( $arg_callback != </code><code>""</code> <code>)&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;</code><code>{&nbsp;</code> <code>&nbsp;&nbsp;&nbsp; &nbsp; &nbsp;</code><code>return</code> <code>200 </code><code>'try{$arg_callback($ret_body)}catch(e){}'</code><code>;&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>200 $ret_body;&nbsp;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### 总结 ###

以上为个人经验，希望能给大家一个参考，也希望可以帮到你。

来源：[微点阅读][Link 1] [https://www.weidianyuedu.com][Link 1]

[0bc386ce3940bb91b162909fc090e030.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/7846cdba047d407385822af74619d296.png
[Link 1]: https://www.weidianyuedu.com