ASP.NET Web API Model-ValueProvider

ASP.NET Web API Model-ValueProvider

前言

前面一篇講解了Model元數據，Model元數據是在Model綁定中很重要的一部分，只是Model綁定中涉及的知識點比較多，對于ASP.NET MVC框架來說ASP.NET Web API框架中在Model綁定部分又新增了參數綁定這么一個機制，這些內容都會在后面的篇幅中說明，前面的這些篇幅都是講解理論上的知識也沒有涉及到示例的演示，這個大家不用急在最后Model部分的基礎知識講解完之后我會把前面所講的全部串聯起來，而今天這個篇幅給大家帶來的就是在Model綁定中起到至關重要的一個環節，大家這個不用去管什么Model綁定，而是單純的去了解ValueProvider這一系列的對象模型，因為在沒有結合前后知識點串聯起來之前，我們都不知道ValueProvider是在哪執行的。所以我們還是老老實實了解一下ValueProvider相關的對象吧。

Model-ValueProvider

圖1

IValueProvider接口類型--ValueProvider行為約束

首先我們看一下圖1中右邊的部分，起頭的就是一個IValueProvider接口類型，我們就來看一下接口的定義：

示例代碼1-1

   publicinterfaceIValueProvider
   {
        boolContainsPrefix(stringprefix);
        ValueProviderResultGetValue(stringkey);
   }

我們在代碼1-1中看到，IValueProvider接口中定義了兩個方法，一個是ContainsPrefix()方法，接收string類型的參數并且返回的是bool值類型，這個方法表示的就是根據指定的前綴值查看當前的ValueProvider中是否存在這個前綴值，這個下面會有示例稍后再說，然后就是GetValue()方法，是根據執行的鍵值返回當中的對應的值，從這里一看我們就大概能猜到這個ValueProvider應該是類似于鍵值隊一樣的類型，而返回的結果被封裝在了ValueProviderResult類型當中，這個類型稍后會有說明。在IValueProvider接口約束好ValueProvider值提供程序的行為后，我們應該就來看一看ValueProvider值提供程序的基礎結構了。不過呢在此之前我們還是要根據圖1中所示的那樣，先來看一下IEnumerableValueProvider接口類型的定義，這個接口主要負責什么呢？

IEnumerableValueProvider接口類型-ValueProvider行為約束

示例代碼1-2

   publicinterfaceIEnumerableValueProvider : IValueProvider
   {
        IDictionary<string, string>GetKeysFromPrefix(stringprefix);
   }

從代碼1-2中可以很清楚明了的看到IEnumerableValueProvider接口類型的職責很簡單，就是對指定的前綴值進行檢索，并且最后以鍵值隊的形式返回，這個在下面會有示例詳細說明。

NameValuePairsValueProvider類型-ValueProvider基礎結構

示例代碼1-3

   publicclassNameValuePairsValueProvider : IEnumerableValueProvider, IValueProvider
   {
        publicNameValuePairsValueProvider(Func<IEnumerable<KeyValuePair<string, string>>>valuesFactory, CultureInfoculture);
        publicNameValuePairsValueProvider(IEnumerable<KeyValuePair<string, string>>values, CultureInfoculture);
 
        publicvirtualboolContainsPrefix(stringprefix);
        publicvirtualIDictionary<string, string>GetKeysFromPrefix(stringprefix);
        publicvirtualValueProviderResultGetValue(stringkey);
    }

在代碼1-3中我們看到NameValuePairsValueProvider類型的定義，首先就說說它的構造函數吧，兩個構造函數的區別在于第一個是Func<IEnumerable<KeyValuePair<string, string>>>類型的構造函數參數，第二個是IEnumerable<KeyValuePair<string, string>>類型的構造函數參數，第二個構造函數的首個參數類型實際就是第一個構造函數首個參數的返回類型，這里大家都看得到，其實在內部實現，也是這樣的聲明第一個構造函數是沒什么的，聲明第二個構造函數的時候其實就把參數再次封裝為委托。

對于KeyValuePair<T,U>類型可以理解為鍵值隊的子項，在它的類型中只有一個鍵值對應一個值只有一項就是它本身。

至于剩下的三個方法我們還是靠簡單的示例來說明一下。

示例代碼1-4

    publicclassValueProviderCaseController : ApiController
   {
        publicstringGet()
        {
            
            KeyValuePair<string,string>[] dictionary=newKeyValuePair<string,string>[]
            {
                newKeyValuePair<string,string>("EmployeesInfo.Name","Jinyuan"),
                newKeyValuePair<string,string>("EmployeesInfo.Age","24"),
                newKeyValuePair<string,string>("EmployeesInfo.Sex","男"),
                newKeyValuePair<string,string>("EmployeesInfo.AddressInfo.AddressInfo","南京市"),
                newKeyValuePair<string,string>("EmployeesInfo.AddressInfo.ZipCode","210000")
            };
            NameValuePairsValueProvidernameValuePairsValueProvider=newNameValuePairsValueProvider(dictionary,null);
            StringBuilderstrBuilder=newStringBuilder();
            NameValuePairsPrefixAnalysis(strBuilder, nameValuePairsValueProvider, "EmployeesInfo");
            returnstrBuilder.ToString();
        }
 
        privatevoidNameValuePairsPrefixAnalysis(StringBuilderstringbuilder, NameValuePairsValueProvidernamevaluepairs,stringprefix)
        {
            IDictionary<string, string>dictionarys=namevaluepairs.GetKeysFromPrefix(prefix);
            
            if (dictionarys.Count>0)
            {
                Console.WriteLine(prefix+"為前綴的數據源Key值檢索……");
                foreach (varitemindictionarys)
                {
                    Console.WriteLine("Key:"+item.Key+" Value:"+item.Value);
                }
                foreach (KeyValuePair<string, string>keyvalueindictionarys)
                {
                    NameValuePairsPrefixAnalysis(stringbuilder, namevaluepairs, keyvalue.Value);
                }
            }
            else
            {
                stringbuilder.AppendLine(prefix+":"+namevaluepairs.GetValue(prefix).RawValue.ToString());
            }
        }
   }

我們來看代碼1-4，首先我在Get()方法中定義了一個KeyValuePair<string,string>[]類型，為了能夠實例化NameValuePairsValueProvider類型，在此之后大家可以看到我調用了一個我自定義的NameValuePairsPrefixAnalysis()方法，并且在其中使用NameValuePairsValueProvider類型的實例調用了GetKeysFromPrefix()方法，也就是代碼1-2所約束的那個行為。這個時候我們先來看一下表1.

表1

表1所表示的就是初始數據源，也就是我們定義的KeyValuePair<string,string>[]類型的鍵、值示意表。

然而在我們使用NameValuePairsValueProvider類型的實例已” EmployeesInfo”作為前綴調用了GetKeysFromPrefix()方法后返回的IDictionary<string,string>類型的值如表2.

表2

這里的表2值只是第一層的關系值。

在此之后我們輸出的當前的所要檢索的前綴值以及檢索過后的值，并且會遍歷表2里的Value值作為前綴值再次的對數據源進行前綴檢索，如果沒有了則說明已經沒有可檢索的了。

并且使用NameValuePairsValueProvider類型實例調用的GetValue()方法根據最后已經檢索不出來有后綴的前綴值，也就是原始數據源當中的Key值了。

最后我們看一下結果。

圖2

在客戶端我們獲取到了值，當然這里只是演示示例，值提供程序提供的值方向反了。

然后我們可以在服務端看到檢索的記錄，可以明確的看到有兩層的結構在其中。有興趣的朋友深入一下看下檢索的具體實現方式。

QueryStringValueProvider類型-ValueProvider特定結構

示例代碼1-5

   publicclassQueryStringValueProvider : NameValuePairsValueProvider
   {
        publicQueryStringValueProvider(HttpActionContextactionContext, CultureInfoculture)
            : base(func, culture)
        {
            Func<IEnumerable<KeyValuePair<string, string>>>func=null;
            if (func==null)
            {
                func= () =>actionContext.ControllerContext.Request.GetQueryNameValuePairs();
            }
        }
   }

從代碼1-5中可以看到在QueryStringValueProvider類型初始化的時候構造函數中的執行，把從請求查詢字符串作為原始數據來源封裝為委托類型，然后調用基類的構造函數。

RouteDataValueProvider類型-ValueProvider特定結構

示例代碼1-6

   publiccla***outeDataValueProvider : NameValuePairsValueProvider
   {
        publicRouteDataValueProvider(HttpActionContextactionContext, CultureInfoculture)
            : base(func, culture)
        {
            Func<IEnumerable<KeyValuePair<string, string>>>func=null;
            if (func==null)
            {
                func= () =>GetRoutes(actionContext.ControllerContext.RouteData);
            }
        }
   }

同上面1-5一樣的道理，這里使用了HttpRouteData中的Values值作為原始數據源。

還有圖1中的左邊部分會在后面的篇幅中講解，在這里講不適合，會感覺不連貫，雖然看完本篇不知道這個起到了什么作用也不知道怎么去使用，感覺被掐住了脖子一樣的難受，但是后面我會把前面所講的內容全部串聯起來做一個演示，所示這是基礎部分的知識，就是一個鋪墊。