在前面的介紹中我們已經提到過表示Model元數據的ModelMetadata對象最終是通過一個名為ModelMetadataProvider的組件提供的,接下來我們著重討論基於ModelMetadataProvider的Model元數據提供機制及其擴展。
一、 ModelMetadataProvider
在ASP.NET MVC的Model元數據相關的應用編程接口中,用於創建Model元數據的ModelMetadataProvider接繼承自抽象類ModelMetadataProvider。如下面的代碼片斷所示,ModelMetadataProvide具有三個抽象方法。GetMetadataForProperties方法用於獲取表示針對指定容器對象和類型所有屬性的Model元數據集合,GetMetadataForProperty獲取針對指定容器對象和類型某個具體屬性對象的Model元數據,而GetMetadataForType則直接返回針對容器對象和類型的Model元數據。
1: public abstract class ModelMetadataProvider
2: {
3: public abstract IEnumerable<ModelMetadata> GetMetadataForProperties( object container, Type containerType);
4: public abstract ModelMetadata GetMetadataForProperty(Func<object> modelAccessor, Type containerType, string propertyName);
5: public abstract ModelMetadata GetMetadataForType(Func<object> modelAccessor, Type modelType);
6: }
注:在本文中提及的ModelMetadataProvider在大部分情況泛指直接或者間接繼承自抽象類ModelMetadataProvider,用於提供Model元數據的提供者對象或者類型,請讀者注意區分。
在ASP.NET MVC的元數據解析系統中使用的ModelMetadataProvider最終通過類型ModelMetadataProviders獲取。如下面的代碼片斷所示,ModelMetadataProviders具有一個ModelMetadataProvider類型的靜態可讀可寫屬性Current用於獲取和設置當前使用的ModelMetadataProvider。
1: public class ModelMetadataProviders
2: {
3: public static ModelMetadataProvider Current { get; set; }
4: }
二、DataAnnotationsModelMetadataProvider
通過前面的介紹我們知道Model元數據是通過定義在System.ComponentModel.DataAnnotations命名空間下的標注特性來定義的,Model元數據解析系統通過對應用在表示Model的數據類型及其屬性成員的標注特性進行解析從而對創建的Model元數據進行對應的初始化,而這個工作是通過DataAnnotationsModelMetadataProvider來實現的。
不過DataAnnotationsModelMetadataProvider並沒有直接繼承自ModelMetadataProvider,而是繼承自抽象類AssociatedMetadataProvider,後者是ModelMetadataProvider的子類。AssociatedMetadataProvider的主要作用是對應用在Model類型或屬性上所有“關聯”的特性,這也是它命名的由來。如下面的代碼片斷所示,AssociatedMetadataProvider實現了定義在ModelMetadataProvider的三個方法。
1: public abstract class AssociatedMetadataProvider : ModelMetadataProvider
2: {
3: protected abstract ModelMetadata CreateMetadata(IEnumerable<Attribute> attributes, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName);
4:
5: public override IEnumerable<ModelMetadata> GetMetadataForProperties(object container, Type containerType);
6: public override ModelMetadata GetMetadataForProperty(Func<object> modelAccessor, Type containerType, string propertyName);
7: public override ModelMetadata GetMetadataForType(Func<object> modelAccessor, Type modelType);
8: }
對於AssociatedMetadataProvider實現的三個方法,它並緊緊是通過反射將應用在Model類型和對應屬性上的所有特性,並將這個特性列表作為參數(attributes)傳入抽象方法CreateMetadata完成Model元數據的創建。值得一提的是,當通過調用CreateMetadata創建出ModelMetadata之後,會從特性列表中篩選出實現了IMetadataAware接口的特性,並將該ModelMetadata對象作為參數調用它們的OnMetadataCreated方法。
繼承自AssociatedMetadataProvider的DataAnnotationsModelMetadataProvider實現了抽象方法,它根據傳入的特性列表以及其他相關的信息(用於創建Model對象的委托、容器和Model類型以及屬性名稱)實現對Model元數據的最終創建。下面的代碼片斷就是整個DataAnnotationsModelMetadataProvider類型的定義。
1: public class DataAnnotationsModelMetadataProvider : AssociatedMetadataProvider
2: {
3: public DataAnnotationsModelMetadataProvider();
4: protected override ModelMetadata CreateMetadata(IEnumerable<Attribute> attributes, Type containerType,
5: Func<object> modelAccessor, Type modelType, string propertyName);
6: }
包含在Model元數據提供系統的ModelMetadataProvider、AssociatedMetadataProvider、DataAnnotationsModelMetadataProvider和ModelMetadataProviders與ModelMetadata之間的關系可以通過如下圖所示的UML來體現。
DataAnnotationsModelMetadataProvider最終實現了基於標注特性的Model元數據的解析,但是在默認情況下使用的ModelMetadataProvider類型卻不是DataAnnotationsModelMetadataProvider,而是CachedDataAnnotationsModelMetadataProvider,它對解析出來的元數據信息進行了相應的環村以提供性能,其實最終實現對Model元數據創建的還是DataAnnotationsModelMetadataProvider。