从 JavaScript 使用 XML WCF REST Web 服务

Question

我有一个 WPF 应用程序，它公开了一个 REST WCF 服务（通过 WebServiceHost），其合同看起来像这样（简化）：

[ServiceContract]
public interface IItemServiceContract
{
    [WebGet(UriTemplate = "Items/{id}")]
    Item GetItem(string id);

    [WebGet(UriTemplate = "Items")]
    IEnumerable<Item> GetItems();

    [WebInvoke(UriTemplate = "Items", Method = "PUT")]
    IEnumerable<Item> CreateItems(IEnumerable<Item> list);
}

当我使用浏览器导航到 http://localhost:8070/Contoso/Services/Items/ItemService/Items 时，我收到如下响应：

<ArrayOfItem xmlns="http://schemas.datacontract.org/2004/07/Contodo.Services.Items" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Item>
    <ItemState>
      <Comment i:nil="true"/>
      <DeactivationTime>0001-01-01T00:00:00</DeactivationTime>
      <Id>18f1a5e4-a94a-4f37-a533-3a75a10e7373</Id>
      <IsSpecial>false</IsSpecial>
    </ItemState>
    <ItemTypeId>10</ItemTypeId>
    <HelpInfo/>
    <Identity>Ident1</Identity>
    <AdditionalInfo>
      &lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-16&quot;?&gt;
      &lt;Content&gt;
        &lt;SpecialContent /&gt;
      &lt;/Content&gt;</AdditionalInfo>
    <TextParameter>kjhdfsjh kj dkfjg kj</TextParameter>
    <UserName i:nil="true"/>
  </Item>
</ArrayOfItem>

什么是使用 JavaScript 使用此服务的简单且无摩擦的方法？客户端如何快速构建 http 请求和相应的 XML？

我完全处于 Html5/javaScript 世界中，但在 C# 中，我将有一个以Item 对象为中心的 API，该对象被序列化为 XML。但这是要走的路吗？

更新：

根据第一个 cmets 和答案，XML 似乎不是 JavaScript/webbrowser 消费者的理想格式，但我不能只将格式更改为 JSON，因为这可能会破坏已经依赖此 XML 的现有客户端格式。所以理想情况下，我会进行 REST 内容类型协商并放置/获取 JSON 或 XML。但这可以通过 WCF REST 服务来完成吗？

Answer 1

我想你使用的是 ASP.NET 4.X。

WCF 4 支持基于 HTTP“Accept”和“Content-Type”请求标头的 automatic format selection。在web.config 文件中指定automaticFormatSelectionEnabled="true" 属性：

<configuration>
  <system.serviceModel>
    <standardEndpoints>
      <webHttpEndpoint>
        <!-- the "" standard endpoint is used for auto creating a web endpoint. -->
        <standardEndpoint name=""
                          helpEnabled="true"
                          automaticFormatSelectionEnabled="true"/>
      </webHttpEndpoint>
    </standardEndpoints>
  </system.serviceModel>
</configuration>

有关详细信息，请参阅 the article 和 the article 的“消息格式选择”部分。您可以将automaticFormatSelectionEnabled 属性与defaultOutgoingResponseFormat 结合使用（您可以设置为“xml”或“json”，默认已经是“xml”）。您可以只为一个特定端点指定属性，而不是像上面的示例中那样使用 standardEndpoint。

因此，如果您使用相应的 WCF 配置，您的现有 WCF 服务只会为 JavaScript 请求提供 JSON 数据，并且仍会为其他客户端返回 XML 数据。

Answer 2

试试这个

对于 Json 类型结果

在界面中

         [WebInvoke(Method = "POST", UriTemplate = "/ItemGetItem?id={id}", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
        [OperationContract]
        void  ItemGetItem(string id);

在脚本中

self.GetItem= function () {

         try {

             $.ajax({
                 type: "POST",
                 url: "Your Url",
                 contentType: 'application/json',
                 async: false,
                 dataType: 'json',
                 cache: false,
                 success: function (response) {




                 },
                 error: function (ErrorResponse) {


                 }

             });

         }

         catch (error) {


         }

     }

放置客户端应用程序的端点以使用此服务

Answer 3

查看WcfRestContrib。 this 的回答也可能对您有所帮助。

Answer 4

你最先看http://www.codeproject.com/Articles/33234/A-beginner-s-guide-for-consuming-a-WCF-service-in

但我认为最简单的方法是将格式更改为 Json。还有一篇关于代码项目的好文章：http://www.codeproject.com/Articles/327420/WCF-REST-Service-with-JSON

Answer 5

如果您使用的是 jQuery，您可以使用 $.get 函数 (http://api.jquery.com/jQuery.get/) 并将“xml”指定为数据类型：

$.get('http://.../', params, function(data) {
 //process data
}, 'xml');

如果没有，则需要直接使用xmlHttpRequest（来自http://www.w3schools.com/xml/xml_parser.asp）：

  if (window.XMLHttpRequest)
  {// code for IE7+, Firefox, Chrome, Opera, Safari
    xmlhttp=new XMLHttpRequest();
  }
  else
  {// code for IE6, IE5
     xmlhttp=new ActiveXObject("Microsoft.XMLHTTP");
  }
  xmlhttp.open("GET",url,false);
  xmlhttp.send();
  xmlDoc=xmlhttp.responseXML;

然后使用原生 javascript xml 解析器遍历 xml 节点相当容易。

但 JSON 会更合适。 您可以为http://localhost:8070/Contoso/Services/Items/ItemService/Items.json 添加一个路由，它将以 JSON 格式返回结果。或者也在url中添加一个参数。 仅当您明确要求时，这两种方法都将返回 JSON。所以使用 xml 响应的现有代码仍然可以正常工作。