WebApi - 從Uri和Body綁定

Question

是否可以綁定來自Uri和Body的模型？

例如，給出以下：

routes.MapHttpRoute(
    name: "API Default", 
    routeTemplate: "api/{controller}/{id}", 
    defaults: new { id = RouteParameter.Optional } 
); 

public class ProductsController : ApiController 
{ 
    public HttpResponseMessage Put(UpdateProduct model) 
    { 

    } 
} 

public class UpdateProduct 
{ 
    int Id { get; set;} 
    string Name { get; set; } 
} 

是否有可能創建一個自定義的粘合劑，使得PUT到

/API /產品/ 1

與一個JSON體：

{ 
    "Name": "Product Name" 
} 

將導致UpdateProduct模型填充Id = 1和Name = "Product Name"？

更新

我知道我可以在行動簽名更改爲

public HttpResponseMessage Put(int id, UpdateProduct model) 
{ 

} 

但是在這個問題說，我特別希望綁定到單個模型對象

我也發佈了這個問題WebApi Codeplex discussion forum

Answer 1

如果我理解你，這個應該開箱即用，例如這個工作對我來說：

[HttpPost] 
    public ActionResult Test(TempModel model) 
    { 
     ViewBag.Message = "Test: " + model.Id +", " + model.Name; 

     return View("About"); 
    } 

public class TempModel 
{ 
    public int Id { get; set; } 
    public string Name { get; set; } 
} 

routes.MapRoute(
      name: "Default", 
      url: "{controller}/{action}/{id}", 
      defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional } 
     ); 

和要求：本地主機：56329 /首頁/測試/ 22 與正文：{ 「名稱」： 「工具」}

我已經相應地設置我的模型的屬性到22和「工具」。

Answer 2

好吧，我想出了一個辦法。基本上，我製作了一個動作過濾器，它將在模型從JSON填充後運行。然後它將查看URL參數，並在模型上設置適當的屬性。全部源代碼如下：

using System.ComponentModel; 
using System.Linq; 
using System.Net; 
using System.Net.Http; 
using System.Reflection; 
using System.Web.Http.Controllers; 
using System.Web.Http.Filters; 


public class UrlPopulatorFilterAttribute : ActionFilterAttribute 
{ 
    public override void OnActionExecuting(HttpActionContext actionContext) 
    { 
     var model = actionContext.ActionArguments.Values.FirstOrDefault(); 
     if (model == null) return; 
     var modelType = model.GetType(); 
     var routeParams = actionContext.ControllerContext.RouteData.Values; 

     foreach (var key in routeParams.Keys.Where(k => k != "controller")) 
     { 
      var prop = modelType.GetProperty(key, BindingFlags.IgnoreCase | BindingFlags.Instance | BindingFlags.Public); 
      if (prop != null) 
      { 
       var descriptor = TypeDescriptor.GetConverter(prop.PropertyType); 
       if (descriptor.CanConvertFrom(typeof(string))) 
       { 
        prop.SetValueFast(model, descriptor.ConvertFromString(routeParams[key] as string)); 
       } 
      } 
     } 
    } 
} 

Answer 3

你可以定義你自己的DefaultActionValueBinder。然後你可以從身體和uri混合搭配。這裏是一個博客帖子，裏面有一個Web API的MvcActionValueBinder示例。使您自己的DefaultActionValueBinder成爲首選的解決方案，因爲它確保在執行任何其他ActionFilterAttribute之前，活頁夾將完成。

http://blogs.msdn.com/b/jmstall/archive/2012/04/18/mvc-style-parameter-binding-for-webapi.aspx

UPDATE：

我遇到了一些麻煩，在博客文章的實施，並試圖得到它使用我的自定義介質格式化。幸運的是，我的所有請求對象都是從基類中擴展的，所以我創建了自己的格式化程序。

在WebApiConfig

config.ParameterBindingRules.Insert(0, descriptor => descriptor.ParameterType.IsSubclassOf(typeof (Request)) ? new BodyAndUriParameterBinding(descriptor) : null); 

BodyAndUriParameterBinding。CS

public class BodyAndUriParameterBinding : HttpParameterBinding 
{ 
    private IEnumerable<MediaTypeFormatter> Formatters { get; set; } 
    private IBodyModelValidator BodyModelValidator { get; set; } 
    public BodyAndUriParameterBinding(HttpParameterDescriptor descriptor) 
     : base (descriptor) 
    { 
     var httpConfiguration = descriptor.Configuration; 
     Formatters = httpConfiguration.Formatters; 
     BodyModelValidator = httpConfiguration.Services.GetBodyModelValidator(); 
    } 

    private Task<object> ReadContentAsync(HttpRequestMessage request, Type type, 
     IEnumerable<MediaTypeFormatter> formatters, IFormatterLogger formatterLogger, CancellationToken cancellationToken) 
    { 
     var content = request.Content; 
     if (content == null) 
     { 
      var defaultValue = MediaTypeFormatter.GetDefaultValueForType(type); 
      return defaultValue == null ? Task.FromResult<object>(null) : Task.FromResult(defaultValue); 
     } 

     return content.ReadAsAsync(type, formatters, formatterLogger, cancellationToken); 
    } 

    public override Task ExecuteBindingAsync(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, 
     CancellationToken cancellationToken) 
    { 
     var paramFromBody = Descriptor; 
     var type = paramFromBody.ParameterType; 
     var request = actionContext.ControllerContext.Request; 
     var formatterLogger = new ModelStateFormatterLogger(actionContext.ModelState, paramFromBody.ParameterName); 
     return ExecuteBindingAsyncCore(metadataProvider, actionContext, paramFromBody, type, request, formatterLogger, cancellationToken); 
    } 

    // Perf-sensitive - keeping the async method as small as possible 
    private async Task ExecuteBindingAsyncCore(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, 
     HttpParameterDescriptor paramFromBody, Type type, HttpRequestMessage request, IFormatterLogger formatterLogger, 
     CancellationToken cancellationToken) 
    { 
     var model = await ReadContentAsync(request, type, Formatters, formatterLogger, cancellationToken); 

     if (model != null) 
     { 
      var routeParams = actionContext.ControllerContext.RouteData.Values; 
      foreach (var key in routeParams.Keys.Where(k => k != "controller")) 
      { 
       var prop = type.GetProperty(key, BindingFlags.IgnoreCase | BindingFlags.Instance | BindingFlags.Public); 
       if (prop == null) 
       { 
        continue; 
       } 
       var descriptor = TypeDescriptor.GetConverter(prop.PropertyType); 
       if (descriptor.CanConvertFrom(typeof(string))) 
       { 
        prop.SetValue(model, descriptor.ConvertFromString(routeParams[key] as string)); 
       } 
      } 
     } 

     // Set the merged model in the context 
     SetValue(actionContext, model); 

     if (BodyModelValidator != null) 
     { 
      BodyModelValidator.Validate(model, type, metadataProvider, actionContext, paramFromBody.ParameterName); 
     } 
    } 
} 

Answer 4

這裏的odyth的答案的改進版本：

1. Works的脫胎請求也和
2. 除了從路由值獲取參數從查詢字符串。

爲了簡便起見，我只是發佈了ExecuteBindingAsyncCore方法和一個新的輔助方法，其餘的類都是一樣的。

private async Task ExecuteBindingAsyncCore(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, 
     HttpParameterDescriptor paramFromBody, Type type, HttpRequestMessage request, IFormatterLogger formatterLogger, 
     CancellationToken cancellationToken) 
{ 
    var model = await ReadContentAsync(request, type, Formatters, formatterLogger, cancellationToken); 

    if(model == null) model = Activator.CreateInstance(type); 

    var routeDataValues = actionContext.ControllerContext.RouteData.Values; 
    var routeParams = routeDataValues.Except(routeDataValues.Where(v => v.Key == "controller")); 
    var queryStringParams = new Dictionary<string, object>(QueryStringValues(request)); 
    var allUriParams = routeParams.Union(queryStringParams).ToDictionary(pair => pair.Key, pair => pair.Value); 

    foreach(var key in allUriParams.Keys) { 
     var prop = type.GetProperty(key, BindingFlags.IgnoreCase | BindingFlags.Instance | BindingFlags.Public); 
     if(prop == null) { 
      continue; 
     } 
     var descriptor = TypeDescriptor.GetConverter(prop.PropertyType); 
     if(descriptor.CanConvertFrom(typeof(string))) { 
      prop.SetValue(model, descriptor.ConvertFromString(allUriParams[key] as string)); 
     } 
    } 

    // Set the merged model in the context 
    SetValue(actionContext, model); 

    if(BodyModelValidator != null) { 
     BodyModelValidator.Validate(model, type, metadataProvider, actionContext, paramFromBody.ParameterName); 
    } 
} 

private static IDictionary<string, object> QueryStringValues(HttpRequestMessage request) 
{ 
    var queryString = string.Join(string.Empty, request.RequestUri.ToString().Split('?').Skip(1)); 
    var queryStringValues = System.Web.HttpUtility.ParseQueryString(queryString); 
    return queryStringValues.Cast<string>().ToDictionary(x => x, x => (object)queryStringValues[x]); 
}