ASP.NET Web API Model-ModelMetadata

前言

前面的幾個(gè)篇幅主要圍繞控制器的執(zhí)行過程，奈何執(zhí)行過程中包含的知識點(diǎn)太龐大了，只能一部分一部分的去講解，在上兩篇中我們看到在控制器方法選擇器根據(jù)請求選定了控制器方法后會生成對應(yīng)的描述對象之后進(jìn)入過濾器執(zhí)行過程中，之后也是我們所講的在授權(quán)過濾器執(zhí)行之后會執(zhí)行對Model的系列操作，中間包括Model元數(shù)據(jù)解析、Model綁定、Model驗(yàn)證，最后會通過Web API框架的獨(dú)有的方式也就是ParameterBinding參數(shù)綁定來執(zhí)行，在這些操作完畢之后會開始執(zhí)行行為過濾器，可在控制器方法執(zhí)行前后進(jìn)行攔截，從技術(shù)方向來說這是AOP思想的一種實(shí)現(xiàn)，從業(yè)務(wù)邏輯上來講也是一種依賴注入，扯遠(yuǎn)了，本篇就來談?wù)勗贏SP.NET Web API框架中的Model元數(shù)據(jù)，也就是ModelMetadata.

Model-ModelMetadata（對象介紹、基礎(chǔ)知識篇）

在講解Model綁定之前我還是先來講解一下在Web API中的Model元數(shù)據(jù)，在我前面的ASP.NET MVC隨筆系列匯總中對MVC框架中的Model的元數(shù)據(jù)有過講解，對MVC有了解的朋友可以去看看，在ASP.NET Web API框架中的Model元數(shù)據(jù)的設(shè)計(jì)思想和MVC框架中的是一樣的，都是對Model進(jìn)行類型解析，然后已樹形結(jié)構(gòu)呈現(xiàn)或者是給需要它的地方使用。為什么說是樹形結(jié)構(gòu)呢？我們來看一下示例，后面再結(jié)合對象類型這么一講解大家就差不多該明白了。

我們先不管在框架中是怎么表示的，先來看一下定義的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中我定義了一個(gè)Model類型為EmployeesInfo，表示員工的信息，在這其中有幾個(gè)屬性，其中AddressInfo屬性是下面的Address類型，這里是為了說明Model元數(shù)據(jù)所表示的對象存在兩種類型，一種是簡單類型，另一種是復(fù)雜類型。至于這個(gè)類型怎么判斷下面會說，我們還是先來看示例代碼，看下Model經(jīng)過框架生成為Model元數(shù)據(jù)過后包含的信息。

示例代碼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中，我首先定義了一個(gè)控制器，并且定義了一個(gè)Get()方法，返回類型為string類型，然后在Get()方法中實(shí)例化Model，也就是我們代碼1-1中的定義，在這之后我根據(jù)當(dāng)前控制器基類所包含的HttpConfiguration類型的屬性Configuration，從ServicesContainer 類型的Services屬性中獲取到Model元數(shù)據(jù)提供程序，從而使用這個(gè)提供程序來根據(jù)Model類型生成Model元數(shù)據(jù)，這里起初生成好的Model元數(shù)據(jù)也就是modelMetadata變量，它暫時(shí)只是一個(gè)類型的的表示，也就是EmployeesInfo類型，并且其中并不包含EmployeesInfo類型中屬性的元數(shù)據(jù)，這里要注意的是不包含只是暫時(shí)的。

然后下面使用了一個(gè)方法ModelMetadataAnalysis()，首先判斷當(dāng)前的Model元數(shù)據(jù)表示的類型是不是復(fù)雜類型，如果是的話就讀取這個(gè)Model元數(shù)據(jù)中的Properties屬性，注意了在讀取的時(shí)候，也就是ModelMetadataAnalysis()方法中的參數(shù)modelMetadata就會開始使用自身的Model元數(shù)據(jù)提供程序來生成自身所表示類型下屬性的Model元數(shù)據(jù)。由此可以看到上面的代碼實(shí)現(xiàn)中只是對簡單類型進(jìn)行了輸出。我們看一下示意圖。

圖1

根據(jù)圖1所示的這樣，然后我們再看代碼1-2的實(shí)現(xiàn)，最后我們看一下執(zhí)行的結(jié)果。

圖2

圖2中所示就是從客戶端和瀏覽器共同訪問返回的結(jié)果值，都是一樣的。

下面我們來講解一下相關(guān)的對象類型。

圖3

我們先來看ModelMetadata類型，從圖3中我們可以看到ModelMetadata類型在命名空間System.Web.Http.Metadata下，我們就先來看一下ModelMetadata的定義，

示例代碼1-3

publicclassModelMetadata
   {
        publicModelMetadata(ModelMetadataProviderprovider, TypecontainerType, Func