ASP.NET Web API Model-ModelMetadata

ASP.NET Web API Model-ModelMetadata

前言

前面的几个篇幅主要围绕控制器的执行过程，奈何执行过程中包含的知识点太庞大了，只能一部分一部分的去讲解，在上两篇中我们看到在控制器方法选择器根据请求选定了控制器方法后会生成对应的描述对象之后进入过滤器执行过程中，之后也是我们所讲的在授权过滤器执行之后会执行对Model的系列操作，中间包括Model元数据解析、Model绑定、Model验证，最后会通过Web API框架的独有的方式也就是ParameterBinding参数绑定来执行，在这些操作完毕之后会开始执行行为过滤器，可在控制器方法执行前后进行拦截，从技术方向来说这是AOP思想的一种实现，从业务逻辑上来讲也是一种依赖注入，扯远了，本篇就来谈谈在ASP.NET Web API框架中的Model元数据，也就是ModelMetadata.

Model-ModelMetadata（对象介绍、基础知识篇）

在讲解Model绑定之前我还是先来讲解一下在Web API中的Model元数据，在我前面的ASP.NET MVC随笔系列汇总中对MVC框架中的Model的元数据有过讲解，对MVC有了解的朋友可以去看看，在ASP.NET Web API框架中的Model元数据的设计思想和MVC框架中的是一样的，都是对Model进行类型解析，然后已树形结构呈现或者是给需要它的地方使用。为什么说是树形结构呢？我们来看一下示例，后面再结合对象类型这么一讲解大家就差不多该明白了。

 

我们先不管在框架中是怎么表示的，先来看一下定义的Model：

示例代码1-1

publicclassEmployeesInfo
   {
        [Display(Description="员工姓名")]
        publicstringName { get; set; }
 
        [Display(Description="员工年龄")]
        publicintAge { get; set; }
 
        [Display(Description="员工性别")]
        publicstringSex { get; set; }
 
        [Display(Description="员工地址信息")]
        publicAddressAddressInfo { get; set; }
   }
 
   
   publicclassAddress
   {
        [Display(Description="地址信息")]
        publicstringAddressInfo { get; set; }
 
        [Display(Description="邮编")]
        publicstringZipCode { get; set; }
}

在代码1-1中我定义了一个Model类型为EmployeesInfo，表示员工的信息，在这其中有几个属性，其中AddressInfo属性是下面的Address类型，这里是为了说明Model元数据所表示的对象存在两种类型，一种是简单类型，另一种是复杂类型。至于这个类型怎么判断下面会说，我们还是先来看示例代码，看下Model经过框架生成为Model元数据过后包含的信息。

示例代码1-2

publicclassMetadataController : ApiController
   {
        publicstringGet()
        {
            EmployeesInfoemployeesInfo=newEmployeesInfo()
            {
                Name="JinYuan",
                Age=24,
                Sex="男",
                AddressInfo=newAddress()
                {
                    AddressInfo="南京市",
                    ZipCode="210000"
                }
            };
            ModelMetadatamodelMetadata=this.Configuration.Services.GetModelMetadataProvider().GetMetadataForType(()=>employeesInfo, employeesInfo.GetType());
            StringBuilderstrBuilder=newStringBuilder();
            ModelMetadataAnalysis(strBuilder, modelMetadata);
            returnstrBuilder.ToString();
 
        }
 
        privatevoidModelMetadataAnalysis(StringBuilderstringBuilder, ModelMetadatamodelMetadata)
        {
            if (modelMetadata.IsComplexType==true)
            {
                foreach (varmetadatainmodelMetadata.Properties)
                {
                    ModelMetadataAnalysis(stringBuilder, metadata);
                }
            }
            else
            {
                stringBuilder.AppendLine(modelMetadata.Description).AppendLine("Value:"+modelMetadata.Model);
            }
        }
}

在代码1-2中，我首先定义了一个控制器，并且定义了一个Get()方法，返回类型为string类型，然后在Get()方法中实例化Model，也就是我们代码1-1中的定义，在这之后我根据当前控制器基类所包含的HttpConfiguration类型的属性Configuration，从ServicesContainer 类型的Services属性中获取到Model元数据提供程序，从而使用这个提供程序来根据Model类型生成Model元数据，这里起初生成好的Model元数据也就是modelMetadata变量，它暂时只是一个类型的的表示，也就是EmployeesInfo类型，并且其中并不包含EmployeesInfo类型中属性的元数据，这里要注意的是不包含只是暂时的。

然后下面使用了一个方法ModelMetadataAnalysis()，首先判断当前的Model元数据表示的类型是不是复杂类型，如果是的话就读取这个Model元数据中的Properties属性，注意了在读取的时候，也就是ModelMetadataAnalysis()方法中的参数modelMetadata就会开始使用自身的Model元数据提供程序来生成自身所表示类型下属性的Model元数据。由此可以看到上面的代码实现中只是对简单类型进行了输出。我们看一下示意图。

图1

根据图1所示的这样，然后我们再看代码1-2的实现，最后我们看一下执行的结果。

图2

图2中所示就是从客户端和浏览器共同访问返回的结果值，都是一样的。

 

下面我们来讲解一下相关的对象类型。

图3

我们先来看ModelMetadata类型，从图3中我们可以看到ModelMetadata类型在命名空间System.Web.Http.Metadata下，我们就先来看一下ModelMetadata的定义，

示例代码1-3

publicclassModelMetadata
   {
        publicModelMetadata(ModelMetadataProviderprovider, TypecontainerType, Func