ASP.NET Web API Model-ParameterBinding

ASP.NET Web API Model-ParameterBinding

前言

通過上個篇幅的學習了解Model綁定的基礎知識，然而在ASP.NET Web API中Model綁定功能模塊并不是被直接調用的，而是要通過本篇要介紹的內容ParameterBinding的一系列對象對其進行封裝調用，通過本篇的學習之后也會大概的清楚在Web API中綁定會有哪幾種方式。

Model-ParameterBinding（對象篇）

在ASP.NET Web API中ParameterBinding代表著參數綁定并且在這其中涉及了幾種綁定的方式，然而ParaMeterBinding并不是單獨執行的，就好比一個控制器方法中有可能會有多個參數一樣，所以我們就先來看一下ActionBinding的相關對象，對于這些對象的生成的環境以及過程我們在后面的篇幅中會有講解。

HttpActionBinding

代碼1-1

namespace System.Web.Http.Controllers
{
    public class HttpActionBinding
    {
        public HttpActionBinding();
        public HttpActionBinding(HttpActionDescriptor actionDescriptor, HttpParameterBinding[] bindings);
        public HttpActionDescriptor ActionDescriptor { get; set; }
        public HttpParameterBinding[] ParameterBindings { get; set; }

        public virtual Task ExecuteBindingAsync(HttpActionContext actionContext, CancellationToken cancellationToken);
    }
}

代碼1-1中對于HttpActionBinding類型的定義一目了然，看HttpActionBinding類型的重載構造函數中有HttpActionDescriptor類型、HttpParameterBinding類型的數組類型作為參數，HttpActionDescriptor類型作為控制器方法描述類型大家已經很熟悉了吧，這個類型中包含著控制器方法的元數據信息，而后者HttpParameterBinding類型則是表示著參數綁定對象，其實在Model綁定中每個參數的綁定都是通過ParameterBinding來綁定的，所以這里的執行過程我們暫時不去深入了解，就是單純的了解一下相關的對象模型。

HttpParameterBinding

代碼1-2

namespace System.Web.Http.Controllers
{
    public abstract class HttpParameterBinding
    {
        protected HttpParameterBinding(HttpParameterDescriptor descriptor);

        public HttpParameterDescriptor Descriptor { get; }
        public virtual string ErrorMessage { get; }
        public bool IsValid { get; }
        public virtual bool WillReadBody { get; }

        public abstract Task ExecuteBindingAsync(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, CancellationToken cancellationToken);
        protected object GetValue(HttpActionContext actionContext);
        protected void SetValue(HttpActionContext actionContext, object value);
    }
}

在代碼1-2中我們看到HttpParameterBinding類型的定義，可以看到HttpParameterBinding是抽象類型，并且實現綁定的方法ExecuteBindingAsync()也是抽象的，這也是為了在不同的環境和情況相愛采取不同的綁定機制做好鋪墊就是多態啦，這個我們后面會說，我們還是先看下HttpParameterBinding類型的內部定義，首先我們看到的是構造函數中的參數類型，HttpParameterDescriptor類型，又是一個對象描述類型，這次的描述對象則是控制其方法中的某個參數，而HttpParameterBinding對象實例的生成則是根據HttpParameterDescriptor對象實例而來，這個后續的篇幅中會有講解。ErrorMessage屬性表示在ParameterBinding綁定的過程中出現的錯誤信息，而IsValid屬性表示綁定是否可以完成的依據就是判斷ErrorMessage屬性是否為Null，WillReadBody屬性表示ParameterBinding對象是否讀取Http消息正文內容作為參數綁定的數據源，這個稍后給大家看的示例中就有，一看便知。GetValue()和SetValue()方法就是向當前HttpActionContext中獲取對應的參數值和設置參數對應值。

ModelBinderParameterBinding

代碼1-3

namespace System.Web.Http.ModelBinding
{
    public class ModelBinderParameterBinding : HttpParameterBinding, IValueProviderParameterBinding
    {
        public ModelBinderParameterBinding(HttpParameterDescriptor descriptor, IModelBinder modelBinder, IEnumerable<System.Web.Http.ValueProviders.ValueProviderFactory> valueProviderFactories);

        public IModelBinder Binder { get; }
        public IEnumerable<System.Web.Http.ValueProviders.ValueProviderFactory> ValueProviderFactories { get; }

        public override Task ExecuteBindingAsync(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, CancellationToken cancellationToken);
    }
}

代碼1-3表示的是ModelBinderParameterBinding類型，這個類型代表的綁定方式（綁定的數據來源）是通過IModelBinder來獲取的，也就正如代碼1-3中我們看到的構造函數一樣，其中有IModelBinder和ValueProviderFactory類型的集合，這些就是數據綁定的數據源。Binder屬性和ValueProviderFactories屬性也就是構造函數傳入的兩個類型值。對于綁定的細節這里就不說多了。

FormatterParameterBinding

代碼1-4

namespace System.Web.Http.ModelBinding
{
    public class FormatterParameterBinding : HttpParameterBinding
    {
        public FormatterParameterBinding(HttpParameterDescriptor descriptor, IEnumerable<MediaTypeFormatter> formatters, IBodyModelValidator bodyModelValidator);

        public IBodyModelValidator BodyModelValidator { get; set; }
        public override string ErrorMessage { get; }
        public IEnumerable<MediaTypeFormatter> Formatters { get; set; }
        public override bool WillReadBody { get; }

        public override Task ExecuteBindingAsync(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, CancellationToken cancellationToken);
        public virtual Task<object> ReadContentAsync(HttpRequestMessage request, Type type, IEnumerable<MediaTypeFormatter> formatters, IFormatterLogger formatterLogger);
    }
}

代碼1-4中所示的FormatterParameterBinding類型是通過哪種方式來獲取綁定數據源的呢？大家可以看到WillReadBody屬性在這個類型中被重寫了，原來在HttpParameterBinding類型中默認為false的是不會對Http請求的正文內容進行讀寫的，而這里在FormatterParameterBinding類型中，已然的重寫了，說明在這個類型中我們所能用到的綁定數據源就是從Http請求的正文內容來讀取了，然而Http請求的正文內容并不是直接放在那里供我們讀取的，而是在客戶端發送前就已經被指定的序列化器序列化了。

那么我們在服務器端就要反序列化才能獲取到值，這里在代碼1-4中我們看到構造函數中可以看到和代碼1-3一樣都是具有一個HttpParameterDescriptor類型的參數對象，而后則是一個MediaTypeFormatter類型的集合對象，最后是進行Model驗證的對象，這個后續再說。

現在我們就來看看第二個參數類型中的MediaTypeFormatter類型。

MediaTypeFormatter

代碼1-5

namespace System.Net.Http.Formatting
{
    public abstract class MediaTypeFormatter
    {
        protected MediaTypeFormatter();
        public abstract bool CanReadType(Type type);
        public abstract bool CanWriteType(Type type);
        public virtual Task<object> ReadFromStreamAsync(Type type, Stream readStream, HttpContent content, IFormatterLogger formatterLogger);
        public virtual Task WriteToStreamAsync(Type type, object value, Stream writeStream, HttpContent content, TransportContext transportContext);
    }
}

在代碼1-5中所示的MediaTypeFormatter類型是被刪減過的一部分，所剩4個方法中兩個是抽象方法兩個是虛方法，先看兩個抽象方法的定義，CanReadType()方法表示的是根據指定的參數類型從當前的Http請求正文中能否讀取到改類型的值，簡單來說就是能否把正文內容反序列化為指定的參數類型，同理CanWriterType()是對響應正文進行操作判斷。而ReadFromStreamAsync()方法和WriteToStreamAsync()方法則是對Http請求正文內容和Http響應正文內容進行實際操作的兩個方法。

對于MediaTypeFormatter類型的實現類型比如說針對Json格式的JsonMediaTypeFormatter和針對Xml格式的XmlMediaTypeFormatter.

我們看一下JsonMediaTypeFormatter類型的簡單示例，大家就會知道是怎么回事了。

首先我們在服務器端的控制器中定義一個接收Post請求的方法，

代碼1-6

        [CustomControllerActionAuthorizationFilter]
        public void Post(Product product)
        {
            products.Add(product);
        }

為了方便演示在其控制其方法上加了個授權過濾器，然后我們對Post請求的處理使用JsonMediaTypeFormatter類型進行反序列化的操作將在CustomControllerActionAuthorizationFilter過濾器類型中進行。

代碼1-7

public Task<System.Net.Http.HttpResponseMessage> ExecuteAuthorizationFilterAsync(System.Web.Http.Controllers.HttpActionContext actionContext, System.Threading.CancellationToken cancellationToken, Func<Task<System.Net.Http.HttpResponseMessage>> continuation)
        {
            Console.WriteLine(actionContext.Request.Content.Headers.ContentType.MediaType);

            IEnumerable<MediaTypeFormatter> formatters = new MediaTypeFormatter[] 
            {
                new JsonMediaTypeFormatter()
            };
            Product product = actionContext.Request.Content.ReadAsAsync<Common.Product>(formatters).Result;
            Console.WriteLine(product.ProductID);
            Console.WriteLine(product.ProductName);
            Console.WriteLine(product.ProductCategory);
            return continuation();
        }

在代碼1-7中，在請求到達控制器方法之前會先經過授權過濾器，在這其中首先我們是先向服務器端的控制器輸出了當前請求的格式類型，然后就對當前請求的正文內容使用JsonMediaTypeFormatter類型進行反序列化操作。

我們再看下客戶端使用HttpClient類型進行模擬Post請求，

代碼1-8

            HttpClient httpClient = new HttpClient();
            Product product = new Product()
            {
                ProductID = "003",
                ProductName = "旺仔牛奶",
                ProductCategory = "食品類"
            };
            await httpClient.PostAsJsonAsync<Product>("http://localhost/selfhost/api/product", product);

最后結果如圖1.

圖1

看到這里想必大家也知道對于XmlMediaTypeFormatter的使用方式是怎樣的了。

還有一種MediaTypeFormatter類型FormUrlEncodedMediaTypeFormatter類型，FormUrlEncodedMediaTypeFormatter類型表示的是在Http Post請求中表單提交的數據所用格式器，我們看一下FormUrlEncodedMediaTypeFormatter類型中CanReadType()方法的實現。

代碼1-9

    public override bool CanReadType(Type type)
    {
        if (type == null)
        {
            throw Error.ArgumentNull("type");
        }
        if (!(type == typeof(FormDataCollection)))
        {
            return FormattingUtilities.IsJTokenType(type);
        }
        return true;
    }

在代碼1-9我們可以看到FormDataCollection類型實際就是IEnumerable<KeyValuePair<string,string>>類型的對象，在表單提交后的請求Url中大家也都可以看到是是key=value的形式，所以這里就是這種格式的。對于這個格式器的示例會在后面的篇幅給大家做演示講解。

HttpRequestParameterBinding

最后我們再看一個RequestParameterBinding對象。

代碼1-10

    public class HttpRequestParameterBinding : HttpParameterBinding
    {
        // Methods
        public HttpRequestParameterBinding(HttpParameterDescriptor descriptor)
            : base(descriptor)
        {
        }

        public override Task ExecuteBindingAsync(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, CancellationToken cancellationToken)
        {
            string parameterName = base.Descriptor.ParameterName;
            HttpRequestMessage request = actionContext.ControllerContext.Request;
            actionContext.ActionArguments.Add(parameterName, request);
            return TaskHelpers.Completed();
        }
    }

在代碼1-10中我們看到再ExecuteBindingAsync()方法的實現中，是直接獲取到參數名稱和當前的請求對象，然后添加到控制其方法執行上下文的ActionArguments屬性中，在之前的篇幅中也說過這個屬性用來存放方法對應參數值（Model綁定后的值）。

本篇關于ParameterBinding的對象介紹就到這里，都是零零散散的不過在后面的篇幅中都會有示例介紹說明的。