No.js: como consumir o serviço web SOAP XML
pergunto-me qual será a melhor maneira de consumir o serviço web SOAP XML com o node.js
Obrigado!11 answers
Provavelmente vais querer usar um de:
- nó-sabão
-
sabão forte (reescrever
node-soap
) - easysoap
- Utilize uma ferramenta como o SoapUI (http://www.soapui.org ) para registar as mensagens xml de entrada e saída
- uso de solicitação de nó (https://github.com/mikeal/request) para o formulário de entrada de mensagem xml para enviar (PÓS) a solicitação para o web service (note que o javascript padrão de modelagem de mecanismos tais como ejs (http://embeddedjs.com/) ou bigode (https://github.com/janl/mustache.js) pode ajudá-lo aqui) e finalmente
- use um analisador XML para deserializar os dados de resposta aos objectos JavaScript
A maneira mais simples que encontrei para enviar XML raw para um serviço de SOAP usando o nó.js é usar o nó.implementação http js. Parece isto.
var http = require('http');
var http_options = {
hostname: 'localhost',
port: 80,
path: '/LocationOfSOAPServer/',
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
'Content-Length': xml.length
}
}
var req = http.request(http_options, (res) => {
console.log(`STATUS: ${res.statusCode}`);
console.log(`HEADERS: ${JSON.stringify(res.headers)}`);
res.setEncoding('utf8');
res.on('data', (chunk) => {
console.log(`BODY: ${chunk}`);
});
res.on('end', () => {
console.log('No more data in response.')
})
});
req.on('error', (e) => {
console.log(`problem with request: ${e.message}`);
});
// write data to request body
req.write(xml); // xml would have been set somewhere to a complete xml document in the form of a string
req.end();
Teria definido a variável xml como o XML bruto na forma de um texto.
Mas se só quiseres interagir com um serviço de sabonetes através do nó.js e fazer chamadas de sabonetes regulares, ao contrário de enviar XML raw, use um dos nós.bibliotecas js. Eu gosto de sabão de nódulos.
Consegui usar sabonete, wsdl e nó.js
Você precisa instalar sabonete com npm install soap
Crie um servidor de nó chamado server.js
que irá definir o serviço soap a ser consumido por um cliente remoto. Este serviço de sabão calcula o Índice de Massa Corporal com base no peso(kg) e altura(m).
var soap = require('soap');
var express = require('express');
var app = express();
/**
-this is remote service defined in this file, that can be accessed by clients, who will supply args
-response is returned to the calling client
-our service calculates bmi by dividing weight in kilograms by square of height in metres
**/
var service = {
BMI_Service : {
BMI_Port :{
calculateBMI:function(args){
//console.log(Date().getFullYear())
var year = new Date().getFullYear();
var n = (args.weight)/(args.height*args.height);
console.log(n);
return {bmi: n};
}
}
}
}
// xml data is extracted from wsdl file created
var xml = require('fs').readFileSync('./bmicalculator.wsdl','utf8');
//create an express server and pass it to a soap server
var server = app.listen(3030,function(){
var host = "127.0.0.1";
var port = server.address().port;
});
`soap.listen(server,'/bmicalculator',service,xml);
A seguir, crie um arquivo client.js
que irá consumir o serviço soap definido por server.js
. Este arquivo irá fornecer argumentos para o serviço soap e chamar a url com portas de serviço do SOAP e extremidade.
var express = require('express');
var soap = require('soap');
var url = "http://localhost:3030/bmicalculator?wsdl";
var args = {weight:65.7,height:1.63};
soap.createClient(url,function(err,client){
if(err)
console.error(err);
else {
client.calculateBMI(args,function(err,response){
if(err)
console.error(err);
else {
console.log(response);
res.send(response);
}
})
}
});
O seu ficheiro wsdl é um protocolo baseado em xml para a troca de dados que define como aceder a um serviço Web Remoto. Ligue para o seu ficheiro wsdlbmicalculator.wsdl
<definitions name="HelloService"
targetNamespace="http://www.examples.com/wsdl/HelloService.wsdl"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:tns="http://www.examples.com/wsdl/HelloService.wsdl"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<message name="getBMIRequest">
<part name="weight" type="xsd:float"/>
<part name="height" type="xsd:float"/>
</message>
<message name="getBMIResponse">
<part name="bmi" type="xsd:float"/>
</message>
<portType name="Hello_PortType">
<operation name="calculateBMI">
<input message="tns:getBMIRequest"/>
<output message="tns:getBMIResponse"/>
</operation>
</portType>
<binding name="Hello_Binding" type="tns:Hello_PortType">
<soap:binding style="rpc"
transport="http://schemas.xmlsoap.org/soap/http"/>
<operation name="calculateBMI">
<soap:operation soapAction="calculateBMI"/>
<input>
<soap:body
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
namespace="urn:examples:helloservice"
use="encoded"/>
</input>
<output>
<soap:body
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
namespace="urn:examples:helloservice"
use="encoded"/>
</output>
</operation>
</binding>
<service name="BMI_Service">
<documentation>WSDL File for HelloService</documentation>
<port binding="tns:Hello_Binding" name="BMI_Port">
<soap:address
location="http://localhost:3030/bmicalculator/" />
</port>
</service>
</definitions>
Espero que ajude.
Dependendo do número de endpoints de que necessita, poderá ser mais fácil fazê-lo manualmente.
Tentei 10 bibliotecas "soap nodejs" e finalmente faço-o manualmente.- usar o pedido do nó ( https://github.com/mikeal/request ) para formatar a mensagem xml de entrada para enviar (POST) o pedido para o serviço web
- utilizar xml2j (https://github.com/Leonidas-from-XIV/node-xml2js para analisar a resposta
Se node-soap
não funcionar para ti, usa node
request
módulo e, em seguida, converter o xml para json, se necessário.
- baixadoSoapUI na minha máquina Linux.
- copiou o xml do WSDL para um ficheiro local
curl http://192.168.0.28:10005/MainService/WindowsService?wsdl > wsdl_file.xml
Em SoapUI fui a[8] e carreguei o meu[9].
- em o navegador ampliou um dos serviços e clicou com o botão direito
o pedido e clicado em
Show Request Editor
.
Raw
ou HTML
para me ajudar a construir um pedido externo.
Em Bruto de SoapUI para o meu pedido
POST http://192.168.0.28:10005/MainService/WindowsService HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://Main.Service/AUserService/GetUsers"
Content-Length: 303
Host: 192.168.0.28:10005
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
XML do SoapUI
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:qtre="http://Main.Service">
<soapenv:Header/>
<soapenv:Body>
<qtre:GetUsers>
<qtre:sSearchText></qtre:sSearchText>
</qtre:GetUsers>
</soapenv:Body>
</soapenv:Envelope>
Usei o acima para construir o seguinte node
request
:
var request = require('request');
let xml =
`<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:qtre="http://Main.Service">
<soapenv:Header/>
<soapenv:Body>
<qtre:GetUsers>
<qtre:sSearchText></qtre:sSearchText>
</qtre:GetUsers>
</soapenv:Body>
</soapenv:Envelope>`
var options = {
url: 'http://192.168.0.28:10005/MainService/WindowsService?wsdl',
method: 'POST',
body: xml,
headers: {
'Content-Type':'text/xml;charset=utf-8',
'Accept-Encoding': 'gzip,deflate',
'Content-Length':xml.length,
'SOAPAction':"http://Main.Service/AUserService/GetUsers"
}
};
let callback = (error, response, body) => {
if (!error && response.statusCode == 200) {
console.log('Raw result', body);
var xml2js = require('xml2js');
var parser = new xml2js.Parser({explicitArray: false, trim: true});
parser.parseString(body, (err, result) => {
console.log('JSON result', result);
});
};
console.log('E', response.statusCode, response.statusMessage);
};
request(options, callback);
Usei com sucesso o pacote "soap" ( https://www.npmjs.com/package/soap em mais de 10 webapis de rastreamento (Tradetracker, Bbelboon, Affilinet, Webgains,...).
Os problemas geralmente vêm do fato de que os programadores não investigam muito sobre o que a API remota precisa para se conectar ou autenticar.Por exemplo, o PHP reenvia os 'cookies' dos cabeçalhos HTTP automaticamente, mas ao usar o pacote 'node', tem de ser definido explicitamente (por exemplo, por pacote "soap-cookie")...
Também pode ver o easysoap npm - https://www.npmjs.org/package/easysoap - ou-alguns destes: https://nodejsmodules.org/tags/soap
Usei o módulo de rede de nós para abrir um 'socket' no serviço web.
/* on Login request */
socket.on('login', function(credentials /* {username} {password} */){
if( !_this.netConnected ){
_this.net.connect(8081, '127.0.0.1', function() {
logger.gps('('+socket.id + ') '+credentials.username+' connected to: 127.0.0.1:8081');
_this.netConnected = true;
_this.username = credentials.username;
_this.password = credentials.password;
_this.m_RequestId = 1;
/* make SOAP Login request */
soapGps('', _this, 'login', credentials.username);
});
} else {
/* make SOAP Login request */
_this.m_RequestId = _this.m_RequestId +1;
soapGps('', _this, 'login', credentials.username);
}
});
Enviar pedidos de sabão
/* SOAP request func */
module.exports = function soapGps(xmlResponse, client, header, data) {
/* send Login request */
if(header == 'login'){
var SOAP_Headers = "POST /soap/gps/login HTTP/1.1\r\nHost: soap.example.com\r\nUser-Agent: SOAP-client/SecurityCenter3.0\r\n" +
"Content-Type: application/soap+xml; charset=\"utf-8\"";
var SOAP_Envelope= "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
"<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\" xmlns:SOAP-ENC=\"http://www.w3.org/2003/05/soap-encoding\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:n=\"http://www.example.com\"><env:Header><n:Request>" +
"Login" +
"</n:Request></env:Header><env:Body>" +
"<n:RequestLogin xmlns:n=\"http://www.example.com.com/gps/soap\">" +
"<n:Name>"+data+"</n:Name>" +
"<n:OrgID>0</n:OrgID>" +
"<n:LoginEntityType>admin</n:LoginEntityType>" +
"<n:AuthType>simple</n:AuthType>" +
"</n:RequestLogin></env:Body></env:Envelope>";
client.net.write(SOAP_Headers + "\r\nContent-Length:" + SOAP_Envelope.length.toString() + "\r\n\r\n");
client.net.write(SOAP_Envelope);
return;
}
Parse soap response, usei o módulo-xml2js
var parser = new xml2js.Parser({
normalize: true,
trim: true,
explicitArray: false
});
//client.net.setEncoding('utf8');
client.net.on('data', function(response) {
parser.parseString(response);
});
parser.addListener('end', function( xmlResponse ) {
var response = xmlResponse['env:Envelope']['env:Header']['n:Response']._;
/* handle Login response */
if (response == 'Login'){
/* make SOAP LoginContinue request */
soapGps(xmlResponse, client, '');
}
/* handle LoginContinue response */
if (response == 'LoginContinue') {
if(xmlResponse['env:Envelope']['env:Body']['n:ResponseLoginContinue']['n:ErrCode'] == "ok") {
var nTimeMsecServer = xmlResponse['env:Envelope']['env:Body']['n:ResponseLoginContinue']['n:CurrentTime'];
var nTimeMsecOur = new Date().getTime();
} else {
/* Unsuccessful login */
io.to(client.id).emit('Error', "invalid login");
client.net.destroy();
}
}
});
Espero que ajude alguém.
Adicionando a Kim .Solução de J: você pode adicionar preserveWhitespace=true
para evitar um erro de espaço em branco. Assim:
soap.CreateClient(url,preserveWhitespace=true,function(...){
Também pode usar o wsdlrdr. EasySoap é basicamente reescrever o wsdlrdr com alguns métodos extras. Tenha cuidado para que o easysoap não tenha o método getNamespace que está disponível no wsdlrdr.