最简单的SOAP示例


241

使用Javascript最简单的SOAP示例是什么?

为了尽可能有用,答案应该是:

  • 具有功能性(换句话说,实际上有效)
  • 发送至少一个可以在代码中其他位置设置的参数
  • 处理至少一个可以在代码的其他位置读取的结果值
  • 使用大多数现代浏览器版本
  • 在不使用外部库的情况下尽可能清晰明了

5
简单明了可能与不使用外部库冲突。您是否真的要编写自己的WSDL-> JS类转换器?
mikemaccana 2011年

19
我有一个问题:如果我将这个问题视为第一人,我希望它被诸如“显示一些代码,这不是'租一个编码器'”之类的注释否决。没什么私人的,托马斯:)但是我不明白社区如何决定好与坏。
最白目2012年

4
嘿,不用担心。我想问题的关键在于,有许多使用JavaScript编写SOAP客户端的方法。他们中的许多人都很丑陋,所以我希望能有一些保持清洁的想法。
Thomas Bratt

@dan是因为1.这个问题比较老,仍然有很多基本的问题要问,这在传统上有很多反对意见,2.它描述了一个相当简单的问题,所以它可能会吸引可能投票的新用户“嘿,我也想知道!”的原则 而不是“嘿,这个问题表明了研究工作。它是有用且明确的!”。由于我认为该问题没有这个问题,因此我对它投了反对票。也没什么私人的:D
phil294 '17

@ThomasBratt我可能会继续在meta上继续讨论,但是那些类型的问题值得一试。对于参考文献或知识库的下降的库来说,这是一个理想的问题。但是,也许被接受的答案也应该为额外的工作做一个诱因?还有什么比SO更能被接受的,还有什么呢?甚至SO都尝试并嘲笑建立文档站点的想法-但失败了。没有什么可以取代SO的
YoYo

Answers:


201

这是我可以创建的最简单的JavaScript SOAP客户端。

<html>
<head>
    <title>SOAP JavaScript Client Test</title>
    <script type="text/javascript">
        function soap() {
            var xmlhttp = new XMLHttpRequest();
            xmlhttp.open('POST', 'https://somesoapurl.com/', true);

            // build SOAP request
            var sr =
                '<?xml version="1.0" encoding="utf-8"?>' +
                '<soapenv:Envelope ' + 
                    'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' +
                    'xmlns:api="http://127.0.0.1/Integrics/Enswitch/API" ' +
                    'xmlns:xsd="http://www.w3.org/2001/XMLSchema" ' +
                    'xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">' +
                    '<soapenv:Body>' +
                        '<api:some_api_call soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">' +
                            '<username xsi:type="xsd:string">login_username</username>' +
                            '<password xsi:type="xsd:string">password</password>' +
                        '</api:some_api_call>' +
                    '</soapenv:Body>' +
                '</soapenv:Envelope>';

            xmlhttp.onreadystatechange = function () {
                if (xmlhttp.readyState == 4) {
                    if (xmlhttp.status == 200) {
                        alert(xmlhttp.responseText);
                        // alert('done. use firebug/console to see network response');
                    }
                }
            }
            // Send the POST request
            xmlhttp.setRequestHeader('Content-Type', 'text/xml');
            xmlhttp.send(sr);
            // send request
            // ...
        }
    </script>
</head>
<body>
    <form name="Demo" action="" method="post">
        <div>
            <input type="button" value="Soap" onclick="soap();" />
        </div>
    </form>
</body>
</html> <!-- typo -->

2
发送<soapenv:Header>怎么样?我尝试将标头标签构建到sr变量中,但是服务器收到了空的soapenv:Header
Boiler Bill

这对我有用!(将SOAP Service URL替换为真实的URL,并关闭我的浏览器的跨域限制,如@Prestaul所示)
Niko Bellic

我正在为Android / iOS开发本机脚本中的跨平台应用程序。我想使用SOAP Web服务。请同样指导我。我将以上代码用于SOAP请求&我想要SOAP响应格式,如何处理响应。请检阅我的问题- stackoverflow.com/questions/37745840/...
Onkar宁宁

最近不得不使用它来支持遗留代码。遇到缺少标头的问题,该问题在EndpointDispatcher上创建了“ ContractFilter不匹配”。xmlhttp.setRequestHeader('SOAPAction', 'http://myurl.com/action');xmlhttp.send(sr)修复之前添加。
RDRick

80

浏览器处理XMLHttpRequest的方式有很多奇怪之处,此JS代码可在所有浏览器中使用:
https //github.com/ilinsky/xmlhttprequest

此JS代码将XML转换为易于使用的JavaScript对象:http :
//www.terracoder.com/index.php/xml-objectifier

上面的JS代码可以包含在页面中,以满足您对外部库的要求。

var symbol = "MSFT"; 
var xmlhttp = new XMLHttpRequest();
xmlhttp.open("POST", "http://www.webservicex.net/stockquote.asmx?op=GetQuote",true);
xmlhttp.onreadystatechange=function() {
 if (xmlhttp.readyState == 4) {
  alert(xmlhttp.responseText);
  // http://www.terracoder.com convert XML to JSON 
  var json = XMLObjectifier.xmlToJSON(xmlhttp.responseXML);
  var result = json.Body[0].GetQuoteResponse[0].GetQuoteResult[0].Text;
  // Result text is escaped XML string, convert string to XML object then convert to JSON object
  json = XMLObjectifier.xmlToJSON(XMLObjectifier.textToXML(result));
  alert(symbol + ' Stock Quote: $' + json.Stock[0].Last[0].Text); 
 }
}
xmlhttp.setRequestHeader("SOAPAction", "http://www.webserviceX.NET/GetQuote");
xmlhttp.setRequestHeader("Content-Type", "text/xml");
var xml = '<?xml version="1.0" encoding="utf-8"?>' +
 '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ' +
                'xmlns:xsd="http://www.w3.org/2001/XMLSchema" ' +
                'xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' + 
   '<soap:Body> ' +
     '<GetQuote xmlns="http://www.webserviceX.NET/"> ' +
       '<symbol>' + symbol + '</symbol> ' +
     '</GetQuote> ' +
   '</soap:Body> ' +
 '</soap:Envelope>';
xmlhttp.send(xml);
// ...Include Google and Terracoder JS code here...

另外两个选择:


如果我想通过多个信封怎么办?
Ajay Patel

我正在使用上面的代码,但xmlhttp.responseText总是结果为null。您能为我提供一些链接来克服此错误
吗?

删除Google代码时的链接:github.com/ilinsky/xmlhttprequest
ToastyMallows,2015年

48

除非Web服务与您的页面位于同一域中,否则无法使用纯JavaScript来完成。编辑:在2008年和IE <10中,除非服务与您的页面位于同一域中,否则无法使用纯正的javascript完成。

如果Web服务在另一个域上[并且必须支持IE <10],则必须在自己的域上使用一个代理页面,该代理页面将检索结果并将其返回给您。如果不需要旧的IE支持,则需要在服务中添加CORS支持。无论哪种情况,都应该使用timyates建议的lib之类的东西,因为您不想自己解析结果。

如果Web服务位于您自己的域中,则不要使用SOAP。没有充分的理由这样做。如果Web服务在您自己的域上,则对其进行修改,以便它可以返回JSON,从而避免了处理SOAP带来的所有麻烦的麻烦。

简短的答案是:不要从javascript发出SOAP请求。使用Web服务从另一个域请求数据,如果这样做,则在服务器端解析结果,并以js友好的形式返回它们。


1
目的是让SOAP服务器还提供HTML页面,以进行简单的测试和评估。客户端将在同一域上。前端不使用SOAP似乎已被接受。有何评论?请添加到新问题:stackoverflow.com/questions/127038
Thomas Bratt

1
在那儿回答毫无意义……我在所有三点上都同意Gizmo。XML肿,而JSON简洁而本地化时,使用js处理是一项挑战。
前期

10
关于“无法完成”:今天,如果客户端支持跨域资源共享,则可以(主要)使用直接的JavaScript完成。希望在3-4年内它将普遍可用。
康斯坦丁

2
@Constantin,如果您只愿意支持较新的浏览器并且可以控制服务器,并且可以在其中添加CORS支持,则CORS将允许它。话虽这么说,我仍然会争辩说SOAP调用应该只在服务器之间进行,而客户端应该使用更像JS友好的东西,例如JSON。
Prestaul 2014年

1
基于浏览器的客户端可能使用@NikoBellic XMLHttpRequest,可能通过诸如jquery之类的库使用。节点客户端将使用其他内容。大多数Web服务都将REST用作设计其api的指南,但是有很多好的模式。这里的关键是请求/响应主体是JSON,因为javascript客户端(浏览器/节点/任意位置)本机理解JSON。
2014年

14

您可以使用jquery.soap插件为您完成工作。

该脚本使用$ .ajax发送SOAPEnvelope。它可以将XML DOM,XML字符串或JSON作为输入,并且响应也可以XML DOM,XML字符串或JSON的形式返回。

该站点的用法示例:

$.soap({
    url: 'http://my.server.com/soapservices/',
    method: 'helloWorld',

    data: {
        name: 'Remy Blom',
        msg: 'Hi!'
    },

    success: function (soapResponse) {
        // do stuff with soapResponse
        // if you want to have the response as JSON use soapResponse.toJSON();
        // or soapResponse.toString() to get XML string
        // or soapResponse.toXML() to get XML DOM
    },
    error: function (SOAPResponse) {
        // show error
    }
});

8

托马斯:

JSON优选用于前端,因为它是JavaScript。因此,您无需处理任何XML。因此,SOAP不使用库就很麻烦。有人提到SOAPClient,这是一个很好的库,我们从项目开始就使用它。但是它有一些局限性,我们不得不重写其中的大部分。它以SOAPjs的形式发布,并支持将复杂对象传递到服务器,并包括一些示例代理代码以使用来自其他域的服务。


2
“ JSON优选用于前端,因为它是JavaScript。” -JSON 不是 JavaScript。(它看起来就像JavaScript。)
nnnnnn

2
en.wikipedia.org/wiki/JSON- 从字面上讲是“ JavaScript Object Notation”,尽管我同意JSON是一种规范,而不是一种语言,因此肯定是“非javascript”,但您必须同意其命名方式可以容易使人们困惑。
罗伊(Roe Roe)

8

有人尝试过吗?https://github.com/doedje/jquery.soap

似乎很容易实现。

例:

$.soap({
url: 'http://my.server.com/soapservices/',
method: 'helloWorld',

data: {
    name: 'Remy Blom',
    msg: 'Hi!'
},

success: function (soapResponse) {
    // do stuff with soapResponse
    // if you want to have the response as JSON use soapResponse.toJSON();
    // or soapResponse.toString() to get XML string
    // or soapResponse.toXML() to get XML DOM
},
error: function (SOAPResponse) {
    // show error
}
});

将导致

<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <helloWorld>
        <name>Remy Blom</name>
        <msg>Hi!</msg>
    </helloWorld>
  </soap:Body>
</soap:Envelope>

4
<html>
 <head>
    <title>Calling Web Service from jQuery</title>
    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.3/jquery.min.js"></script>
    <script type="text/javascript">
        $(document).ready(function () {
            $("#btnCallWebService").click(function (event) {
                var wsUrl = "http://abc.com/services/soap/server1.php";
                var soapRequest ='<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">   <soap:Body> <getQuote xmlns:impl="http://abc.com/services/soap/server1.php">  <symbol>' + $("#txtName").val() + '</symbol>   </getQuote> </soap:Body></soap:Envelope>';
                               alert(soapRequest)
                $.ajax({
                    type: "POST",
                    url: wsUrl,
                    contentType: "text/xml",
                    dataType: "xml",
                    data: soapRequest,
                    success: processSuccess,
                    error: processError
                });

            });
        });

        function processSuccess(data, status, req) { alert('success');
            if (status == "success")
                $("#response").text($(req.responseXML).find("Result").text());

                alert(req.responseXML);
        }

        function processError(data, status, req) {
        alert('err'+data.state);
            //alert(req.responseText + " " + status);
        } 

    </script>
</head>
<body>
    <h3>
        Calling Web Services with jQuery/AJAX
    </h3>
    Enter your name:
    <input id="txtName" type="text" />
    <input id="btnCallWebService" value="Call web service" type="button" />
    <div id="response" ></div>
</body>
</html>

聆听带有示例的SOAP教程是最好的JavaScript。

http://www.codeproject.com/Articles/12816/JavaScript-SOAP-Client



3

使用JavaScript轻松使用SOAP Web服务 -> 清单B

function fncAddTwoIntegers(a, b)
{
    varoXmlHttp = new XMLHttpRequest();
    oXmlHttp.open("POST",
 "http://localhost/Develop.NET/Home.Develop.WebServices/SimpleService.asmx'",
 false);
    oXmlHttp.setRequestHeader("Content-Type", "text/xml");
    oXmlHttp.setRequestHeader("SOAPAction", "http://tempuri.org/AddTwoIntegers");
    oXmlHttp.send(" \
<soap:Envelope xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' \
xmlns:xsd='http://www.w3.org/2001/XMLSchema' \
 xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'> \
  <soap:Body> \
    <AddTwoIntegers xmlns='http://tempuri.org/'> \
      <IntegerOne>" + a + "</IntegerOne> \
      <IntegerTwo>" + b + "</IntegerTwo> \
    </AddTwoIntegers> \
  </soap:Body> \
</soap:Envelope> \
");
    return oXmlHttp.responseXML.selectSingleNode("//AddTwoIntegersResult").text;
}

这可能无法满足您的所有要求,但这是开始回答您的问题的开始。(我将XMLHttpRequest()切换为ActiveXObject(“ MSXML2.XMLHTTP”))。


1

最简单的示例包括:

  1. 获取用户输入。
  2. 撰写与此类似的XML SOAP消息

    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
      <soap:Body>
        <GetInfoByZIP xmlns="http://www.webserviceX.NET">
          <USZip>string</USZip>
        </GetInfoByZIP>
      </soap:Body>
    </soap:Envelope>
  3. 使用XHR将消息发布到Web服务URL

  4. 解析Web服务的XML SOAP响应与此类似

    <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema">
     <soap:Body>
      <GetInfoByZIPResponse xmlns="http://www.webserviceX.NET">
       <GetInfoByZIPResult>
        <NewDataSet xmlns="">
         <Table>
          <CITY>...</CITY>
          <STATE>...</STATE>
          <ZIP>...</ZIP>
          <AREA_CODE>...</AREA_CODE>
          <TIME_ZONE>...</TIME_ZONE>
         </Table>
        </NewDataSet>
       </GetInfoByZIPResult>
      </GetInfoByZIPResponse>
     </soap:Body>
    </soap:Envelope>
  5. 向用户展示结果。

但是,如果没有外部JavaScript库,就会遇到很多麻烦。


9
不是Javacript示例。
Thomas Bratt

甚至没有您没有回答的第一部分-发挥功能(换句话说就是切实可行)。
shahar eldad

0
function SoapQuery(){
  var namespace = "http://tempuri.org/";
  var site = "http://server.com/Service.asmx";
  var xmlhttp = new ActiveXObject("Msxml2.ServerXMLHTTP.6.0");
  xmlhttp.setOption(2,  13056 );  /* if use standard proxy */
  var args,fname =  arguments.callee.caller.toString().match(/ ([^\(]+)/)[1]; /*Имя вызвавшей ф-ции*/
  try { args =   arguments.callee.caller.arguments.callee.toString().match(/\(([^\)]+)/)[1].split(",");  
    } catch (e) { args = Array();};
  xmlhttp.open('POST',site,true);  
  var i, ret = "", q = '<?xml version="1.0" encoding="utf-8"?>'+
   '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">'+
   '<soap:Body><'+fname+ ' xmlns="'+namespace+'">';
  for (i=0;i<args.length;i++) q += "<" + args[i] + ">" + arguments.callee.caller.arguments[i] +  "</" + args[i] + ">";
  q +=   '</'+fname+'></soap:Body></soap:Envelope>';
            // Send the POST request
            xmlhttp.setRequestHeader("MessageType","CALL");
            xmlhttp.setRequestHeader("SOAPAction",namespace + fname);
            xmlhttp.setRequestHeader('Content-Type', 'text/xml');
            //WScript.Echo("Запрос XML:" + q);
            xmlhttp.send(q);
     if  (xmlhttp.waitForResponse(5000)) ret = xmlhttp.responseText;
    return ret;
  };





function GetForm(prefix,post_vars){return SoapQuery();};
function SendOrder2(guid,order,fio,phone,mail){return SoapQuery();};

function SendOrder(guid,post_vars){return SoapQuery();};

0

Angularjs $ http包装基于XMLHttpRequest。只要在标题内容集处执行以下代码即可。

"Content-Type": "text/xml; charset=utf-8"

例如:

function callSoap(){
var url = "http://www.webservicex.com/stockquote.asmx";
var soapXml = "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:web=\"http://www.webserviceX.NET/\"> "+
         "<soapenv:Header/> "+
         "<soapenv:Body> "+
         "<web:GetQuote> "+
         "<web:symbol></web:symbol> "+
         "</web:GetQuote> "+
         "</soapenv:Body> "+
         "</soapenv:Envelope> ";

    return $http({
          url: url,  
          method: "POST",  
          data: soapXml,  
          headers: {  
              "Content-Type": "text/xml; charset=utf-8"
          }  
      })
      .then(callSoapComplete)
      .catch(function(message){
         return message;
      });

    function callSoapComplete(data, status, headers, config) {
        // Convert to JSON Ojbect from xml
        // var x2js = new X2JS();
        // var str2json = x2js.xml_str2json(data.data);
        // return str2json;
        return data.data;

    }

}

0

问题是“使用Javascript最简单的SOAP示例是什么?”

这个答案只是Node.js环境中的一个示例,而不是浏览器。(将脚本命名为soap-node.js)。我们将以欧洲PMC的公共SOAP Web服务为例,获取文章的参考列表。

const XMLHttpRequest = require("xmlhttprequest").XMLHttpRequest;
const DOMParser = require('xmldom').DOMParser;

function parseXml(text) {
    let parser = new DOMParser();
    let xmlDoc = parser.parseFromString(text, "text/xml");
    Array.from(xmlDoc.getElementsByTagName("reference")).forEach(function (item) {
        console.log('Title: ', item.childNodes[3].childNodes[0].nodeValue);
    });

}

function soapRequest(url, payload) {
    let xmlhttp = new XMLHttpRequest();
    xmlhttp.open('POST', url, true);

    // build SOAP request
    xmlhttp.onreadystatechange = function () {
        if (xmlhttp.readyState == 4) {
            if (xmlhttp.status == 200) {
                parseXml(xmlhttp.responseText);
            }
        }
    }

    // Send the POST request
    xmlhttp.setRequestHeader('Content-Type', 'text/xml');
    xmlhttp.send(payload);
}

soapRequest('https://www.ebi.ac.uk/europepmc/webservices/soap', 
    `<?xml version="1.0" encoding="UTF-8"?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header />
    <S:Body>
        <ns4:getReferences xmlns:ns4="http://webservice.cdb.ebi.ac.uk/"
            xmlns:ns2="http://www.scholix.org"
            xmlns:ns3="https://www.europepmc.org/data">
            <id>C7886</id>
            <source>CTX</source>
            <offSet>0</offSet>
            <pageSize>25</pageSize>
            <email>ukpmc-phase3-wp2b---do-not-reply@europepmc.org</email>
        </ns4:getReferences>
    </S:Body>
    </S:Envelope>`);

在运行代码之前,您需要安装两个软件包:

npm install xmlhttprequest
npm install xmldom

现在您可以运行代码:

node soap-node.js

您将看到如下输出:

Title:  Perspective: Sustaining the big-data ecosystem.
Title:  Making proteomics data accessible and reusable: current state of proteomics databases and repositories.
Title:  ProteomeXchange provides globally coordinated proteomics data submission and dissemination.
Title:  Toward effective software solutions for big biology.
Title:  The NIH Big Data to Knowledge (BD2K) initiative.
Title:  Database resources of the National Center for Biotechnology Information.
Title:  Europe PMC: a full-text literature database for the life sciences and platform for innovation.
Title:  Bio-ontologies-fast and furious.
Title:  BioPortal: ontologies and integrated data resources at the click of a mouse.
Title:  PubMed related articles: a probabilistic topic-based model for content similarity.
Title:  High-Impact Articles-Citations, Downloads, and Altmetric Score.
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.