【ASP.NET Core】處理異常（上篇）

依照老周的良好做風，開始以前先說點題外話。

前面的博文中，老周介紹過自定義 MVC 視圖的搜索路徑，即向 ViewLocationFormats 列表添加相應的內容，其實，對 Razor Page 模型，也能夠向 PageViewLocationFormats 列表添加相應的搜索路徑，好比 /MyPages/{1}/{0}.cshtml。其中，0 是視圖名，1 是頁面名稱。好比這樣。

            services.AddMvc().AddRazorOptions(opt =>
            {
                opt.ViewLocationFormats ...
 opt.PageViewLocationFormats ...
            });

然而，咱們知道，基於 Razor 的 Web Page 模型是以頁面爲單位的，也就是說路徑路由是直接指向頁面的（不包含.cshtml 擴展名），即不須要 MVC 模型的路由方式。因此，咱們並不須要修改 PageViewLocationFormats 中的內容。許多時候，咱們只要告訴應用程序在哪一個目錄下查找 Page 就好了。

默認的搜索位置是 /Pages 目錄，咱們能夠經過如下代碼來修改。

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().AddRazorPagesOptions(opt =>
            {
                opt.RootDirectory = "/UI";             });
        }

以上代碼寫在 Startup 類中，這個應該明白吧。RootDirectory 就是用來指定應用程序查找 Razor 頁面的根目錄路徑，此處我指寫了 /UI，因此，在個人項目中，我只要建一個 UI 目錄，而後各種 Razor 頁就往裏面放就好了。

 

 ========================================================================================

好了，題外話扯完了，開始說正題吧。今天我們聊聊有關異常處理的破事吧，也能夠說是錯誤處理，反正就這個意思，你理解就好，專業名詞沒必要較勁，只有那些吃飽了撐着的「學術人才」纔會跟名詞較勁。

老辦法，我們結合示例來說述，這樣各位觀衆不會乏味。

你們知道，娛樂產品腎Phone已經成爲流行玩具，近年來，購買腎Phone不必定只能用貨幣，比較典型的一種支付方式是賣腎買Phone。說實話，如今許多國產娛樂產品也很便宜，配置也不錯，幾百塊錢就能玩得刷刷響了，割腎真沒什麼必要。

爲了方便人們以腎換 Phone ，老周特地開發了一個在線賣腎系統。大體流程是這樣的，若是你有閒置的腎，能夠打開主頁，輸入你的一些信息，而後報個價，其餘用戶看見後，若是以爲合理，就認購此腎。

 

 爲了使操做流程更簡單，易上手，輕入門，該平臺只須要輸入姓名和腎的價格便可參加報價。

 

大體的頁面代碼以下。

        <form method="post">
            <div class="form-group">
                <label for="name">姓名：</label>
                <input type="text" class="form-control" name="name"/>
            </div>
            <div class="form-group">
                <label for="price">價格：</label>
                <input type="number" name="price" class="form-control"/>
            </div>
            <div class="form-group">
                <button type="submit" class="btn btn-success w-100">提  交</button>
            </div>
        </form>

Razor 頁面很像咱們之前玩過的 aspx 頁面，每一個頁面都配套一個隱藏代碼文件。Razor 頁也會配有一個頁面模型類，注意這個模型類要從 PageModel 派生，不是 Page 類，別搞錯了，Page 類只是做爲生成 HTML 代碼的基類，咱們的 .cshtml 文件在預編譯後，是隱式繼承自 RazorPage 類的。除非你要開發本身的標記語言，不然你沒必要理會這些類。

記住了，與 Razor 頁關聯的模型類是從 PageModel 類派生的，好比，本例中，當有人填寫了閒置腎的相關信息後，以 POST 方式提交，這是候，若是頁面模型類中包含了名字爲 OnPost、OnPostAsync ……的方法時，就會自動調用。若是想把咱們上面那個 form 中的 name 和 price 的值傳遞給方法，直接讓 OnPost 方法的參數與 form 中的元素名稱相同就能夠了。

    public class IndexModel : PageModel
    {
       public IActionResult OnPost(string name, decimal price)
        {
            if (string.IsNullOrWhiteSpace(name)) { throw new Exception("你怎麼不留下姓名啊，賣腎又不是丟人的事。"); } if(price <= 0.0M) { throw new Exception("靠！你的腎這麼不值錢嗎？還免費送，包郵不？"); } return RedirectToPage("/Success");
        }
    }

OnPost 不是 PageModel 基類的方法，而是咱們本身寫的，只是代碼約定，Asp.net Core 裏面用到不少代碼約定，它在運行的時候會查找這些特定的名字。

上面代碼中，還對傳遞進來的 form 值進行驗證，若是不符合要求，會拋出異常。

 

通常來講，在 Startup 類的 Configure 方法中，咱們會判斷一下，若是應用程序處於開發階段，爲了方便測試，應該加入這些代碼。

      if (env.IsDevelopment())
      {
           app.UseDeveloperExceptionPage();
      }

這樣，咱們在測試時能看到詳細的異常信息。

 

可是，在實際便用時，咱們不能公開這麼詳細的信息，這樣容易勾起人們的犯罪衝動。因此，通常會添加一個頁面，專門用來顯示錯誤信息。好比：

@page

<div class="card">
    <div class="card-header bg-danger">
        <span class="text-light">錯誤</span>
    </div>
    <div class="card-body">
        <span class="card-text">唉，真抱歉。你提交的腎不符合國際標準，沒人要的。</span>
    </div>
</div>

 

而後咱們要在 Startup.Configure 方法中配置一下。

  app.UseExceptionHandler("/Error");

加上這一行後，當發生異常時，就會跳轉到 /Error 頁面。

 

 不過，你也許會以爲，雖然不能公開異常信息，但一些必要的描述應該要的，否則，用戶不知道發生了啥事。咱們能夠經過 HttpContext 的 Features 集合獲取一個用來處理異常的 Feature，它的原型接口是 IExceptionHandlerFeature，咱們沒必要關心它的實現類型是誰，只要訪問它的 Error 屬性就能獲得關聯的 Exception 實例。

所以，咱們的錯誤頁能夠改一下。

@page
@using Microsoft.AspNetCore.Diagnostics
@{
 IExceptionHandlerFeature exf = HttpContext.Features.Get<IExceptionHandlerFeature>(); Exception ex = exf?.Error;
}

<div class="card">
    <div class="card-header bg-danger">
        <span class="text-light">錯誤</span>
    </div>
    <div class="card-body">
        @if (ex == null)
        {
            <span class="card-text">唉，真抱歉。你提交的腎不符合國際標準，沒人要的。</span>
        }
        else
        {
            <span class="card-text">@ex.Message</span>
        }
    </div>
</div>

經過如下代碼得到異常實例的引用。

    IExceptionHandlerFeature exf = HttpContext.Features.Get<IExceptionHandlerFeature>();
    Exception ex = exf?.Error;

這樣就能夠在頁面上顯示異常的描述信息了。

 

 

 可能你又想到了，我不想輸出個頁面，我只想返回一些簡單的文本，那麼，你在 Startup.Configure 中能夠這樣寫。

            app.UseExceptionHandler(x =>
            {
                x.Run(async context => { var ex = context.Features.Get<Microsoft.AspNetCore.Diagnostics.IExceptionHandlerFeature>()?.Error; string msg = ex == null ? "發生錯誤。" : ex.Message; context.Response.ContentType = "text/plain;charset=utf-8"; await context.Response.WriteAsync(msg); });             });

裏面的變量 x 就是當前的 IApplicationBuilder ，與傳遞給 Configure 方法的 app 參數類型同樣，這時候咱們能夠用 Reponse 的方法返回自定義的文本。

 

 好了，今天的內容就介紹到這兒吧，其實異常處理還有一種方法——使用 Filter，這個我們留到下一篇博文再和大夥分享。

本文示例源代碼下載