MVC之Model元数据

Contronoller激活之后，ASP.NET MVC会根据当前请求上下文得到目标Action的名称，然后解析出对应的方法并执行之。

在整个Action方法的执行过程中，Model元数据的解析是一个非常重要的环节。ASP.NET MVC中的Model实际上View Model，表示最终绑定到View上的数据，而Model元数据描述了Model的数据结构，以及Model的每个数据成员的一些特性。

正是有了Model元数据的存在，才使模板化HTML的呈现机制成为可能。此外，Model元数据支撑了ASP.NET MVC的Model验证体系，因为针对Model的验证规则正是定义在Model元数据中。ASP.NET MVC的Model元数据通过类型ModelMetadata表示。

ModelMetadata通过一系列的属性描述了Model及其成员相关的元数据信息，在正式介绍这些元数据选项之前，我们很有必要先来了解一下Model元数据层次化结构。[《How ASP.NET MVC Works?》中]

目录 
一、Model元数据层次化结构 
二、基本Model元数据信息 
三、Model元数据的定制 
    UIHintAttribute 
    HiddenInputAttribute与ScaffoldColumnAttribute 
    DataTypeAttribute与DisplayFormatAttribute 
    EditableAttribute与ReadOnlyAttribute 
    DisplayAttribute与DisplayNameAttribute 
    RequiredAttribute 
四、IMetadataAware接口 
    AllowHtmlAttribute 
    实例演示：创建实现IMetadataAware接口的特性定制Model元数据

一、Model元数据层次化结构

作为Model的数据类型可以是一个简单的字符串或者是一个值类型的对象，也可能是一个复杂的数据类型。对于一个复杂的数据类型，基于类型本身和数据成员的元数据都通过一个ModelMetadata来表示，而某个数据成员又可能是一个复杂类型，所以通过ModelMetadata对象表示的Model元数据实际上具有一个树形层次化结构。

举个例子，我们具有一个具有如下定义的表示联系人的数据类型Contact。属性Name、PhoneNo、EmailAddress和Address分别代表姓名、电话号码、邮箱地址和联系地址。联系地址通过另一个数据类型Address表示，属性Province、City、District和Street分别表示所在省份、城市、城区和街道。

   1: public class Contact

   2: {

   3:     public string Name { get; set; }

   4:     public string PhoneNo { get; set; }

   5:     public string EmailAddress { get; set; }

   6:     public Address Address { get; set; }

   7: }

   8: public class Address

   9: {

  10:     public string Province { get; set; }

  11:     public string City { get; set; }

  12:     public string District { get; set; }

  13:     public string Street { get; set; }

  14: }

如果将Contact类型作为Model，作为其元数据的ModelMetadata不仅仅具有Contact类型本身和其属性成员的描述，由于其Address属性是一个复杂类型，元数据还需要描述定义在该类型中的4个属性成员。下图反映基于Contact类型的Model元数据的层次化结构。

表示Model元数据的ModelMetadata类型不仅用于描述某个作为Model的数据类型，还用于递归地描述其所有属性成员（不包含字段成员），所以ModelMetadata具有一个树型层次化结构，这也可以从ModelMetadata的定义可以看出来。

   1: public class ModelMetadata

   2: {

   3:     //其他成员

   4:     public virtual IEnumerable<ModelMetadata> Properties { get; }

   5: }

如上面的代码片断所示，ModelMetadata具有一个类型为IEnumerable<ModelMetadata>的只读属性Properties，表示用于描述属性/字段成员的ModelMetadata集合。ModelMetadata的层次化结构可以通过如下图所示的UML来体现。由于基于类型的ModelMetadata和基于数据成员的ModelMetadata是一种包含关系，我们可以将前者称为后者的容器（Container）。

二、基本Model元数据信息

基于作为Model类型创建的元数据主要是为View实现模板化HTML呈现和数据验证服务的，我们可以通过在类型和数据成员上应用相应的特性控制Model在View中的呈现方式或者定义相应的验证规则。在介绍声明式Model元数据编程方式之前，我们先来介绍表示Model元数据的ModelMetadata类型中与UI呈现和数据验证无关的基本属性。

  1     // Summary:
  2     //     No content here will be updated; please do not add material here.
  3     public class ModelMetadata
  4     {
  5         // Summary:
  6         //     Initializes a new instance of the System.Web.Http.Metadata.ModelMetadata
  7         //     class.
  8         //
  9         // Parameters:
 10         //   provider:
 11         //     The provider.
 12         //
 13         //   containerType:
 14         //     The type of the container.
 15         //
 16         //   modelAccessor:
 17         //     The model accessor.
 18         //
 19         //   modelType:
 20         //     The type of the model.
 21         //
 22         //   propertyName:
 23         //     The name of the property.
 24         public ModelMetadata(ModelMetadataProvider provider, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName);
 25 
 26         // Summary:
 27         //     Gets a dictionary that contains additional metadata about the model.
 28         //
 29         // Returns:
 30         //     A dictionary that contains additional metadata about the model.
 31         public virtual Dictionary<string, object> AdditionalValues { get; }
 32         //
 33         // Summary:
 34         //     Gets or sets the type of the container for the model.
 35         //
 36         // Returns:
 37         //     The type of the container for the model.
 38         public Type ContainerType { get; }
 39         //
 40         // Summary:
 41         //     Gets or sets a value that indicates whether empty strings that are posted
 42         //     back in forms should be converted to null.
 43         //
 44         // Returns:
 45         //     true if empty strings that are posted back in forms should be converted to
 46         //     null; otherwise, false. The default value is true.
 47         public virtual bool ConvertEmptyStringToNull { get; set; }
 48         //
 49         // Summary:
 50         //     Gets or sets the description of the model.
 51         //
 52         // Returns:
 53         //     The description of the model. The default value is null.
 54         public virtual string Description { get; set; }
 55         //
 56         // Summary:
 57         //     Gets or sets a value that indicates whether the model is a complex type.
 58         //
 59         // Returns:
 60         //     A value that indicates whether the model is considered a complex.
 61         public virtual bool IsComplexType { get; }
 62         //
 63         // Summary:
 64         //     Gets a value that indicates whether the type is nullable.
 65         //
 66         // Returns:
 67         //     true if the type is nullable; otherwise, false.
 68         public bool IsNullableValueType { get; }
 69         //
 70         // Summary:
 71         //     Gets or sets a value that indicates whether the model is read-only.
 72         //
 73         // Returns:
 74         //     true if the model is read-only; otherwise, false.
 75         public virtual bool IsReadOnly { get; set; }
 76         //
 77         // Summary:
 78         //     Gets the value of the model.
 79         //
 80         // Returns:
 81         //     The model value can be null.
 82         public object Model { get; set; }
 83         //
 84         // Summary:
 85         //     Gets the type of the model.
 86         //
 87         // Returns:
 88         //     The type of the model.
 89         public Type ModelType { get; }
 90         //
 91         // Summary:
 92         //     Gets a collection of model metadata objects that describe the properties
 93         //     of the model.
 94         //
 95         // Returns:
 96         //     A collection of model metadata objects that describe the properties of the
 97         //     model.
 98         public virtual IEnumerable<ModelMetadata> Properties { get; }
 99         //
100         // Summary:
101         //     Gets the property name.
102         //
103         // Returns:
104         //     The property name.
105         public string PropertyName { get; }
106         //
107         // Summary:
108         //     Gets or sets the provider.
109         //
110         // Returns:
111         //     The provider.
112         protected ModelMetadataProvider Provider { get; set; }
113 
114         // Summary:
115         //     Gets the display name for the model.
116         //
117         // Returns:
118         //     The display name for the model.
119         public string GetDisplayName();
120         //
121         // Summary:
122         //     Gets a list of validators for the model.
123         //
124         // Parameters:
125         //   validatorProviders:
126         //     The validator providers for the model.
127         //
128         // Returns:
129         //     A list of validators for the model.
130         public virtual IEnumerable<Web.Http.Validation.ModelValidator> GetValidators(IEnumerable<Web.Http.Validation.ModelValidatorProvider> validatorProviders);

ModelMetadata

 1: public class ModelMetadata

   2: {

   3:    //其他成员

   4:     public Type ModelType { get; }

   5:     public virtual bool IsComplexType { get; }

   6:     public bool IsNullableValueType { get; }

   7:     public Type ContainerType { get; }

   8:  

   9:     public object Model { get; set; }

  10:     public string PropertyName { get; }

  11:  

  12:     public virtual Dictionary<string, object> AdditionalValues { get; }

  13:     protected ModelMetadataProvider Provider { get; set; }

  14: }

如上面的代码片断所示，ModelMetadata具有四个类型相关的只读属性。ModelType表示Model本身的类型，比如说针对上面定义的Contact类型的ModelMetadata对象，其ModelType属性值就是Contact类型；而针对其属性的ModelMetadata对象，则具体的属性类型作为它的ModelType属性。属性IsComplexType和IsNullableValueType分别表示以ModelType属性表示的Model类型是一个复杂类型和可空值类型。

在这里判断某个类型是否是复杂类型的条件只有一个，即是否允许字符串类型向该类型的转换。具体来说，将通过ModelType属性表示的Model类型作为传输传入TypeDescriptor的静态方法GetConverter得到一个TypeConverter对象，如果TypeConverter不支持从字符串类型的转换则认为是复杂类型。所以所有的基元类型（Primative Type）均不是复杂类型，所有可空值类型（Nuallable Type）均不是是复杂类型。对于一个默认为复杂类型的自定义的数据类型，我们可以通过TypeConverterAttribute特性标注一个支持从字符串类型转换的TypeConverter使之转变成非复杂类型。

如下面的代码片断所示，我们定义了一个表示二维坐标的Point类型，由于我们在该类型上应用了一个TypeConverterAttribute特性指定了类型为PointTypeConverter的TypeConverter。由于PointTypeConverter支持从字符串到Point类型之间的转换，所以Point并不是一个复杂类型。

   1: [TypeConverter(typeof(PointTypeConverter))]

   2: public class Point

   3: {

   4:     public double X { get; set; }

   5:     public double Y { get; set; }

   6:     public Point(double x, double y)

   7:     {

   8:         this.X = x;

   9:         this.Y = y;

  10:     }

  11:     public static Point Parse(string point)

  12:     { 

  13:         string[] split = point.Split(',');

  14:         if(split.Length != 2)

  15:         {

  16:             throw new FormatException("Invalid point expression.");

  17:         }

  18:         double x;

  19:         double y;

  20:         if (!double.TryParse(split[0], out x) || 

  21:             !double.TryParse(split[1], out y))

  22:         { 

  23:             throw new FormatException("Invalid point expression.");

  24:         }

  25:         return new Point(x, y);

  26:     }

  27: }

  28: public class PointTypeConverter : TypeConverter

  29: {

  30: public override bool CanConvertFrom(ITypeDescriptorContext context, 

  31:    Type sourceType)

  32:     {

  33:         return sourceType == typeof(string);

  34:     }

  35:  

  36: public override object ConvertFrom(ITypeDescriptorContext context, 

  37:     CultureInfo culture, object value)

  38:     {

  39:         if (value is string)

  40:         {

  41:             return Point.Parse(value as string);

  42:         }

  43:         return base.ConvertFrom(context, culture, value);

  44:     }

  45: }

通过上面的介绍我们知道表示Model元数据的ModelMetadata具有一个树形的层次结构，某个节点可以看成了其子节点的容器，而ContainerType这是表述容器的类型。同样以前面定义的Contact类型为例，基于该类型本身的ModelMetadata是整个层次树的根节点，所以ContainerType返回Null；基于属性Address的ModelMetadata的ContainerType属性返回Contact类型；而基于Address的属性Province的ModelMetadata的ContainerType属性值则是Address类型。

ModelMetadata的Model属性代表的是作为Model的对象。如果将上面定义的Contact对象作为View的Model，那么表示该Model本身元数据的ModelMetadata对象来说，其Model属性就是该Contact对象；对于基于Contact某个属性的ModelMetadata对象则将对应的属性值作为自己的Model。值得一提的是，该属性是可读可写的，意味着我们可以随时根据需要改变它。另一个属性PropertyName表示对应的属性值，对于根节点ModelMetadata来说，该属性总是返回Null。

ModelMetadata的AdditionalValues属性返回一个字典对象，用于存储一些自定义的属性，字典元素的Key和Value分别代表自定义属性的名称和值。对于自定义属性的添加，我们可以在数据类型或者其数据成员上应用AdditionalMetadataAttribute特性来实现。如下面的代码片断所示，AdditionalMetadataAttribute具有Name和Value两个只读属性分别表示自定义属性的名称和值，它们直接通过构造函数进行初始化。AdditionalMetadataAttribute实现了IMetadataAware接口，对于Model元数据的定制来说，这是一个非常重要并且实用的接口，我们将在下篇对其进行单独介绍。

   1: [AttributeUsage(AttributeTargets.Interface | AttributeTargets.Property | 

   2:     AttributeTargets.Class, AllowMultiple=true)]

   3: public sealed class AdditionalMetadataAttribute : Attribute, IMetadataAware

   4: {

   5:     public AdditionalMetadataAttribute(string name, object value);

   6:     public void OnMetadataCreated(ModelMetadata metadata);

   7:     public string Name { get; }

   8:     public object Value { get;}

   9: }

ModelMetadata的属性Provider是一个ModelMetadataProvider对象，顾名思义，ModelMetadataProvider是ModelProvider的提供者。ModelProvider是ASP.NET MVC整个Model元数据系统的核心，我们将在后续的博文中对其进行单独讲述。

ASP.NET MVC Model元数据及其定制: 初识Model元数据 
ASP.NET MVC Model元数据及其定制: Model元数据的定制 
ASP.NET MVC Model元数据及其定制：一个重要的接口IMetadataAware