快捷導(dǎo)航

Nginx?error_page自定義錯(cuò)誤頁(yè)面設(shè)置過(guò)程

更新時(shí)間：2023年08月10日 13:45:36 作者：jc0803kevin

這篇文章主要介紹了Nginx?error_page自定義錯(cuò)誤頁(yè)面設(shè)置過(guò)程，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

Nginx error_page自定義錯(cuò)誤頁(yè)面設(shè)置

#fastcgi_intercept_errors on;
    #語(yǔ)法：fastcgi_intercept_errors on|off 
    #默認(rèn)值：fastcgi_intercept_errors off 
    #使用字段：http, server, location 
    #這個(gè)指令指定是否傳遞4xx和5xx錯(cuò)誤信息到客戶(hù)端，或者允許nginx使用error_page處理錯(cuò)誤信息。
    #你必須明確的在error_page中指定處理方法使這個(gè)參數(shù)有效，正如Igor所說(shuō)“如果沒(méi)有適當(dāng)?shù)奶幚矸椒ǎ?
    #nginx不會(huì)攔截一個(gè)錯(cuò)誤，這個(gè)錯(cuò)誤不會(huì)顯示自己的默認(rèn)頁(yè)面，這里允許通過(guò)某些方法攔截錯(cuò)誤。


    #proxy_intercept_errors 為on 表示 nginx按照原response
    #proxy_intercept_errors on|off 
    #proxy_intercept_errors off 
    #使用字段：http, server, location    #code輸出，后端是404，就是404.這個(gè)變量開(kāi)啟后，我們才能自定義錯(cuò)誤頁(yè)面。


    proxy_intercept_errors on;

    upstream dev1 {

        server 127.0.0.1:8080;          #HessianTest3

    }

    server {
        listen       80;
        server_name  kevin.com;



        location / {
            proxy_pass http://dev1;     #HessianTest3
        }

        #參考書(shū)本第40頁(yè)
        #error_page 404 =200 /404.html;
        #error_page 500 502 503 504  =200 /50x.html;

        #location = /404.html {
        #   root html;
        #   
        #}

        #location = /50x.html {
        #    root   html;
        #}

        #當(dāng)頁(yè)面發(fā)生異常的時(shí)候可以指定跳轉(zhuǎn)到location中，也可以指定跳轉(zhuǎn)到指定的URL地址上面
        error_page 404 http://www.baidu.com/;
    }

Nginx error_page 使用

接觸到了error_page ，這里記錄一下

1. error_page語(yǔ)法

語(yǔ)法：

error_page code [ code... ] [ = | =answer-code ] uri | @named_location

默認(rèn)值：

no?

使用字段：

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

2. 實(shí)例

nginx指令error_page的作用是當(dāng)發(fā)生錯(cuò)誤的時(shí)候能夠顯示一個(gè)預(yù)定義的uri，比如：

error_page 502 503 /50x.html;
location = /50x.html {
? ? root /usr/share/nginx/html;
} ?

這樣實(shí)際上產(chǎn)生了一個(gè)內(nèi)部跳轉(zhuǎn)(internal redirect)，當(dāng)訪(fǎng)問(wèn)出現(xiàn)502、503的時(shí)候就能返回50x.html中的內(nèi)容，這里需要注意是否可以找到50x.html頁(yè)面，所以加了個(gè)location保證找到你自定義的50x頁(yè)面。

同時(shí)我們也可以自己定義這種情況下的返回狀態(tài)嗎，比如：

error_page 502 503 =200 /50x.html;
location = /50x.html {
? ? root /usr/share/nginx/html;
} ??

這樣用戶(hù)訪(fǎng)問(wèn)產(chǎn)生502 、503的時(shí)候給用戶(hù)的返回狀態(tài)是200，內(nèi)容是50x.html。

當(dāng)error_page后面跟的不是一個(gè)靜態(tài)的內(nèi)容的話(huà)，比如是由proxyed server或者FastCGI/uwsgi/SCGI server處理的話(huà)，server返回的狀態(tài)(200, 302, 401 或者 404）也能返回給用戶(hù)。

error_page 404 = /404.php;
location ~ \.php$ {
? ? fastcgi_pass 127.0.0.1:9000;
? ? fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
? ? include fastcgi_params;
} ??

也可以設(shè)置一個(gè)named location，然后在里邊做對(duì)應(yīng)的處理。

error_page 500 502 503 504 @jump_to_error;
location @jump_to_error { ? ?
? ? proxy_pass http://backend;
}

同時(shí)也能夠通過(guò)使客戶(hù)端進(jìn)行302、301等重定向的方式處理錯(cuò)誤頁(yè)面，默認(rèn)狀態(tài)碼為302。

error_page 403 ? ? ?http://example.com/forbidden.html;
error_page 404 =301 http://example.com/notfound.html;

同時(shí)error_page在一次請(qǐng)求中只能響應(yīng)一次，對(duì)應(yīng)的nginx有另外一個(gè)配置可以控制這個(gè)選項(xiàng)：recursive_error_pages

默認(rèn)為false，作用是控制error_page能否在一次請(qǐng)求中觸發(fā)多次。

3. Nginx 自定義404錯(cuò)誤頁(yè)面配置中有無(wú)等號(hào)的區(qū)別

error_page 404 /404.html 可顯示自定義404頁(yè)面內(nèi)容，正常返回404狀態(tài)碼。
error_page 404 = /404.html 可顯示自定義404頁(yè)面內(nèi)容，但返回200狀態(tài)碼。
error_page 404 /404.php 如果是動(dòng)態(tài)404錯(cuò)誤頁(yè)面，包含 header 代碼（例如301跳轉(zhuǎn)），將無(wú)法正常執(zhí)行。正常返回404代碼。
error_page 404 = /404.php 如果是動(dòng)態(tài)404錯(cuò)誤頁(yè)面，包含 header 代碼（例如301跳轉(zhuǎn)），加等號(hào)配置可以正常執(zhí)行，返回php中定義的狀態(tài)碼。但如果php中定義返回404狀態(tài)碼，404狀態(tài)碼可以正常返回，但無(wú)法顯示自定義頁(yè)面內(nèi)容（出現(xiàn)系統(tǒng)默認(rèn)404頁(yè)面），這種情況可以考慮用410代碼替代（ header("HTTP/1.1 410 Gone"); 正常返回410狀態(tài)碼，且可正常顯示自定義內(nèi)容）。

例子

server ?{
? ? listen 80;
? ? server_name ?test.com;
? ? index ? ? ? index.html index.htm;
?
? ? location / {?
? ? ? ? proxy_pass http://online;
? ? ? ? error_page 404 = @fallback;
? ? ? ? proxy_intercept_errors on;
? ? }
? ? location @fallback {
? ? ? ? proxy_pass http://backend;
? ? }
}
?
upstream online {
? ? ? ? ?server 192.168.88.18:80;
? ? ? ? ?server 192.168.88.28:80;
}
?
upstream backend {
? ? ? ? ?server 192.168.88.38:80;
}

例子

由于在nginx配置中，設(shè)置了limit_req的流量限制，導(dǎo)致許多請(qǐng)求返回503錯(cuò)誤代碼，在限流的條件下，為提高用戶(hù)體驗(yàn)，希望返回正常Code 200，且返回操作頻繁的信息：

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": "操作太頻繁了，請(qǐng)坐下來(lái)喝杯茶。"}';
? ?if ( $arg_callback != "" )?
? ?{?
? ? ? ?return 200 'try{$arg_callback($ret_body)}catch(e){}';?
? ?}?
? ?return 200 $ret_body;?
}