Utilizando Web Service no acesso a dados remotos

Uma das principais funções dos smartphones e tablets hoje em dia é a conectividade com a internet. Uma das formas desta conectividade acontecer é via rede da operadora, que permite o acesso a dados de qualquer lugar em que esta esteja acessível.

A conectividade com a internet via dispositivos móveis é possível já que a velocidade das redes de comunicações está cada vez mais rápida, permitindo ficar conectado através de conexões rápidas por várias horas seguidas. Outro atrativo é o custo destes serviços de conectividade via operadora que estão cada vez mais baratos.

Para quem deseja manter-se conectado mas sem custos, uma alternativa são as conexões locais, seja via rede sem fio – wifi – ou através de conexões Bluetooth. Pode-se navegar na Internet sem passar pela rede da operadora, e consequentemente, sem custos.

Segundo um estudo realizado pela Acision, 1/3 dos acessos às redes sociais, tais como Twitter e Facebook, são realizados a partir dos dispositivos portáteis. Também aumentou consideravelmente o número de pessoas que utilizam os dispositivos portáteis para acesso a conta de e-mails, feeds de notícias, sites de compras, entre muitos outros recursos online.

A evolução dos dispositivos móveis é tão grande que hoje é possível acessar uma página na Internet a partir de um smartphone da mesma maneira que acessamos e visualizamos na tela do nosso computador. Também já é possível termos acesso a serviços de rede que até então só estavam disponíveis em computadores desktop, tais como acesso a servidores telnet, contas de FTP, terminais remotos, acesso à Web services, entre outros serviços.

Nesse artigo será apresentada a conexão de um aplicativo Android com um Web Service disponível na rede sobre condições climáticas de várias cidades do mundo. Este Web Service poderia ser desenvolvido pelo próprio usuário com funcionalidades específicas, como manipular um banco de dados.

Conectividade utilizando Web service

Web service é uma tecnologia de acesso a dados que permite a troca de informações estruturada a partir de mensagens XML e SOAP. Esta tecnologia permite que diferentes empresas, mesmo utilizando tecnologias e plataformas distintas, conectem-se de maneira padrão e executem procedimentos remotos através da utilização do protocolo padrão da internet – HTTP. Tudo isso com muita facilidade de utilização, já que muitas vezes o cliente não precisa entender o funcionamento interno dos Web Services.

O uso de Web service é muito interessante, pois se pode acessar rotinas de validação de cartão de crédito, endereçamento postal (CEP), calcular valores de fretes dos sites de comércio eletrônico, news de empresas, previsão do tempo, cotação do dólar, etc. Esta é a tecnologia ideal para disponibilizar dados que costumam mudar com o tempo.

Devido à popularização dessa abordagem, uma gama gigantesca de serviços já está pronta em algum lugar, você só precisa ir lá e acessar, de maneira rápida e fácil, aliviando o processamento na máquina cliente, já que toda a lógica de negócio fica no servidor que hospeda os serviços.

Alguns sites destacam-se por agrupar vários Web services em um só lugar. Um exemplo é o webservicex. Nesse site pode-se encontrar alguns web services interessantes, como para acesso a informações climáticas de uma cidade, previsão de tempo e informações referentes a bolsa de valores.

O Web service que será utilizado nesse artigo informa o clima de uma cidade, dado o nome da cidade e o país da mesma. Esse web service encontra-se na categoria Utilities do webservicex, possuindo o nome de GlobalWeather.

Ao clicar sobre o web service, é possível visualizar algumas informações a respeito dele como, por exemplo, o wsdl que representa o Web service e seus métodos – Figura 1. WSDL significa Web Service Descriptor Language, que nada mais é do que um documento XML que descreve o web service de uma maneira estruturada. Ele contém todas as informações essenciais para que um cliente de Web service, nesse caso, o device Android, possa entender a aplicação servidor que ele representa. Dentre suas características estão o nome dos métodos acessíveis no Web service, onde o serviço está disponibilizado (URL), a documentação para utilizá-lo, o nome e o tipo dos parâmetros dos métodos, bem como os dados de retorno.

Esse Web service será utilizado ao longo do artigo, logo, é necessário tomar nota do caminho WSLD do serviço, uma vez que este será utilizado para fazer referência ao Web service a partir do aplicativo Android. Ainda referente ao Web service, este possui dois métodos sendo o GetCitiesByCountry, o qual espera por parâmetro o nome de um país e retorna todas as cidades cadastras para este, e o GetWeather que espera por parâmetro um nome de cidade (devendo estar cadastrada no servidor) e um país, retornando as condições climáticas desta.

Desenvolvendo a interface do aplicativo Android

Para testar o uso do Web service, o primeiro passo é desenvolver um projeto Android, este com o nome Usando WebService. Para o projeto foi utilizada a versão do Android 4.0.3 (API 15). Após criado, o projeto ficou com a estrutura conforme apresentado na Figura 2.

Após a criação do projeto, é necessário desenvolver a interface gráfica do aplicativo, sendo o código apresentado na Listagem 1.

Esta interface contém dois campos EditText (linhas 13 e 24) para a digitação do nome da cidade e do país, um TextView (linha 30) para o resultado e um Button (linha 36) para realizar a pesquisa.

Como se trata de uma aplicação com acesso à rede, é importante adicionar a permissão de acesso à internet, caso contrário o aplicativo não pode ser executado. Esta permissão é dada no arquivo AndroidManifest.xml. Na categoria Permission clica-se no botão Add... escolhendo o Uses Permission android.permission.INTERNET, conforme a Figura 3.

Esta mudança adicionará a seguinte entrada no arquivo AndroidManifest.xml:

O próximo passo é modificar a classe PrincipalActivity.java para tratar os componentes visuais e o evento de botão, conforme apresentado na Listagem 2.

O código apresentado se resume a importar as classes utilizadas pelo programa (linha 03 a 08), declarar os componentes visuais (linhas 12 a 14), assim como tratar o evento de clique do botão Pesquisar (linha 27 a 29).

Desta forma, o aplicativo está pronto para receber as funcionalidades para acesso ao Web service disponibilizado pelo webservicex.

Preparando o aplicativo para acesso ao Web service

O tráfego de informações entre o aplicativo Android e o servidor onde está hospedado o Web service acontece no formato XML, sendo utilizado o padrão de comunicação SOAP para “envelopar” os pacotes na comunicação. Porém, até o fechamento deste artigo não existia um suporte nativo do Android para a comunicação via SOAP, o que faz necessária a utilização de uma API de terceiro, esta chamada de KSOAP.

Para o download do KSOAP, deve-se acessar a página do projeto conforme Figura 4, clicando na categoria download, baixando o arquivo ksoap2-android-assembly-2-2.4-jar-with-dependencies.jar.

Após baixar o arquivo, deve-se copiar o .jar para dentro da pasta lib do projeto, utilizando o gerenciador de arquivo do sistema operacional (ex. Windows Explorer). Isto garante que a biblioteca seja copiada junto com o projeto, quando este é copiado de uma máquina para outra.

Após isso, é necessário importar a biblioteca para dentro do projeto desenvolvido, clicando com o botão direito sobre o projeto, escolhendo a opção Properties, e na categoria Java Build Path, em Libraries, deve-se adicionar este arquivo .jar – Figura 5. Esta biblioteca possui arquivos importantes utilizados para a comunicação com um Web service, tais como SoapObject, SoapEnvelope, SoapSerializationEnvelope e HttpTransportSE.

Acessando Web service a partir do Android

Agora é hora de colocar o código para a comunicação com o Web service. Toda comunicação que envolva a rede deve ser realizada utilizando um Thread separada afim de evitar travamento na interface do aplicativo, uma vez que a comunicação com a rede é intermitente. A maneira tradicional de fazer isso é criar outra classe (esta pode ser uma classe interna de PrincipalActivity.java, a qual herda funcionalidades de Thread e implementa o método run(). Outra maneira de tratar multithread é implementando a interface Runnable, porém, a primeira foi adotada neste artigo.

O código completo do aplicativo, já tratando a comunicação com a rede utilizando multithread é apresentado na Listagem 3.

No código apresentado, as primeiras linhas são responsáveis por importar as classes utilizadas no aplicativo, em especial, as classes responsáveis pela comunicação com o Web service (linhas 07 a 10).

Outra diferença desta listagem em relação a Listagem 2 está na chamada da Thread que fará a comunicação com o Web service, o qual acontece no método btPesquisarOnClick() – linha 34. Neste, é instanciado um objeto do tipo ConexaoThread (linha 35), está é uma subclasse de Thread, codificada a partir da linha 40. Após a instanciação, a Thread é executada com o método start() – linha 36.

Já a classe que herda funcionalidades de Thread foi codificada na linha 40, sendo inicialmente declaradas quatro constantes importantes para o acesso ao Web service, que são:

• URL: Possui o caminho onde o Web service está hospedado;
• METHOD: Tem o nome do método que será invocado pelo Web service;
• SOAP_ACTION: Contém o caminho completo do método do Web service que será invocado;
• WSDL: Caminho do arquivo com o descritivo de todas as funções do Web service.

Uma vez declaradas as constantes, o método run() da Thread será responsável pelo acesso das informações na rede. Na linha 49 é declarado um objeto do tipo SoapObject, o qual contém informações que serão passados para o método do Web service, como os parâmetros para nome de cidade (linha 49) e país (linha 50).

Após isso, estas informações serão encapsuladas em um objeto do tipo SoapSerializationEvelope (linha 52), sendo atribuídos alguns valores, como o corpo da mensagem que será enviado ao Web service (linha 54) e se o Web service foi desenvolvido na tecnologia .net (linha 55).

Por fim, o objeto responsável pela comunicação é instanciado (linha 56), sendo a partir deste executado o método call() – linha 57, o qual invocará o Web service. A resposta pode ser obtida pelo método getResponse() – linha 58, sendo este armazenado em uma variável String.

A plataforma Android tem uma característica: somente a Thread que criou os componentes visuais de tela podem modificá-los. Neste caso, quem criou os componentes visuais foi a classe PrincipalActivity.java, porém, devemos modificar seu conteúdo na classe ConexaoThread. Isto é possível executando o método runOnUiThread() do this da classe que criou os componentes (linha 60). Assim, este método recebe uma Thread por parâmetro que no seu método run() - linha 62, altera o conteúdo do componente TextView do resultado (linha 63). O resultado visual desta execução é apresentado na Figura 6.

Utilizando a classe AsyncTask

Como apresentado anteriormente, toda a comunicação com a rede deve ser executada a partir de uma nova Thread, evitando com isso que a interface gráfica do aplicativo fique travada com a demora na resposta dos servidores.

Como apresentado no exemplo da Listagem 3, é possível a utilização de classes que implementam multithreads, como a classe Thread ou a interface Runnable, ou ainda outras classes como Timer e TimerTask, entretanto, sem dúvida, a melhor opção para este tipo de comunicação é a classe AsyncTask.

Esta classe facilita a codificação de rotinas para acessar a rede, e em especial, permite a modificação de componentes da interface gráfica sem o uso de comandos como runOnUiThread. Assim, a Listagem 4 apresenta o código de acesso a um Web service utilizando AsyncTask.

A diferença no aplicativo começa na execução do método btPesquisarOnClick() – linha 38, sendo nesta declarado um objeto do tipo ConexaoThread, que agora é uma subclasse de AsyncTask (linha 38). A diferença com relação ao código anterior é que agora precisamos passar por parâmetro uma instância da classe principal – this. Após isso, o AsyncTask é executado com o método execute() – linha 34, o qual recebe por parâmetro as informações da classe principal utilizada dentro da nova Thread. Para este exemplo são passados os campos cidade e país.

Na declaração da classe ConexaoThrad (linha 38), é informado o tipo dos parâmetros de entrada (String), do parâmetro de incremento (Integer) e do parâmetro de saída (String). Os parâmetros de entrada, para o exemplo, são os campos cidade e estados, passados na linha 34 e que são do tipo String. O parâmetro de saída é o resultado da execução da Thread, neste exemplo é uma String que será apresentada no componente TextView. O parâmetro de incremento é usado caso exista um componente de barra de progresso para mostrar o andamento da execução, por este motivo este campo deve ser inteiro.

Da mesma forma, as constantes com as informações referentes ao Web service são declaradas (linhas 40 a 43), é declarado um objeto Context com o contexto da aplicação (linha 45), sendo este valorizado no método construtor do ConexaoThread (linha 47).

Ao codificar uma subclasse de AsyncTask, quatro métodos possuem codificação obrigatória, são eles:

• onPreExecute(): Este método é executado logo no início do processamento, nele podem ser criados os componentes de barra de progresso, atribuído valores iniciais a ele, inicializadas variáveis, entre outras operações iniciais da conexão;
• doInBackGround(): Este método contém a lógica da comunicação. É nele que a rede deve ser acessada. Ele recebe os parâmetros passados na linha 34, faz o processamento e devolve o resultado da comunicação, neste exemplo, a String com a resposta enviada pelo Web service.
• onPostExecute(): Este método é responsável pela finalização da execução, apresentando o resultado do método doInBackGround() para o usuário. No nosso exemplo, o método doInBackGround retornará uma String, que é o parâmetro deste método e deve formatar o campo de resultado na tela.
• onProgressUpdate(): Neste método deve ser colocada a lógica para atualizar uma barra de progresso, por exemplo.

Uma visão geral destes quatro métodos, assim como eles se comunicam é apresentada na Figura 7.

Para o nosso exemplo, os métodos onPreExecute() – linha 52 e onProgressUpdate() – linha 76 não foram codificados. Já o método doInBackground() – linha 56 possui a lógica para comunicação com o Web service. O resultado deste processamento é retornado ao método em caso de sucesso (linha 68) ou erro (linha 71). Após o processamento, o método onPostExecute() é chamado – linha 80), apresentando o resultado do processamento no componente tvResultado.

Desta forma, o acesso à rede fica mais enxuto e elegante, existindo métodos com funções específicas, não sendo necessária a execução de comandos do tipo runOnUiThread.

Adicionando um ProgressBar ao programa

Em aplicativos que fazem uso da rede da operadora, uma boa prática de programação é apresentar, sempre que possível, um componente visual contendo as informações sobre o andamento do acesso à rede.

Isto é importante pois a maioria dos usuários de devices Android com plano de dados pagam por byte trafegado, assim, quanto maior o fluxo de dados, maior o custo de acesso. Logo, se um programa iniciar um acesso à rede e não apresentar a evolução desta conexão, após alguns segundos o usuário começa a se questionar se a comunicação não travou, e muitas vezes, interrompem o fluxo de dados.

Para minimizar este problema, uma boa técnica é o uso do componente ProgressBar, em especial, apresentando ele ao usuário através do componente ProgressDialog.

A Listagem 5 apresenta o código do programa de acesso ao Web service utilizando um componente ProgressDialog.

A diferença deste aplicativo em relação ao aplicativo anterior inicia na linha 22, quando um objeto do tipo ProgressDialog é declarado. Dentro da classe ConexaoThread, no método onPreExecute() – linha 55, o ProgressDialog é instanciado (linha 56), assim como definida a mensagem apresentada para o usuário (linha 57), sua apresentação como uma barra horizontal (linha 58), seu valor máximo (linha 59) e que o mesmo não poderá ser cancelado pelo usuário (linha 60), sendo apresentado na interface (linha 60).

Já o método onProgressUpdate() – linha 95 é a responsável pela atualização do andamento do ProgressDialog, sendo nele definido o comando para atualização (linha 96).

O valor inteiro que o método onProgressUpdate é passado através do método publishProgress(), e costuma ser executado no método doInBackground() – linha 65).

Como pode ser observado, após cada comando, um valor sequencial e crescente é passado por parâmetro no método publishProgress (linhas 68 a 85). Isso fará com que o ProgressBar seja atualizado durante o acesso ao Web service.

Ao final do processamento, no método onPostExecute(), é apresentada para o usuário apenas a informação referente ao campo Temperatura (linha 102 e 103), sendo na sequência retirado o objeto da classe ProgressDialog da tela (linha 106). O resultado da utilização do ProgressDialog é apresentado na Figura 8.

Embora alguns usuários e empresas critiquem o uso de Web service a partir de dispositivos móveis, dado a grande quantidade de dados “extras” trafegados na rede pelo uso de mensagens XML e SOAP. Este ainda é o meio mais comum de acessar dados, em especial, dados não estáticos, como cotação do dólar e informações sobre a bolsa de valores.

Ainda podemos destacar que está cada vez mais barato o acesso à internet, existindo inclusive planos onde o acesso a dados é ilimitado, o que incentiva ainda mais o uso de Web service por devices Android.

Confira também