Usuario:ManuelRomero/PHP/servicioWeb/soap
De WikiEducator
< Usuario:ManuelRomero | PHP | servicioWeb
SERVICIOS WEB: FACILITANDO Y REUTILIZANDO FUNCIONALIDADES REST Y SOAP
¡El servidor te responde
Servicios web Soap y Rest
Contenido
SOAP
- Es un protocolo que indica cómo se tienen que intercambiar mensajes entre cliente y servidor
- Utiliza xml para este intercambio
- SOAP se acompaña de un lenguaje llamada WSDL, usado para describir y publicar las funciones que el servicio ofrece a sus clientes.
- A continuación vamos a entender y profundizar en las diferentes partes de un fichero xml de soap para poder entenderlo
Fichero xml que soap crea para el intercambio
Un mensaje SOAP viaja en un fichero xml con la siguiente estructura
- Elemento principal o Envelope o elemento raiź que identifica el mensaje
- cabecera o header opcional. se componen de uno o varios header blocks; cada uno de ellos detalla como se debe procesar el mensaje
- body : Es una parte obligatoria, y contiene la información relativa a la llamada y la respuesta.
En el elemento Envelope se especifica la versión de soap
- En la version 1.1
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
- En la versión 1.2
<soap:Envelope xmlns:soap=http://www.w3.org/2003/05/soap-envelope/" http://www.w3.org/2003/05/soap-encoding/">
La gestión de este fichero, tanto el hecho de crearlo para responder a una solicitud como la tarea de leerlo e interpretarlo, sería un labor tediosa. Existen librerías en los diferentes lenguajes de programación que automatizan este proceso. Para php vamos a ver PHP5 SOAP, disponible a partir de la versión 5
PHP5 SOAP es la implementación de SOAP que se incluye con PHP a partir de la versión 5 del lenguaje. En versiones anteriores se tenía que recurrir a otras opciones para trabajar con SOAP. Es una extensión nativa (escrita en lenguaje C) y por tanto más rápida que otras posibilidades (NuSOAP -http://code.google.com/p/nusoap-for-php5/- o PEAR::SOAP --). Como veremos más adelante, su gran inconveniente es que no permite la generación automática del documento WSDL una vez programado el servidor SOAP correspondiente.
Describir un servicio
- Consiste es publicar qué funciones ofrece mi servicio web, así como qué parámetros necesita y que valor/es retorna dicha función.
- Este paso es importante sobre todo si no es la personas que ha desarrollado el servicio la única que va a utilizarlo.
- En SOAP esto se hace usando el leguaje de descrición WSDL (Lenguaje de Descripción de Servicios Web).
WSDL es un lenguaje basado en xml que utiliza unas reglas determinadas para generar el documento de descripción de un servicio web.
- Una vez generado, ese documento se suele poner a disposición de los posibles usuarios del servicio (normalmente se accede al documento WSDL añadiendo ?wsdl a la URL del servicio).
- En la siguiente imagen podemos ver las diferentes partes de un fichero xml wsdl.
- Podemos observar como cambia según estemos en la version 1.1 o la versión 2.
- types y message
- En la versión 2 solo existe el elemento types
- Describe las definiciones de tipos de datos que se usan en el servicio, como lista de parámetros que recibe una función o los valores que retorna
- portType o interfaces
Cada uno de estos elementos es cada una de las funciones que el servicio ofrece Cada función se define es una operation con sus input y output como podemos ver en la imagen
- binding
- Define como va a transmitirse la información de cada portType
- service
- Contiene una lista de las diferentes url (1 o varias) en donde se puede acceder al servicio web
- Definir, construir e interpretar el contenido de un fichero wsdl, puede ser de nuevo una tarea de gran calibre
- En lugar de hacerlo, usaremos herramientas que nos construyan este fichero como vamos a ver a continuación
PHP SOAP
- Pasa implementar un servicio web vamos a usar esta exténsión nativa de php.
- Primero verificamos que la tenemos instalada
- Ejecutamos un phpinfo() y buscamos la sección de soap
- Esta extensión nos permite usar dos clases importantes SoapClient (para comunicarnos con un servicio web) y SoapServer (para crear un propio servicio web).
Usando un servicio web
| usar un servicio web de webservicex para la conversión de dólares a euros
|
- Vamos a usar un servicio web mediante el protocolo o estándar SOAP.
- Suponemos que queremos tener de forma actualizada la conversión de euros a doláres y viceversa.
- En lugar de hacerlo a mano queremos una actualización en el momento de calcular un precio, y para ello vamos a usar un servicio disponible en WebSeviceX.net (http://www.webservicex.net/ws/default.aspx).
- En la página podemos ver varios servicios, usaremos el de Currency Convertor (http://www.webservicex.net/ws/WSDetails.aspx?CATID=2&WSID=10).
- Dentro de la página localizamos el fichero descriptor wsdl del servicio
http://www.webservicex.net/CurrencyConvertor.asmx?WSDL
- A partir de este fichero podemos deducir la siguiente información:
- 1.- El alias del espacio de nombres correspondiente al XML Schema que utiliza el documento ess
<wsdl:definitions ... xmlns:s="http://www.w3.org/2001/XMLSchema" ... >
- 2.-El tipo Currency debe ser un string de tres caracteres de los que se listan en el documento, correspondiente a las siglas de una divisa.
<s:simpleType name="Currency"> <s:restriction base="s:string"> <s:enumeration value="AFA" /> … </s:restriction> </s:simpleType> ;3.-El tipo ConversionRate es una secuencia de dos elementos Currency. <source lang=xml> <s:element name="ConversionRate"> <s:complexType> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="FromCurrency" type="tns:Currency" /> <s:element name="ToCurrency" type="tns:Currency" /> </s:sequence> </s:complexType> </s:element> ;3.-El tipo ConversionRateResponse es un double. <source lang=xml> <s:element name="ConversionRateResponse"> <s:complexType> <s:sequence> <s:element minOccurs="1" maxOccurs="1" name="ConversionRateResult" type="s:double" /> </s:sequence> </s:complexType> </s:element>
- En resumen tenemos la siguiente información
funcion : ConversionRate
parámetros : array ("FromCurrency" =>"XXX", "ToCurrenci"=>"XXX");
valor que retorna : ConversionRateResult que es un float
Escribiendo el código
- Ahora vamos a escribir el código php para usar este servicio
- Primero creamos un objeto de la clase SoapClient
- El objeto de la clase SoapClient, necesita en el constructor la ubiación del fichero wsdl
(Luego veremos que también puede ser valor null, y especificarlo posteriormente
$cliente = new SoapClient( "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL");
- Ahora a continuación vamos a realizar la llamada a la función de conversión que ofrece este servicio
- La función se llama ConversionRate como podemos ver en el elemento descrito anteriormente. Esta funcion recibe como parámetro un array asociativo con dos valores
- En este calso queremos pasar de Euros a Dólares
$parametros = array("FromCurrency" => "EUR", "ToCurrency" => "USD"); $tasa = $cliente->ConversionRate($parametros);
- Y ahora solo queda capturar el resultado y visualizarlo
print("Resultado: ".$tasa->ConversionRateResult);
Utilizar el servicio sin el fichero wsdl
- Es posible no utilizar el fichero wsdl, por que no exista o por que no conocemos su ubicación
- En el segundo caso, si no indicas en el constructor un documento WSDL (bien porque no existe, o porque necesitas configurar manualmente alguna opción), el primer parámetro debe ser null, y las opciones para comunicarse con el servicio las tendrás que establecer en un array que se pasa como segundo parámetro.
- Si el fichero wsdl existe puedes usar una herramienta (hay varias), que te conviertan el fichero wsdl a php e incluirlo en tu fichero php
- En este caso vamos a usar la herramienta wsdl2php http://www.urdalen.no/wsdl2php/index.php
- Descargamos el fichero http://sourceforge.net/projects/wsdl2php/files/latest/download
- Una vez descargado el fichero lo instalamos en línea de comandos
sudo pear install wsdl2php-0.2.1-pear.tgz
- Y ahora con la ubicación del fichero wsdl generamos el php
wsdl2php http://www.webservicex.net/CurrencyConvertor.asmx?WSDL
- Analiza y genera el fichero php que podemos ver con información clara y completa
Realizamos una aplicación que pueda covertir una cantidad de un tipo de moneda en otra según seleccionemos con un combo box o campo de tipo select
|
<!DOCTYPE html>
<html>
<head>
<title>conversion de monedas</title>
<meta charset="UTF-8">
<meta name="viewport"content="width=device-width, initial-scale=1.0">
</head>
<body>
<form action=""method ="POST">
Importe en euros <input type="text"name="euros">
selecciona importe destino
<select name="moneda"id="">
<option value ="ALL">Afghanistan Afghani</option>
......
</select>
<input type="submit"name ="enviar"/>
</form>
</body>
</html>
<?php
if ($_POST['enviar']){
$cliente = new SoapClient("http://www.webservicex.net/CurrencyConvertor.asmx?WSDL");
$parametros = array("FromCurrency"=> "EUR", "ToCurrency"=> $_POST['moneda']);
$tasa = $cliente->ConversionRate($parametros);
// $tasa es un objeto de una clase predefinida en PHP llamada StdClass. Para utilizar el valor devuelto, puedes hacer:
$cantidad = $_POST['euros'];
print("Resultado: $cantidad=".($cantidad* $tasa->ConversionRateResult));
}
?>
<?php require_once("./CurrencyConvertor.php"); //Creamos un objeto de la clase $cliente = new CurrencyConvertor(); //Ahora para los parámetros $p=new ConversionRate(); $p->FromCurrency="EUR"; $p->ToCurrency="USD"; //Ahora invocamos el método de convertir $r=$cliente->ConversionRate($p); print_r ("Valor de un euro:". $r->ConversionRateResult); ?>
|
(
: Tras ejecutar wsdl2php pasándole como parámetro la URL http://www.webservicex.com/globalweather.asmx?wsdl, correspondiente al documento WSDL del servicio web, obtendrás un fichero GlobalWeather.php con las clases correspondientes al servicio. Para ejecutar la consulta al servicio y mostrar la información que se pide, puedes ejecutar un código como el que se propone en la solución al ejercicio.)
<?php require_once('GlobalWeather.php'); //Creamos un cliente para llamar a esa URL. $tiempo = new GlobalWeather(); //Llamamos a la operación suma (tenemos que saber nosotros que existe) $pais = new GetCitiesByCountry(); $pais->CountryName="SPAIN"; $ciudades = $tiempo->GetCitiesByCountry($pais); print_r($ciudades); $ciudad = new GetWeather(); $ciudad->CountryName="SPAIN"; $ciudad->CityName = "Santiago / Labacolla"; $tiempociudad = $tiempo->GetWeather($ciudad); print_r($tiempociudad); ?>
Implementado un servicio SOAP
- Ahora vamos a crear un servicio para utilizarlo y ofrecerlo a terceros
- Para crear un servicio web, usaremos la clase ServerSoap, que podemos ver en la imagen siguiente:
- Para ello vamos a crear el servicio y luego consumirlo.
- En este caso como conocemos las funciones que el servicio ofrece, no necesitamos usar ningún fichero de descripción wsdl
- Los pasos a seguir para este cometido son sencillos
- Creamos las funciones dque queremos que nuestro servicio ofrezca
- Creamos el objeto soapServer
- Añadimos las funciones al objeto ServerSoap creado previamente
- Creamos las funciones
function sumar($n1, $n2){ return $n1+$n2; } function restar($n1, $n2){ return $n1+$n2; }
- Creando el objeto
- Para ello debemos establecer el uri del servicio
- El objeto constructor tiene dos poarámetros
- $ficheroWsdl es el fichero que especifica las funciones que ofrece el servicio. En nuestro caso especificaremos null, pues no vamos a usar ningún fichero
- array asociativo con diferentes posibles valores (ver documentacion http://php.net/manual/es/soapserver.soapserver.php). Nosotros aquí especificaremos la uri
$uri ="localhost/CreandoServicioWeb"; $servidor = new SoapServer(null, array('uri'=>$uri));
- Añadiendo las funciones que nuestro servicio web ofrece
- Ahora solo nos queda añadir las funciones que queremos ofrecer
- Para ello usamos el método addFunction(..) de la clase SoapServer
$servidor->addFunction("sumar"); $servidor->addFunction("restar"); $servidor->handle();
- Vemos como al final activamos nuestro servicio con el método manejador o handle
- Consumiendo el servicio
- Ahora solo nos queda consumir el servicio igual que hicimos en el ejemplo del apartado anterior
- Se escribe otro proyecto con el siguiente código, comentarios en el própio código
<?php //Como no vamos a especificar wsdl, debemos detallar el url donde vamos a consumir el servicio $url="http://localhost/CreandoServicioWeb/index.php"; $uri="http://localhost/CreandoServicioWeb/"; //Creamos el cliente con el segundo parámetro. El primero null $cliente = new SoapClient(null, array('location'=>$url, 'uri'=>$uri)); $numero = $cliente->sumar(5,4); echo "valor de la suma ".$numero."<br/>"; $numero = $cliente->restar(5,4); echo "valor de la resta ".$resta; ?>
| Probar a usar el servicio del compañero y ver que funciona
|
- Ahora podemos probar a usar nuestra las operaciones de nuestra calculadora racional como un servicio web.
- La idea es que cualquiera pueda hacer operaciones del tipo
(a/b op c/d). (op = +|-|*|:)
Usando nuestra clase Racional, con el código que facilito, probar a ofrecer el servicio siguiente.
sumar ("5/4", "4/5")
sumar ("5/4", 4)
sumar ("4/5", null)
sumar (3, 4)
.....
Igualmente que antes una vez que funciones probamos a que funciones con la compañera/o
|
<?php /** * Description of racional * * @author manolo */ class racional { //put your code here private $numRacional; private $num; private $den; public function __construct($cadenaOrNum=null, $den = null) { if (is_int($cadenaOrNum)){ if (isset($den)) $this->racionalNumDen($cadenaOrNum, $den ); else $this->racionalNum($cadenaOrNum ); } else{ if (isset($cadenaOrNum)) $this->racionalCadena($cadenaOrNum); else $this->racionalVacio(); } } private function racionalNumDen($num, $den){ $this->numRacional=$num."/".$den; $this->num=$num; $this->den=$den; $this->convierteNum(); } public function getRacional (){ return $this->numRacional; } private function racionalNum($num){ $this->numRacional=$num."/1"; $this->num=$num; $this->den=1; $this->convierteNum(); } private function racionalCadena($cadenaOrNum){ $this->numRacional=$cadenaOrNum; $pos = strpos($cadenaOrNum,"/"); $num=substr($cadenaOrNum,0,$pos); $den=substr($cadenaOrNum,$pos+1); $this->num=$num; $this->den=$den; } private function racionalVacio(){ $this->numRacional="1/1"; $this->num=1; $this->den=1; } private function convierteNum(){ settype($this->num, int); settype($this->den, int); } public static function sumar(racional $op1, racional $op2){ $num = new Racional($op1->num*$op2->den+$op1->den*$op2->num , $op1->cden*$op2->den); return $num; } }
- Con las siguientes llamadas en cliente
//.... $n1="5/4"; $n2="4/3"; $numero = $cliente->sumar($n1,$n2); echo "valor de la suma $n1 + $n2 = ".$numero."<br/>"; $n1="5/4"; $n2=5; $numero = $cliente->sumar($n1,$n2); echo "valor de la suma $n1 + $n2 = ".$numero."<br/>"; $n1=5; $n2=4; $numero = $cliente->sumar($n1,$n2); echo "valor de la suma $n1 + $n2 = ".$numero."<br/>"; //...
- Se generará la siguiente salida
valor de la suma 5/4 + 4/3 = 31/12 valor de la suma 5/4 + 5 = 25/4 valor de la suma 5 + 4 = 9/1 valor de la suma + 3 = 4/1 valor de la resta 9
- Opcionalmente mejoralo haciendo que en cliente tenga dos cajas de texto para sumandos y una para resultado.
Creación de un servicio web con fichero wsdl
- Ahora crearemos un servicio web publicando nuestras funciones de nuestro servicio a través del fichero descriptor del servicio wsdl
- En dos apartados anteriores estudiamos como era el contenido y la estructura de este documento.
- Para el nivel en el que vamos a profundizar, usaremos herramientas para su construcción, pues su conocimiento puede resultar un poco tedioso, aunque si nos dedicáramos a construir servicios con esta tecnología seguro que lo aprenderíamos y sacaríamos buen rendimiento a dichos conocimientos.
- En cualquier caso, como veremos a continuación siempre conviene revisar el resultado del fichero wsdl generado de forma automática por algún tipo de software
- Primero debemos actualizar en el fichero php.ini la dierectiva soap.wsdl_cache_enabled = 0 si la teníamos a 1. Esto es para que los cambios que hagamos en el fichero wsdl tengan efectos inmediatos. No olvides rebotar el servicio para que la modificación tenga efecto.
|
Creando las funciones a compartir
- A la hora de implementar las funciones que se quieren compartir en el servicio web, se recomienda crear una clase, e incorporar como métodos las funciones a compartir.
- En el ejemplo básico del caso anterior, que queríamos compartir sumar y restar procederíamos del siguiente modo
class Calcula { public function suma($a, $b){ return $a+$b; } public function resta($a, $b){ return $a-$b; } }
- Ahora para añadir la clase en lugar de addFunction(...), usaríamos setClase(...)
require_once('Calcula.php'); $uri = ...; $server = new SoapServer(null, array('uri'=>$uri)); $server->setClass('Calcula'); $server->handle();
|
El método setClass recibe como parámetro el nombre de la clase, no el nombre del fichero que implementa la clase $cliente->setClass('Calcula') y no $cliente->setClass('Calcula.php')
|
Generando el fichero wsdl
- Para este cometido vamos a usar una herramienta que automatiza el proceso
- Como hemos comentado anteriormente conviene revisar el fichero generado
- La herramienta se llama wsdlDocument
https://code.google.com/p/wsdldocument/
- Primero procedemos a descargarla
- Al darle a descagar, se descarga un fichero zip
- Este fichero debemos descomprimirlo donde tengamos el proyecto que queramos usar
- Posteriormente en el fichero del servidor incluiremos la clase WSDLDocumet.php
require_once ('./WSDLDocument/WSDLDocument.php'); .... //Generamos un objeto de la clase $wsdl = new WSDLDocument( "MyClass" ); //Hacemos que nos genere el fichero wsdl en formato xml echo $wsdl->saveXml();
- Para construir el fichero debemos comentar cada funcion y parámetro que queremos ofrecer en nuestro servidor
- Para ello debemos usar el formato PHPDocumentor que es muy parecido al de javaDoc.
- Aquí tenemos una referencia
http://www.phpdoc.org/
- PHPDocumentor es una herramienta de código libre para generación automática de documentación, similar a Javadoc (para el lenguaje Java). Si comentamos el código de nuestras aplicaciones siguiendo unas normas, PHPDocumentor es capaz de generar, a partir de los comentarios que introduzcamos en el código mientras programamos, documentación en diversos formatos (HTML, PDF, XML).
- Los comentarios se deben ir introduciendo en el código distribuidos en bloques, y utilizando ciertas marcas específicas como @param para indicar un parámetro y @return para indicar el valor devuelto por una función. Por ejemplo, la clase Calcula del ejemplo que nos ocupa nos quedaría:
/** * Clase Calcula * * Desarrollo Web en Entorno Servidor * Ejemplo: Documentación para generación * automática del documento WSDL */ class Calcula { /** * Suma dos números y devuelve el resultado * * @param float $a * @param float $b * @return float */ public function suma($a, $b){ return $a+$b; } /** * Resta dos números y devuelve el resultado * * @param float $a * @param float $b * @return float */ public function resta($a, $b){ return $a-$b; } }
- Ahora nos queda generar el fichero wsdl.
- Para ello en el fichero donde creemos el objeto del servicio SoapServer', creamos también un objeto de la clase WSDLDocument e indicamos los siguientes documentos:
- El nombre de la clase que gestionará las peticiones al servicio.
- La URL en que se ofrece el servicio.
- El espacio de nombres destino.
- El código queda como a continuación se expone:
<?php require_once './WSDLDocument/WSDLDocument.php'; require_once 'Calcula.php'; $wsdl = new WSDLDocument( "Calcula", "http://localhost/servicioWeb2/index.php", "http://localhostg/servicioWeb2/"); echo $wsdl->saveXml(); ?>
- Una vez que ejecutamos, capturamos la salida de la pantalla y la pegamos en un fichero (Crtl-u para ver el código de la página web)
- Ese es nuestro contenido del fichero wsdl lo copiamos y lo pegamos en un fichero con formato xml
- En nuestro caso vemos el código que se genera
<?xml version="1.0" encoding="utf-8"?> <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap-enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:soap-env="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://localhostg/servicioWeb2/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://localhostg/servicioWeb2/"> <wsdl:types> <xsd:schema targetNamespace="http://localhostg/servicioWeb2/"/> </wsdl:types> <wsdl:message name="sumaRequest"> <wsdl:part name="a" type="xsd:float"/> <wsdl:part name="b" type="xsd:float"/> </wsdl:message> <wsdl:message name="sumaResponse"> <wsdl:part name="sumaReturn" type="xsd:float"/> </wsdl:message> <wsdl:message name="restaRequest"> <wsdl:part name="a" type="xsd:float"/> <wsdl:part name="b" type="xsd:float"/> </wsdl:message> <wsdl:message name="restaResponse"> <wsdl:part name="restaReturn" type="xsd:float"/> </wsdl:message> <wsdl:portType name="CalculaPortType"> <wsdl:operation name="suma"> <wsdl:documentation>Suma dos números y devuelve el resultado</wsdl:documentation> <wsdl:input message="tns:sumaRequest"/> <wsdl:output message="tns:sumaResponse"/> </wsdl:operation> <wsdl:operation name="resta"> <wsdl:documentation>Resta dos números y devuelve el resultado</wsdl:documentation> <wsdl:input message="tns:restaRequest"/> <wsdl:output message="tns:restaResponse"/> </wsdl:operation> </wsdl:portType> <wsdl:binding name="CalculaBinding" type="tns:CalculaPortType"> <soap-env:binding xmlns="http://schemas.xmlsoap.org/wsdl/soap/" style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/> <wsdl:operation name="suma"> <soap-env:operation xmlns="http://schemas.xmlsoap.org/wsdl/soap/" soapAction="http://localhost/servicioWeb2/index.php?method=suma" style="rpc"/> <wsdl:input> <soap-env:body xmlns="http://schemas.xmlsoap.org/wsdl/soap/" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/> </wsdl:input> <wsdl:output> <soap-env:body xmlns="http://schemas.xmlsoap.org/wsdl/soap/" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/> </wsdl:output> </wsdl:operation> <wsdl:operation name="resta"> <soap-env:operation xmlns="http://schemas.xmlsoap.org/wsdl/soap/" soapAction="http://localhost/servicioWeb2/index.php?method=resta" style="rpc"/> <wsdl:input> <soap-env:body xmlns="http://schemas.xmlsoap.org/wsdl/soap/" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/> </wsdl:input> <wsdl:output> <soap-env:body xmlns="http://schemas.xmlsoap.org/wsdl/soap/" use="encoded" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="Calcula"> <wsdl:documentation>Clase Calcula Desarrollo Web en Entorno Servidor Ejemplo: Documentación para generación automática del documento WSDL</wsdl:documentation> <wsdl:port name="CalculaPort" binding="tns:CalculaBinding"> <soap-env:address location="http://localhost/servicioWeb2/index.php"/> </wsdl:port> </wsdl:service> </wsdl:definitions>
|
|
