ASP.NET MVC自訂錯誤頁面

來源:互聯網
上載者:User
如果你在設定asp.net mvc自訂錯誤頁面時遇到問題,這並不止你一個人。驚訝之餘你的做法是正確的,沒有起到作用的原因是其一部分錯誤是由asp.net管道處理的,另一部分是由iis直接處理。

通常情況 (我期望是這種情況,在一些其他架構/伺服器上) 我們只需要在一個地方配置自訂錯誤頁就可以了,無論怎麼哪兒引發的錯誤。就像這樣︰

<customErrors mode="On">  <error code="404" path="404.html" />  <error code="500" path="500.html" /></customErrors>

自訂404錯誤頁面

當一個資源不存在時(包含靜態和動態),我們需要返回一個404狀態的頁面,通常我們需要提供一些稍微友好的資訊替代asp.net/iis產生的預設錯誤頁呈現給我們的網站訪問者,可能是提出一些忠告 為什麼該資源可能不存在或提供選擇要搜尋的網站。

這裡僅作示範簡單設定如下:

<!DOCTYPE html><html lang="en"><head>  <meta charset="utf-8"/>  <title>404 Page Not Found</title></head><body>  <h1>404 Page Not Found</h1></body></html>

我建立了一個新的ASP.NET MVC 5應用程式,包含vs內建的標準模版。如果我運行它嘗試導航到一個不存在的路徑 e.g. /foo/bar,就會得到一個包含如下資訊的標準 ASP.NET 404 頁面:、

不太友好不是?

這種情況的錯誤是由ASP.NET MVC引發因為它沒有找到與url相匹配的controller或action。

為了自訂404錯誤頁面,在web.config 的 <system.web></system.web>配置節:

<customErrors mode="On"> <error statusCode="404" redirect="~/404.html"/></customErrors>

mode="On" 這樣我們就能在本地看到錯誤頁面。一般你可能只想在投入使用時呈現而設定為 mode="RemoteOnly"。

現在如果我再次導航到/foo/bar 就能看到我剛剛定義的錯誤頁面.

然而正如我所料,此時的url路徑並不是 /foo/bar ASP.NET 將其重新導向為/404.html?aspxerrorpath=/foo/bar,而且我檢查響應的HTTP狀態代碼也為正常狀態的200。

這是非常糟糕的,返回http code 200不僅會引起誤解,也不利於SEO。簡單來講,如果指定路徑的資源不存在應該返回404如果是資源被移動應該重新導向到新路徑。

要修複這個問題我們可以更改ASP.NET預設行為 重新導向錯誤頁 為 重寫返回(rewrite the response)。

<customErrors mode="On" redirectMode="ResponseRewrite"> <error statusCode="404" redirect="~/404.html"/></customErrors>

然而這並沒有太大的作用(這老外真囉嗦).儘管原Url地址沒有被重新導向, ASP.NET 仍然返回的是 200,此外將我們自訂錯誤頁顯示為純文字。

似乎我們不得不返回一個ASP.NET頁面. 如果你之前以為不用再去 *.aspx頁面的話,那我恐怕讓你失望了。

因此將錯誤頁及相應的web.config改為404.aspx之後,url和content type(text/html)都正常了。

但200的問題依然存在. 這個問題微軟官方給出了相應的解決方案——設定頁面的狀態代碼. 我們在404.aspx加入如下部分:

<% Response.StatusCode = 404 %>

我們現在得到了正確的狀態代碼、url及自訂錯誤頁面,就這樣完事兒了嗎?

錯.

如果我們連結到一個靜態頁路徑(e.g. foo.html) 或一個不匹配我們路由配置的URL (e.g. /foo/bar/foo/bar),我們會看到到一個標準的IIS 404錯誤頁面.

上述情況繞過了ASP.NET由IIS處理了請求. 當然如果你在controller ation 中 return一個HttpNotFound()也會得到同樣的結果——這是因為MVC只是簡單的設定status code並沒有拋出錯誤,而是將它交給了IIS.

這種情況我們需要設定iis的錯誤頁面(僅IIS 7+有效).在 web.config <system.webServer></system.webServer>配置節中:

<httpErrors errorMode="Custom"> <remove statusCode="404"/> <error statusCode="404" path="/404.html" responseMode="ExecuteURL"/></httpErrors>

同樣設定 errorMode="Custom" 以便本地測試. 正常情況會設定為 errorMode="DetailedLocalOnly".

注意我使用了html頁面,而不是aspx。通常你應該用簡單的靜態檔案作為錯誤頁面,這樣即使ASP.NET出現錯誤時錯誤頁面依然能夠正常顯示。

現在如果我們導航到一個不存在的靜態檔案路徑就會得到一個自訂錯誤頁面而不是IIS預設的404 page,剩下的還是和之前一樣的200問題。

幸運的是 IIS 實際上提供了內建的解決方案來解決這一點,如果你設定 responseMode ="File"IIS 將返回您的自訂錯誤頁面,而不改變原始的響應標題︰
<error statusCode="404" path="404.html" responseMode="File"/>
搞定。

自訂500錯誤頁

大部分無外乎照搬上面的解決方案,添加一個自訂的500錯誤頁面。這裡有幾點值得注意的地方。

標準的 ASP.NET MVC模板內建的 HandleErrorAttribute 作為一個全域過濾器。捕獲在ASP.NET MVC管道引發的任何錯誤,並返回一個自訂"錯誤"視圖提供你有在web.config中啟用自訂錯誤。它會尋找 ~/views/{controllerName}/error.cshtml 或 ~ / views/shared/error.cshtml。

如果你使用了過濾器(filter),你需要更新現有的自訂錯誤視圖,並不存在的則需要建立(最好放在views/shared檔案夾下)

我沒有看見這個filter有可以設定的屬性值,在 MVC 管道引發的任何異常都會退回到標準的 ASP.NET 錯誤配置頁面,既然你要設定那些**那這裡就用不到這個filter。

添加如下自訂錯誤頁配置:

<customErrors mode="On" redirectMode="ResponseRewrite"> <error statusCode="404" redirect="~/404.aspx"/> <error statusCode="500" redirect="~/500.aspx"/></customErrors>

類似於前面建立的404.aspx:

<% Response.StatusCode = 500 %><!DOCTYPE html><html lang="en"><head>  <meta charset="utf-8" />  <title>500 Server Error</title></head><body>  <h1>500 Server Error</h1></body></html>

不幸的是這樣做並不會捕獲到你應用程式中的每一個異常。一個相當常見的錯誤——由 ASP.NET 產生的請求的驗證,如一個危險的url路徑/foo/bar<script></script> ,這個實際上會產生一個404響應;因此你可以添加一個預設錯誤配置:

<customErrors mode="Off" redirectMode="ResponseRewrite" defaultRedirect="~/500.aspx"> <error statusCode="404" redirect="~/404.aspx"/> <error statusCode="500" redirect="~/500.aspx"/></customErrors>

最後為了捕獲非ASP.NET異常我們設定IIS自訂伺服器內部錯誤500錯誤頁面:

<error statusCode="500" path="500.html" responseMode="File"/>

總結

在你的應用程式根目錄建立如下錯誤頁面:

404.html - for IIS
404.aspx - for ASP.NET
500.html - for IIS
500.aspx - for ASP.NET

確認您設定在 ASPX 頁面內的適當響應狀態代碼.

拋棄 MVC HandleErrorAttribute 全域篩選器;配置 ASP.NET 的自訂錯誤:

<customErrors mode="RemoteOnly" redirectMode="ResponseRewrite" defaultRedirect="~/500.aspx"> <error statusCode="404" redirect="~/404.aspx"/> <error statusCode="500" redirect="~/500.aspx"/></customErrors>

配置IIS自訂錯誤頁:

<httpErrors errorMode="DetailedLocalOnly"> <remove statusCode="404"/> <error statusCode="404" path="404.html" responseMode="File"/> <remove statusCode="500"/> <error statusCode="500" path="500.html" responseMode="File"/></httpErrors>

以上就是本文的全部內容,希望對大家的學習有所協助,也希望大家多多支援topic.alibabacloud.com。


相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.