在MVC的Model中,我們可以定義很多與視圖相關的中繼資料,這些中繼資料對我們開發視圖起著相當重要的作用,特別是在資料驗證方面。這些中繼資料一般情況下我們是不會定義在業務實體(或持久化實體)上面,所以很多情況下,我們會需要開發兩種實體:View Model和Business Model。這樣就造成,在Action與View的溝通當中,我們需要使用View Model,然後在商務邏輯處理時,我們需要再將View Model映射到Business Model,這將會使我們的開發架構變得繁瑣。因為一般情況下,View Model和Business Model在很多情況下,都是很雷同的對象,只是View Model會有很多與視圖相關的中繼資料。在這種情況下,只要我們能把View Model作為Business Model的中繼資料描述對象(MetadataType)來使用,而不直接參与Action與View的溝通,讓這些工作都由Business Model來承擔,這樣就可以有效避免很多重複工作。
在System.ComponentModel.DataAnnotations內部,提供了MetadataTypeAttribute這個標籤,讓我們可以為Business Model指定它對應的視圖中繼資料類型。特別是當我們使用LINQ2SQL、EF等架構來產生Entity Framework時,我們可以以partial類的形式來提供它對應的視圖中繼資料類型:
[MetadataType(typeof(Product_Metadata))]public partial class Product{}public class Product_Metadata{}
這樣做在大多數情況下是沒有問題的。但是僅僅是這樣,還不能解決所有問題。一般情況下Business Model和MetadataType是不在同一個Assembly裡面,這時候你就無法以partial類的形式來擴充Business Model。所以我們就需要有一套機制來延遲註冊Business Model與MetadataType的映射關係。通過MVC源碼的分析,我們可以通過擴充DataAnnotationsModelMetadataProvider的
GetTypeDescriptor方法來解決這個問題。
首先,我們先定義一個Business Model與MetadataType的映射容器:
public static class TypeDescriptorHelper{ static Hashtable hashtable = new Hashtable(); static ReaderWriterLockSlim locker = new ReaderWriterLockSlim(); static TypeDescriptorHelper() { } public static void RegisterMetadataType(Type type, Type metadataType) { locker.EnterWriteLock(); hashtable[type] = metadataType; locker.ExitWriteLock(); } public static ICustomTypeDescriptor Get(Type type) { locker.EnterReadLock(); var metadataType = hashtable[type] as Type; ICustomTypeDescriptor descriptor = null; if (metadataType != null) { descriptor = new AssociatedMetadataTypeTypeDescriptionProvider(type, metadataType).GetTypeDescriptor(type); } locker.ExitReadLock(); return descriptor; }}
這個容器非常簡單,我們只是定義了一個hashtable來儲存它們的映射關係。然後,我們從DataAnnotationsModelMetadataProvider繼承一個新的類,重寫GetTypeDescriptor方法:
public class CustomDataAnnotationsModelMetadataProvider : DataAnnotationsModelMetadataProvider{ protected override System.ComponentModel.ICustomTypeDescriptor GetTypeDescriptor(Type type) { var descriptor = TypeDescriptorHelper.Get(type); if (descriptor == null) { descriptor = base.GetTypeDescriptor(type); } return descriptor; }}
接下來要做的事情就是把CustomDataAnnotationsModelMetadataProvider註冊到系統中,用它來代替原來的DataAnnotationsModelMetadataProvider,在Global.asax添加如下代碼:
ModelMetadataProviders.Current = new CustomDataAnnotationsModelMetadataProvider();
最後需要在映射容器中,添加你希望的映射關係:
TypeDescriptorHelper.RegisterMetadataType(typeof(Product), typeof(Product_Metadata));
通過這樣的映射,我們就可以完全解放Business Model對MetadataType的依賴了。
後記: 在調試這個擴充的過程當中,出現了一個相當低級的錯誤,花了我幾個小時的時間。話說提交的資料中有一個名為site的字串(在Route.Values裡面),同時我在Action的參數中,定義的是一個名為site的複雜類型。程式在運行過程中,始終提示異常:類型無法轉換。因為我懷疑是我擴充了MetadataType引發的問題,所以拚命的在那邊調試,始終沒有找到原因。最後還原所有的代碼,問題依舊,才讓我走到正確的方向上,冤枉死我了。
補充:擴充DataAnnotationsModelMetadataProvider,只能獲得DataAnnotations中與UI相關的中繼資料。要獲得與Validation相關的中繼資料,還需要擴充DataAnnotationsModelValidatorProvider,擴充方式一樣,都是重寫GetTypeDescriptor方法。