Tutor de programação: 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: