快捷導(dǎo)航

在ASP.NET Core中顯示自定義的錯(cuò)誤頁面

更新時(shí)間：2016年12月09日 11:37:24 作者：dudu

大家在用瀏覽器訪問服務(wù)器時(shí)，不同情況下會(huì)返回不同的信息。服務(wù)器發(fā)生錯(cuò)誤就會(huì)返回錯(cuò)誤信息，我們最熟悉的就是404錯(cuò)誤頁面，但是這里我想和大家分享下在ASP.NET Core中如何顯示自定義的500或404錯(cuò)誤頁面，有需要的朋友們可以參考借鑒，下面來一起看看吧。

前言

相信每位程序員們應(yīng)該都知道在 ASP.NET Core 中，默認(rèn)情況下當(dāng)發(fā)生500或404錯(cuò)誤時(shí)，只返回http狀態(tài)碼，不返回任何內(nèi)容，頁面一片空白。

如果在 Startup.cs 的 Configure() 中加上 app.UseStatusCodePages(); ，500錯(cuò)誤時(shí)依然是一片空白（不知為何對(duì)500錯(cuò)誤不起作用），404錯(cuò)誤時(shí)有所改觀，頁面會(huì)顯示下面的文字：

Status Code: 404; Not Found

如果我們想實(shí)現(xiàn)不管500還是404錯(cuò)誤都顯示自己定制的友好錯(cuò)誤頁面，那該怎么辦呢？

對(duì)于500錯(cuò)誤，我們可以用 app.UseExceptionHandler() 進(jìn)行截獲；

對(duì)于404錯(cuò)誤，我們可以用 app.UseStatusCodePages() 的增強(qiáng)版 app.UseStatusCodePagesWithReExecute() 進(jìn)行截獲；

然后轉(zhuǎn)交給相應(yīng)的URL進(jìn)行處理。

app.UseExceptionHandler("/errors/500");
app.UseStatusCodePagesWithReExecute("/errors/{0}");

URL 路由到 MVC Controller 中顯示友好錯(cuò)誤頁面。

public class ErrorsController : Controller
{
 [Route("errors/{statusCode}")]
 public IActionResult CustomError(int statusCode)
 {
  if(statusCode == 404)
  {
   return View("~/Views/Errors/404.cshtml");
  }
  return View("~/Views/Errors/500.cshtml");
 }  
}

【更新】

后來發(fā)現(xiàn)一個(gè)問題，當(dāng)出現(xiàn)底層異常時(shí)，自定義錯(cuò)誤頁面不能顯示，還是一片空白，比如下面的異常：

System.DllNotFoundException: Unable to load DLL 'System.Security.Cryptography.Native.Apple': The specified module could not be found.
 (Exception from HRESULT: 0x8007007E)

這時(shí)想到用 MVC 顯示自定義錯(cuò)誤頁面的局限，如果發(fā)生的異常導(dǎo)致 MVC 本身不能正常工作，自定義錯(cuò)誤頁面就無法顯示。

于是針對(duì)這個(gè)問題進(jìn)行了改進(jìn)，針對(duì)500錯(cuò)誤直接用靜態(tài)文件的方式進(jìn)行響應(yīng)，Startup.cs 的 Configure() 中的代碼如下：

app.UseExceptionHandler(errorApp =>
{
 errorApp.Run(async context =>
 {
  context.Response.StatusCode = 500;
  if (context.Request.Headers["X-Requested-With"] != "XMLHttpRequest")
  {
   context.Response.ContentType = "text/html";
   await context.Response.SendFileAsync($@"{env.WebRootPath}/errors/500.html");
  }
 });
});
app.UseStatusCodePagesWithReExecute("/errors/{0}");

為了重用自定義錯(cuò)誤頁面，MVC Controller 中已進(jìn)行了修改：

public class ErrorsController : Controller
{
 private IHostingEnvironment _env;

 public ErrorsController(IHostingEnvironment env)
 {
  _env = env;
 }

 [Route("errors/{statusCode}")]
 public IActionResult CustomError(int statusCode)
 {
  var filePath = $"{_env.WebRootPath}/errors/{(statusCode == 404?404:500)}.html";
  return new PhysicalFileResult(filePath, new MediaTypeHeaderValue("text/html"));
 }  
}

總結(jié)

以上就是關(guān)于ASP.NET Core中顯示自定義錯(cuò)誤頁面的全部內(nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來一定的幫助，如果有疑問大家可以留言交流。

您可能感興趣的文章: