ASP.NET MVC 模型繫結的 6 個建議

原文名稱：6 Tips for ASP.NET MVC Model Binding

原文地址：http://odetocode.com/Blogs/scott/archive/2009/04/27/6-tips-for-asp-net-mvc-model-binding.aspx

ASP.NET MVC 中的 Model Binding 使用起來非常簡單。你的 Action 方法需要資料，在傳入的 HTTP 要求中攜帶著你需要的資料，資料可以在請求的表單資料中，還可能在你的 URL 地址本身中。通過 DefaultModelBinder，可以神奇地將表單中的資料和路由中的資料轉換到對象中。Model Binder 使得你的控制器代碼可以乾淨地從請求以及關聯的環境中分離出來。

這裡有一些關於在 MVC 項目中更好使用 Model Binding 的建議。

Tip#1:最好使用 Model Binding 而不是 Request.Form

如果你的 Action 像下面這樣：

[AcceptVerbs(HttpVerbs.Post)]public ActionResult Create(){    Recipe recipe = new Recipe();    recipe.Name = Request.Form["Name"];        // ...        return View();}

就不對了。這些屬性使得你的 Action 很難讀而且更難以測試，Model Binder 可以幫你從 Request 和 HttpContext 中擺脫出來。比如，你可以使用 FormCollection 類型的參數來代替上面的代碼：

public ActionResult Create(FormCollection values){    Recipe recipe = new Recipe();    recipe.Name = values["Name"];                      // ...                return View();}

使用 FormCollection 你可以不必再深入到 Request 對象，這樣，有時候你就可以使用低層次的控制了。但是，如果你的資料來自 Request.Form，或者 URL 請求參數，你可以通過 Model Binding 來完成它的魔術。

[AcceptVerbs(HttpVerbs.Post)]public ActionResult Create(Recipe newRecipe){                // ...        return View();}

在這個例子中，Model Binder 將會幫你建立 newRecipe 對象，並且使用從 Request 中獲得獲得的資料來填充它，真的是魔術。有許多的途徑允許你定製綁定的處理過程，使用白名單，黑名單，首碼，以及介面，更多的控制還允許你通過 UpdateModel 和 TryUpdateModel 方法進行，只是要注意無意的綁定。看一看 Justin Etheredge 的文章  Think Before You Bind.

Tip#2 定製 Model Binder

在 MVC 中，Model Binding 也是一個擴充點。如果預設的綁定不合適的話，你可以提供一個自訂的 Model Binder，實現自訂的 Model Binder 你需要實現介面 IModelBinder，這是僅有的一個方法，有多難嗎？

public interface IModelBinder{    object BindModel(ControllerContext controllerContext,

                      ModelBindingContext bindingContext);}

一旦你進入Model Binding，實際上，你將會發現這個簡單的 IModelBinder 介面並沒有完全描述在架構中的預設契約和負作用。如果你退回一步看一看，就會發現 Model Binder, ModelState 以及 HtmlHelper。

Scott Hanselman 在他的  “Splitting DateTime – Unit Testing ASP.NET MVC Custom Model Binders” 中給出了一個並不是示範版的 Model Binder，一個我需要提出來的細節是 Scott 的 DateTime 分離器仍然沒有通過 Request.Form 來綁定，在 GetA<T> 方法中，你將會看到 Scott 使用了內容物件的 ValueProvider 屬性來獲得資料，ValueProvier 表示混合了表單資料，路由資料，以及請求參數資料的資料。Scott 的例子非常棒，但是，少了一個細節：綁定中的錯誤。
如果預設的模型繫結器在將資料繫結到你的對象上時出現了問題，它會將錯誤資訊和錯誤的資料壓入到 ModelState 中，你可以檢查 ModelState.IsValid 來檢查綁定中的問題，使用 ModelState.AddModelError 方法可以注入你自己的錯誤資訊。

如果你看看 Scott 文章的回應，你會看到  Sebastien Crocquesel’s  對這個問題的補丁。如果轉換失敗，Sebastien 的代碼將會使用 ModelState.AddModelError 方法來表示錯誤。Controller 和 View 都會使用 ModelState 來檢查綁定的問題。Controller 需要檢查 ModelState，以便在將資料儲存到資料庫之前檢查錯誤，而 View 需要通過 ModelState 來為使用者提供驗證的回應。需要注意的一點是 HtmlHelper ，你需要同時提供一個值,通過 ModelState.SetModelValue ，並且提供錯誤資訊，通過 AddModelError，否則你將會得到一個運行時的Null 參考異常，下面的代碼示範了這個問題。

[AcceptVerbs(HttpVerbs.Post)]public ActionResult Create(FormCollection Form){    // this is the wrong approach ...    if (Form["Name"].Trim().Length == 0)        ModelState.AddModelError("Name", "Name is required");    return View();}

上面的代碼建立了一個模型的錯誤資訊，但是沒有提供值。也有其他的問題，但是，如果你像下面一場呈現視圖，那麼，就會得到一個異常。

<%= Html.TextBox("Name", Model.Name) %>

縱然你為 Model.Name 提供了一個值，HtmlHelper 也會發現錯誤，然後顯示試圖的值。如果你沒有提供值，就會看到一個Null 參考異常。

Tip#3 通過繼承來自訂 Model Binding

如果你決定實現一個自訂的 Model Binder，你可能希望通過從 DefaultModelBinder 繼承來減少部分工作量，其實，最終你會發現不能通過繼承 DefaultModelBinder 來達到你的目的。例如，假如你希望通過自訂的 ModelBinder 來建立某些對象，DefaultModelBinder 將會使用 Activator.CreateInstance 和 Model 的預設建構函式來建立對象，如果你的模型沒有提供預設的建構函式，你可以重寫 CreateModel 方法來解決這個問題。

Jimmy 有一篇關於使用 DefaultModelBinder 的衍生類別的文章 “A Better Model Binder”.

Tip#4 使用註解來完成驗證

Brad Wilson 在他的文章  DataAnnotations and ASP.NET MVC  中，完美地示範了一切。
我建議你仔細讀一下 Brad Wilson 的文章，如果你想快一點，這裡總結了一下。
.NET 3.5 SP1 帶來了 System.ComponentModel.DataAnnotations 程式集，通過資料的註解和 DataAnnotationModelBinder，你可以處理大部分的伺服器端驗證問題，只需要簡單地標註你的模型

public class Recipe{    [Required(ErrorMessage="We need a name for this dish.")]    [RegularExpression("^Bacon")]     public string Name { get; set; }    // ...}

Tip#5 綁定和驗證是兩個步驟

綁定是從環境中獲得資料，然後賦予模型對象的過程，驗證是檢查模型對象的資料，確認符合我們的期望。這是完全不同的操作，但是模型繫結模糊了他們的區別。如果你希望在 Model Binder 中一起完成這兩步工作，是可以的，這需要準確地知道  DataAnnotationsModelBinder  做了什麼，你可以看這幾個例子。實際上，經常被忽略的一點是 DefaultModelBinder  如何分離綁定和驗證步驟。如果只是簡單屬性的驗證，所有你要做的就是重寫 DefaultModelBinder 的 OnProperValidating 方法。

下面的幾篇文章可以參考一下：

• Automatic Model Validation with ASP.NET MVC, xVal, Castle, and a Custom Binder
•  Enterprise Library Validation Application Block with MVC Binders

Tip#6 關於綁定的內容

前面我說過：Model Binder 可以幫你從 Request 和 HttpContext 中擺脫出來。從更加廣泛的角度來說，並沒有限制資料的來源，請求上下文中包含豐富的用戶端資訊。Scott Hanselman 的另外一篇文章示範了將使用者的標識綁定到模型上。

 綜上所述

Model Binding 是美妙的魔術，所以，儘可能使用內建的奇妙功能。