sexta-feira, 27 de março de 2015

Web Service em C#

Depois do artigo sobre um web service em PHP segue agora um artigo sobre como implementar o mesmo serviço com o Visual Studio e .NET utilizando C#.

Começamos por criar um projeto ASP.NET com o Visual Studio 2013.





De seguida escolhemos uma aplicação vazia.

Agora adicionamos um novo item ao projeto.



Escolhemos do tipo Web Service.


Com esta opção o Visual Studio gera a estrutura básica de um Web Service.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Services;

namespace WebApplication2
{
    /// <summary>
    /// Summary description for WebService1
    /// </summary>
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    // To allow this Web Service to be called from script, using ASP.NET AJAX, uncomment the following line.
    // [System.Web.Script.Services.ScriptService]
    public class WebService1 : System.Web.Services.WebService
    {

        [WebMethod]
        public string HelloWorld()
        {
            return "Hello World";
        }
    }
}

Esta estrutura disponibiliza um método por defeito designado HelloWorld. Neste artigo vamos criar um método chamada lista que vai receber um parâmetro indicando o formato do output a ser gerado.

 [WebMethod]
        public string lista(string op)
        {
            if(op=="json"||op=="JSON")
                return devolveRegistosJSON();

            return devolveRegistosXML();
        }

Este método vai, em função do valor recebido pelo parâmetro, chamar uma função que devolve os registos em formato JSON ou em formato XML.

Começamos pelo formato JSON.

public string devolveRegistosJSON()
        {
            var jsonSerializer = new System.Web.Script.Serialization.JavaScriptSerializer();
            string registos = "";
            string strligacao = "Database=base_dados;Server=servidor;UID=utilizador;PWD=password;";
            MySqlConnection ligacao = new MySqlConnection(strligacao);
            ligacao.Open();
            string strSQL = "SELECT * FROM test_users;";
            MySqlCommand comando = new MySqlCommand(strSQL, ligacao);
            MySqlDataReader dados = comando.ExecuteReader();
            List<Registo> lDados = new List<Registo>();
            while (dados.Read())
            {
                lDados.Add(new Registo(int.Parse(dados[0].ToString()), dados[1].ToString(), dados[2].ToString()));
            }
            registos = jsonSerializer.Serialize(lDados);
            lDados.Clear();
            dados.Dispose();
            comando.Dispose();
            ligacao.Close();
            ligacao.Dispose();
            return registos;
        }

Neste caso utilizamos um serializador em formato JSON para converter os dados carregados para a lista a partir da base de dados MySQL.

Não nos podemos esquecer de adicionar a referência ao MySQL bem como a class Registo, que se apresenta a seguir:

        [Serializable]
        public class Registo
        {
            public int id { get; set; }
            public string name { get; set; }
            public string country { get; set; }
            public Registo(int id, string name, string country)
            {
                this.id = id;
                this.name = name;
                this.country = country;
            }
        }

Agora a função que devolve os dados em formato XML:

        public string devolveRegistosXML()
        {
            string registos = "";
            string strligacao = "Database=base_dados;Server=server;UID=utilizador;PWD=password;";
            MySqlConnection ligacao = new MySqlConnection(strligacao);
            ligacao.Open();
            string strSQL="SELECT * FROM test_users;";
            MySqlCommand comando = new MySqlCommand(strSQL,ligacao);
            MySqlDataReader dados = comando.ExecuteReader();
            while (dados.Read())
            {
                string registo = "";
                registo=adicionarTag("id", dados[0].ToString());
                registo += adicionarTag("name", dados[1].ToString());
                registo += adicionarTag("country", dados[2].ToString());
                registos += adicionarTag("registo", registo);
            }
            registos = adicionarTag("registos", registos);
            dados.Dispose();
            comando.Dispose();
            ligacao.Close();
            ligacao.Dispose();
            return registos;
        }

Neste caso necessitamos da função adicionarTag que é utilizada para facilitar a criação dos nós XML.

        public string adicionarTag(string tag, string texto)
        {
            string temp = "<" + tag + ">" + texto + "</" + tag + ">";
            return temp;
        }

Agora ao testar o serviço somos recebidos por uma página assim:


Ao escolher o link lista chegamos a uma página que permite invocar o método bem como definir o valor do parâmetro.

Se a opção introduzida for XML

Se a opção introduzida for JSON

O projeto

Web service em PHP

Neste artigo vamos utilizar PHP para criar um serviço web que devolve dados a partir de uma base de dados MySQL em formato XML ou JSON.

Para a consulta dos dados vamos utilizar MySQLi.

O serviço não vai requerer nenhum tipo de credênciais nem limites ao número de pedidos processados o que pode ser necessário em determinadas situações.

Começamos por definir os parâmetros para estabelecer a ligação ao servidor de base de dados.

<?php
$server="servidor";
$user="utilizador";
$password="password";
$database="base_dados";
?>


De seguida temos o código do serviço propriamente dito.

<?php

require "config.php";
//ligar à base de dados com objeto
$ligacao=new mysqli($server,$user,$password,$database);
//verificar ligação
if($ligacao->connect_error)
die("Erro na ligação: ".$ligacao->connect_error);

//parametros
if(isset($_GET['format']))
$output=$_GET['format'];
else
$output="xml"; //por defeito
if($output!='JSON'&&$output!='json'&&$output!='xml'&&$output!='XML')
$output="xml";
//dados
$sql="SELECT * FROM test_users";
$resultado=$ligacao->query($sql);
if($resultado->num_rows>0){
while($registo=$resultado->fetch_assoc())
$registos[]=array("registo"=>$registo);

header("Cache-Control: no-cache, must-revalidate");
if($output=="xml"||$output=="XML"){
$conteudo="Content-type: text/xml; charset=utf-8";
header($conteudo);
$linhas="";
$linha="";
foreach($registos as $index => $registo)
{
if(is_array($registo)){
foreach($registo as $campo => $valor){
if(is_array($valor)){
foreach($valor as $tag => $val)
$linha.=adicionarTag($tag,htmlentities($val));
}
$linha=adicionarTag("registo",$linha);
}
}
$linhas = $linhas.$linha;
$linha="";
}
echo adicionarTag("registos",$linhas);
}else{
$conteudo="Content-type: application/json; charset=utf-8";
header($conteudo);
echo json_encode(array('registos'=>$registos));
}
}
function adicionarTag($tag,$texto){
$temp="<".$tag.">".$texto."</".$tag.">";
return $temp;
}
?>



Este código pode ser picado aqui.

quinta-feira, 26 de março de 2015

Consumir um serviço web com C#

Neste artigo vamos aprender como consumir um serviço web com uma aplicação desktop criada em C#.

Um serviço web (web service) é uma API disponível através da Web que pode ser utilizada desde que se respeite as condições de uso. Em alguns casos os web services são gratuítos e não requerem nenhum registo ou credênciais, no entanto, existem outros serviços que depende de um registo e até de um pagamento.

Para demonstrar o conceito vamos utilizar um serviço oferecido pelo Banco Central Europeu disponível no seguinte link http://www.ecb.int/stats/eurofxref/eurofxref-daily.xml.
Este serviço devolve as cotações diárias de moedas em função do valor do euro. Os dados são codificados em formato XML.

O pedido dos dados não pode acontecer na thread principal do programa uma vez que isso provocaria a paragem da interface. Assim é necessário recorrer a um pedido assincrono numa thread separada da thread responsável pela atualização a interface gráfica (GUI).

O código que vai permitir consumir os dados é o seguinte:

async void downloadXML()
        {
            string url = "http://www.ecb.int/stats/eurofxref/eurofxref-daily.xml";
            WebRequest pedido = WebRequest.Create(url);
            WebResponse resposta = await pedido.GetResponseAsync();
            XDocument documento = XDocument.Load(resposta.GetResponseStream());
            textBox1.Text = documento.ToString();

            //preencher a listview
            XmlDocument xml = new XmlDocument();
            xml.LoadXml(documento.ToString());
            XmlNodeList lista = xml.GetElementsByTagName("Cube");
            foreach (XmlNode no in lista)
            {
                if (no.Attributes.Count > 1)
                {
                    ListViewItem novo = new ListViewItem(no.Attributes[0].InnerXml);
                    novo.SubItems.Add(no.Attributes[1].InnerXml);
                    listView1.Items.Add(novo);
                }
            }
        }


Trata-se de uma função assincrona que é chamada a partir de um clique num botão.
Como se pode verificar na linha de definição da função é utilizada a palavra reservada async.
Esta foi introduzida no Visual Studio 2012 e permite simplificar o trabalho de criar uma função assincrona deixando a parte mais dificil para o compilador (Ler mais sobre o assunto).
A execução corre normalmente até encontrar a linha com o termo await onde o controlo da execução é devolvido para a linha que chamou a função assincrona, não bloqueando a interface, enquanto espera que o processamento dessa linha termine para continuar até ao final da função.

O resto da função permite manipular os dados recebidos em formato XML.

Projeto