使用JSONP将复杂对象发送到WCF Web API

时间:2011-08-26 09:49:10

标签: jsonp wcf-web-api

感谢Alex Zeitler's article我的WCF Web API服务接受了JSONP请求。

这对于简单的请求非常有效,但我遇到了问题。

我需要能够访问的一个功能是搜索功能,它当前通过http帖子获取复杂对象。显然我不能通过JSONP发帖,所以我试着考虑如何将其转换为get请求。

现有功能如下:

[WebInvoke(UriTemplate = "", Method = "POST")]
public HttpResponseMessage<List<Models.Payload>> FindPayloads(Models.AimiRequest requestValues)
{
  // do stuff here
  return new HttpResponseMessage<List<searchResult>>(results);
}

传入的请求对象定义如下:

public class AimiRequest
{
  public MetadataQueryParameter[] Metadata { get; set; }
  public string ContentType { get; set; }
  public string RuleTypes { get; set; }
}

public class MetadataQueryParameter
{
  public string Name { get; set; }
  public string Value { get; set; }
}

棘手的部分是存在未知数量的元数据参数,并且事先不知道名称和值。

我尝试过简单地将对象序列化为字符串然后传递,但服务会抛出400 Bad Request(从客户端(:)发现了一个潜在危险的Request.Path值。)

那里有人有什么好主意吗?

编辑:DIRTY HACK ALERT!

好的,我有一个工作功能,但我不喜欢它。必须有一种方法可以实现这一目标,而不必手动从查询字符串中提取数据并自行取消编码。

客户端脚本(请记住这是测试代码而非生产)

function findPayload() {
  var paramName = $("#ddlMetaType option:selected").val();
  var paramValue = $("#txtValue").val();

  // build query object
  var AimiRequest = new Object();
  AimiRequest.ContentType = null;
  AimiRequest.RuleTypes = null;

  var MetadataQueryParameter = new Object();
  MetadataQueryParameter.Name = paramName;
  MetadataQueryParameter.Value = paramValue;

  AimiRequest.Metadata = new Array();
  AimiRequest.Metadata.push(MetadataQueryParameter); 
  // NB. In production there may be multiple params to push into the array.

  // send query to service
  $.ajax({
    cache: false,
    contentType: "application/json",
    data: {},
    dataType: "jsonp",
    error: function (xhr, textStatus, errorThrown) {
      switch (xhr.status) {
        case 404:
          displayNotFound();
          break;
        default:
          alert(xhr.status);
          break;
      }
    },
    success: function (response) {
      var resultsPane = $("#resultsPane");
      $(resultsPane).empty();
      $("#payloadTemplate").tmpl(response).appendTo(resultsPane);
    },
    type: "GET",
    url: "http://localhost:63908/search/json?data=" + encodeURIComponent(JSON.stringify(AimiRequest))
  });

}

接收它的服务器端功能:

[ServiceContract]
public class SearchResource
{
  private IPayloadService _payloadService;

  public SearchResource(IPayloadService pService)
  {
    this._payloadService = pService;
  }

  [WebGet(UriTemplate = "")]
  public HttpResponseMessage<List<Payload>> Search()
  {
    // find input in querystring
    var qString = HttpContext.Current.Request.QueryString["data"];
    // Unencode it
    var unenc = HttpUtility.UrlDecode(qString);
    // deserialise back to the object
    var jsSerialiser = new System.Web.Script.Serialization.JavaScriptSerializer();
    var myObj = jsSerialiser.Deserialize<AimiRequest>(unenc);
    // do search
    var metadataParams = new List<KeyValuePair<string, string>>();
    foreach (MetadataQueryParameter param in myObj.Metadata)
    {
      metadataParams.Add(new KeyValuePair<string, string>(param.Name, param.Value));
    }
    List<Data.Payload> data = _payloadService.FindPayloads(metadataParams, myObj.ContentType, myObj.RuleTypes);
    // Map to "viewmodel"
    var retVal = AutoMapper.Mapper.Map<List<Data.Payload>, List<Payload>>(data);
    // return results
    return new HttpResponseMessage<List<Payload>>(retVal);
  }
}

1 个答案:

答案 0 :(得分:2)

1)WCF Web API具有格式化器的概念,用于在通过Stream访问的HTTP内容和对象之间进行转换。可以注册多个格式化程序,选择过程不仅会考虑目标对象类型,还会考虑内容的媒体类型。

2)但是,格式化程序不用于转换URI和查询字符串参数。相反,此过程由HttpParameterValueConverter(s)完成,它们是不可扩展的。

3)总而言之,您必须自己“取消编码”数据。但是,您可以将此代码分解出操作。只需创建一个操作处理程序,它接收(输入参数)查询字符串参数作为字符串,并返回(输出参数)强类型“未编码”对象(Models.AimiRequest)。操作参数应为Models.AimiRequest类型。