.NET

10 mar, 2008

Retornando classe de objetos em webservices

Publicidade

Olá Developers. Recentemente, lendo alguns artigos sobre webservices aqui no iMasters, percebi que a maioria dos developers ainda tem muito mais problema em lidar com a informação retornada do que com as chamadas dos webservices. O que normalmente todo mundo pensa é que o SOAP de resposta é simplesmente um XML encapsulado em um envelope o que é verdade, porém esta informação é perfeitamente capaz de se transformar em objetos dentro de suas aplicações.

Para esta matéria ter realmente sentido, precisamos inicialmente construir um webservice com os parâmetros corretos. De que adianta no “Client” a gente se matar, se no “Server-Side” o WebService foi construído de forma errada?

Uma coisa bem interessante no VS.NET é podermos serializar uma classe no webservice, após criá-la. Esta classe pode ser DataSets, Strongly Typed etc.

Requisitos para este artigo:

  • Visual Studio 2005-2008
  • .NET 2.0 ou superior
  • Prestar Atenção (riss)

Primeiro Passo: Criar seu projeto no Visual Studio

Criar um projeto qualquer, eu chamei de “IHateHelloWorld” por motivos óbvios.

Segundo Passo: Criar o WebService dentro do Projeto

[vai foto aqui[vai foto aqui][vai foto aqui]

Código Básico já criado pelo Visual Studio:

<code>
Imports System.Web
Imports System.Web.Services
Imports System.Web.Services.Protocols

&lt;System.Web.Services.WebService(Namespace:="IHateHelloWorld", Description:="WebService de exemplo para retornar objetos nos WebServices")&gt; _
&lt;WebServiceBinding(ConformsTo:=WsiProfiles.BasicProfile1_1)&gt; _
&lt;Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()&gt; _
Public Class IHateHelloWorld
    Inherits System.Web.Services.WebService

    &lt;WebMethod()&gt; _
    Public Function HelloWorld() As String
        Return "Hello World"
    End Function

End Class
</code>

Percebam que o NameSpace está diferente. O tempuri.org pode ser alterado conforme sua conveniência e adicionamos também uma “Description” para explicar do que se trata o WebService.

Terceiro Passo: Criar a Classe de Retorno

<code>
Imports System.Web
Imports System.Web.Services
Imports System.Web.Services.Protocols

''' &lt;summary&gt;
''' Classe de Retorno para o WebService
''' &lt;/summary&gt;
Public Class ResultadoDaPesquisa
    Public NroPedido As Integer
    Public Cliente As String
    Public DataPedido As DateTime
    Public TotalPedido As Double
    Public PedidoEntregue As Boolean
End Class

&lt;System.Web.Services.WebService(Namespace:="IHateHelloWorld", Description:="WebService de exemplo para retornar objetos nos WebServices")&gt; _
&lt;WebServiceBinding(ConformsTo:=WsiProfiles.BasicProfile1_1)&gt; _
&lt;Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()&gt; _
Public Class IHateHelloWorld
    Inherits System.Web.Services.WebService

    &lt;WebMethod()&gt; _
    Public Function IHateHelloWord() As ResultadoDaPesquisa
        Dim oResultado As New ResultadoDaPesquisa
        oResultado.NroPedido = 123456
        oResultado.Cliente = "Cliente de Teste"
        oResultado.DataPedido = DateTime.Now
        oResultado.TotalPedido = "1234,56"
        oResultado.PedidoEntregue = True
        Return oResultado
    End Function
End Class
</code>

Como vocês podem notar no novo código, agora temos nossa classe que vai ser populada com resultados e serializada no WebService.

Logo após temos o WebMethod que é a função a ser chamada no WebService. Ela simplesmente retorna a Classe “ResultadoDaPesquisa” populada com seus dados que podem ser extraídos de um banco de dados ou cálculos, etc.

Aperte F5 para compilar usando o Debug e pronto. Eis o resultado:

Clique na função IhateHelloWorld e voce terá a opção para invokar a mesma:

E pronto a resposta:

<code>
&lt;?xml version="1.0" encoding="utf-8" ?&gt; 
&lt;ResultadoDaPesquisa xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="IHateHelloWorld"&gt;
  &lt;NroPedido&gt;123456&lt;/NroPedido&gt; 
  &lt;Cliente&gt;Cliente de Teste&lt;/Cliente&gt; 
  &lt;DataPedido&gt;2008-03-06T09:59:32.7042787-03:00&lt;/DataPedido&gt; 
  &lt;TotalPedido&gt;123456&lt;/TotalPedido&gt; 
  &lt;PedidoEntregue&gt;true&lt;/PedidoEntregue&gt; 
  &lt;/ResultadoDaPesquisa&gt;
</code>

Percebam que nós temos agora um xmlns com o seu Namespace do Webservice e foi retornado os campos de sua classe.

Vamos agora ver como construir um “Client” para acessar essas informações:

Crie uma pagina:

Conteúdo para sua página aspx:

<code>
&lt; Page Language="VB" AutoEventWireup="false" CodeFile="IHateHelloWorldReloaded.aspx.vb" Inherits="IHateHelloWorldReloaded" &gt;

&lt;!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"&gt;

&lt;html xmlns="http://www.w3.org/1999/xhtml" &gt;
&lt;head runat="server"&gt;
    &lt;title&gt;Acessando WebService IHateHelloWorld&lt;/title&gt;
&lt;/head&gt;
&lt;body&gt;
    &lt;form id="form1" runat="server"&gt;
    &lt;div&gt;
        &lt;h3&gt;Consultando o IHateHelloWorld WebService&lt;/h3&gt;
        &lt;br /&gt;
        &lt;table border="0" cellpadding="10" cellspacing="0" style="width: 611px"&gt;
            &lt;tr&gt;
                &lt;td width="30"&gt;
                    Nro Pedido:&lt;/td&gt;
                &lt;td width="70"&gt;
                    &lt;asp:Label ID="lbl_NroPedido" runat="server"&gt;&lt;/asp:Label&gt;&lt;/td&gt;
            &lt;/tr&gt;
            &lt;tr&gt;
                &lt;td width="30"&gt;
                    Cliente:&lt;/td&gt;
                &lt;td width="70"&gt;
                    &lt;asp:Label ID="lbl_Cliente" runat="server"&gt;&lt;/asp:Label&gt;&lt;/td&gt;
            &lt;/tr&gt;
            &lt;tr&gt;
                &lt;td width="30"&gt;
                    Data do Pedido:&lt;/td&gt;
                &lt;td width="70"&gt;
                    &lt;asp:Label ID="lbl_DataPedido" runat="server"&gt;&lt;/asp:Label&gt;&lt;/td&gt;
            &lt;/tr&gt;
            &lt;tr&gt;
                &lt;td width="30"&gt;
                    Total do Pedido:&lt;/td&gt;
                &lt;td width="70"&gt;
                    &lt;asp:Label ID="lbl_TotalPedido" runat="server"&gt;&lt;/asp:Label&gt;&lt;/td&gt;
            &lt;/tr&gt;
            &lt;tr&gt;
                &lt;td width="30"&gt;
                    Pedido Entregue :&lt;/td&gt;
                &lt;td width="70"&gt;
                    &lt;asp:Label ID="lbl_PedidoEntregue" runat="server"&gt;&lt;/asp:Label&gt;&lt;/td&gt;
            &lt;/tr&gt;
            &lt;tr&gt;
                &lt;td width="30"&gt;
                &lt;/td&gt;
                &lt;td width="70"&gt;
                    &lt;asp:Button ID="btnConsultar" runat="server" Text="Consultar WebService" /&gt;&lt;/td&gt;
            &lt;/tr&gt;
        &lt;/table&gt;
    &lt;/div&gt;
    &lt;/form&gt;
&lt;/body&gt;
&lt;/html&gt;
</code>

CodeFile (CodeBehind) para a pagina:

<code>
Partial Class IHateHelloWorldReloaded
    Inherits System.Web.UI.Page

    Protected Sub btnConsultar_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles btnConsultar.Click
        Dim oWS As New IHateHelloWorld ' Instancia o WebService em um Objeto
        Dim oResposta As New ResultadoDaPesquisa ' Instancia o Objeto de Resposta


        oResposta = oWS.IHateHelloWord ' Invoka o WebService e recebe o resultado no objeto de resposta

        Me.lbl_NroPedido.Text = oResposta.NroPedido.ToString
        Me.lbl_Cliente.Text = oResposta.Cliente.ToString
        Me.lbl_DataPedido.Text = oResposta.DataPedido.ToString
        Me.lbl_TotalPedido.Text = oResposta.TotalPedido.ToString
        Me.lbl_PedidoEntregue.Text = oResposta.PedidoEntregue.ToString

    End Sub
End Class
</code>

Resultado via Web

Considerações Finais:

Lembre-se sempre que este exemplo de “Client” foi criado dentro da mesma aplicação que o WebService. Logo, na hora de adicionar a “Web Reference”, você deve procurar dentro do mesmo projeto. Quando você estiver trabalhando com projetos diferentes, o WebService deve possuir um endereço: http://www.seusite.com.br/IHateHelloWorld.asmx

Deve-se sempre entender que a maioria dos objetos em .NET podem ser serializados. Com isso temos um leque de opções de informações que podemos retornar pelos Web Services.

No próximo artigo vou publicar como retornar um DataTable vindo de uma base de dados SQL e serializá-la no webservice.

That´s all Folks!