SQL Server Compact Edition: Criando um framework para acesso a dados em dispositivos m�veis

Introduç�o

Converg�ncia e Mobilidade. A� est�o duas palavras que vem se tornando o foco do mercado de tecnologia no Brasil e no mundo. Basta ver os n�meros. Segundo o IDC(IDC's Enterprise Mobility & Convergence S�o Paulo) 70% de um universo de 90 empresas pretendem contratar uma integradora de soluç�es m�veis em 2008. O presidente da Acel (Associaç�o Nacional das Operadoras de Celular), �rcio Zilli, recentemente disse que, no pr�ximo ano, o crescimento da telefonia m�vel dever� ser entre 10% e 12%. Estamos realmente entrando na quinta era da computaç�o, onde, os antes poderosos e solit�rios desktops, começam a se integrar, formando complexas e robustas estruturas de informaç�o distribu�da com pontos m�veis.

As pessoas, hoje, perdem pouco a pouco a id�ia do �computador de mesa�, ao passo que as sociedades virtuais juntamente com a grande enciclop�dia INTERNET, começam a se tornar uma realidade estabelecida. E para a integraç�o dos indiv�duos e seus respectivos personagens neste novo mundo rpg�stico, � necess�rio que os aparelhos m�veis sejam utilizados. Fator como este, transforma o mercado de desenvolvimento em um grande funil que converge para o projeto de software m�vel. Como no in�cio da hist�ria da engenharia da computaç�o, � cobrado agora do desenvolvedor de sistemas o skill criatividade. Pouco espaço, pouca mem�ria, muita objetividade, muita versatilidade.

Neste contexto, o presente artigo apresenta um tutorial que ensina passo-a-passo, como construir um framework para acesso a dados na vers�o compacta e m�vel do Microsoft SQL Server. O SQL Server Compact Edition � um SGBD suportado pelos sistemas operacionais da linha Windows Mobile. Este banco de dados oferece muitos recursos, do ponto de vista de ser m�vel. Permite a criaç�o e manipulaç�o de dados em bases atrav�s de uma simples interface. Nele, podem-se criar tabelas, inserir registros, inserir colunas, definir chaves prim�rias, auto-incremento, transaç�es e campos dos mais variados tipos, incluindo imagens e bin�rios. Suporta consultas do tipo SQL e disp�e de at� dois gigabytes de espaço para armazenamento. Vamos acompanhar nas pr�ximas seç�es como implementar esse sistema em nossos projetos e como utiliza-lo atrav�s de uma camada de acesso.

Uma camada para acesso a dados

Nosso framework de acesso vai trabalhar numa camada separada do projeto (Figura 1). Vamos definir toda a l�gica que corresponde a manipulaç�o de dados dentro de uma classe separada. No final do projeto, essa classe vai ser compilada e um arquivo de extens�o DLL ser� gerado. Este arquivo pode ser reutilizado sempre que necess�rio em outros projetos. A classe, por sua vez, pode ser expandida, suportando um maior n�mero de bancos de dados. Empregaremos assim, os alicerces de encapsulamento e abstraç�o que a Programaç�o Orientada a Objetos disp�e.

Figura 1 - Camadas envolvidas no projeto

Nesta classe ser�o definidos m�todos que acessam o banco de dados para retornar informaç�es ou modifica-las. Criaremos ainda alguns m�todos mais espec�ficos como os que criam base de dados em tempo de execuç�o e os que trabalham com transaç�es. Bem, ent�o vamos por a m�o na massa...

Iniciando o projeto

Para a construç�o do nosso projeto utilizaremos o Visual Studio 2005 e a linguagem VB.NET 2005 num projeto de Windows Mobile 5.0 Pocket PC Application. Para isso, abra o VS2005, v� ao menu File>New Project. Quando a janela New Project for apresentada, escolha na �rvore de projetos a opç�o Visual Basic Projects>Smart Device>Windows Mobile 5.0 Pocket PC. Em seguida nos tipos de projeto apresentados selecione Device Application e d� o nome de AcessoDados. Clique em OK para confirmar.

Nota: O Windows Mobile 5.0 Pocket PC � um SDK de desenvolvimento que n�o vem por padr�o na instalaç�o do Visual Studio 2005, para baix�-lo acesse microsoft.com/download. Esse artigo pode ser desenvolvido normalmente em qualquer outro tipo de projeto m�vel sem preju�zos.

Feito isso, abra a janela Solution Explorer e clique com o bot�o direito do mouse sobre o nome do projeto, v� agora ao menu Add>New Item. Na janela que ser� apresentada, escolha a opç�o Class Diagram. D� ao arquivo o nome de dgAcessoDados.cd. Esse arquivo especifica um diagrama de classes, que pode ser constru�do visualmente. Ou seja, utilizaremos o Visual Studio como ferramenta CASE, elaborando o projeto do framework inicialmente atrav�s de um diagrama. Na seq��ncia o Visual Studio criar� automaticamente a classe, seus m�todos e propriedades e adicionar� a mesma ao nosso projeto.

Assim que o arquivo de diagrama for adicionado ele ser� automaticamente aberto. No centro da tela, aparecer� a opç�o de visualizar a janela ToolBox. Clicando sobre essa opç�o, vemos que v�rios componentes s�o dispostos. Estes componentes podem ser utilizados para construir dos mais simples aos mais complexos diagramas de classes, dentre estes temos:

Class: Corresponde a uma classe. Nesta poderemos, visualmente, adicionar m�todos, campos e propriedades.
Enum: Define um tipo enumerado para ser utilizado no restante do projeto.
Interface: De modo visual pode-se criar um molde para as classes que herdarem deste componente.
Abstract Class: Com este componente, que na pr�tica n�o pode ser instanciado, pode-se definir m�todos, campos e propriedades que sempre ser�o herdados em classes filhas.
Module: Cria um arquivo modular similar ao dispon�vel no antigo Visual Basic 6. Usualmente utilizado para declarar classes e m�todos p�blicos.
Inheritance: Com este componente em forma de seta selecionado clique sobre uma classe a ser definida com pai, e sequentemente, na classe a ser definida como filha. Feito isso, um relacionamento de herança entre elas ser� criado automaticamente.

Figura 2 - Componente Class

Continuando nosso projeto, arraste para a tela, um componente Class que se encontra na aba Class Designer (Figura 2). Quando fizer isso, uma janela aparecer� para que voc� indique algumas informaç�es sobre a classe. Configure esta janela como na Figura 3 e clique em OK.

Figura 3 - Janela New Class

Executado esse procedimento, um diagrama representando uma classe ser� automaticamente adicionado na tela. � neste diagrama que vamos adicionar os m�todos que constituir�o nosso framework. Abra a janela Solution Explorer e repare que o arquivo de classe j� foi criado, verificando o seu conte�do podemos perceber que toda a estrutura de c�digo tamb�m j� foi adicionada pelo Visual Studio, no entanto, por enquanto n�o precisamos nos preocupar com o c�digo, ou com quais bibliotecas iremos utilizar, estamos na fase de projeto.

M�todos de Conex�o

Nossa camada de acesso vai interagir com o SQL Server Compact Edition de diversas formas. Precisaremos selecionar, apagar, inserir e alterar informaç�es. Assim, com base nos objetos do ADO.NET 2.0 vamos definir os m�todos a serem disponibilizados pela classe. Criaremos ent�o o arquivo de classe passo-a-passo, iniciando com os m�todos a seguir:

AbreConexao(): M�todo que conecta ao banco de dados m�vel.
FechaConexao(): M�todo que desconecta a aplicaç�o do banco de dados.
CriaBD(nomeBD As String): Cria um banco de dados num path desejado.

Para adicionar um m�todo no visual da classe, selecione o diagrama, clique com o bot�o direito sobre ele e v� ao menu Add>Method(). Quando o m�todo for adicionado, defina o nome dele como AbreConexao e pressione ENTER. Repita esse passo, para os m�todos FechaConexao e CriaBD. V� ao c�digo da classe e repare que os m�todos j� foram criados automaticamente.

Para que seja poss�vel utilizar o banco de dados SQL Server Compact Edition, precisa-se adicionar uma refer�ncia a sua biblioteca. Para isso, clique com o bot�o direito sobre o nome do seu projeto na Solution Explorer, e v� ao menu Add Reference. Na aba .NET, encontre e selecione o namespace System.Data.SqlServerCe (Figura 4). Feito isso, clique em OK.

Figura 4 - Adicionando refer�ncia ao SQL Server CE

No c�digo gerado n�o existe um namespace definido para esta classe, nem a importaç�o das bibliotecas necess�rias ao projeto, visto isso, modifique o c�digo da biblioteca para que ele fique como o da Listagem 1.

Listagem 1 - Namespaces utilizados

Imports System Imports System.Data Imports System.Data.SqlServerCe Imports System.Text Imports System.Collections.Generic Namespace Conexoes Public Class conexaoSQLServerCE Sub New() 'METODO CONSTRUTOR End Sub 'objeto para conexao Private conexao As New SqlCeConnection() Public Sub AbreConexao() End Sub Public Sub FechaConexao() End Sub Sub CriaBD(ByVal nomeBD As String) End Sub End Class End Namespace

Com a estrutura do framework definida, vamos agora implementar os m�todos de conex�o. Como j� exibido na Listagem 1, crie uma vari�vel que armazenar� o objeto de conex�o com o banco. Essa vari�vel � do tipo SqlCeConnection e � respons�vel por conectar, operar e desconectar com a base de dados.

C�digo dos m�todos de conex�o

O m�todo AbreConexao precisa sempre verificar o estado da conex�o antes de abri-la, afinal, pode ser que mais de um aplicativo esteja acessando aquela base de dados. Para isso, ele se utiliza do m�todo ConnectionState. Se a resposta for falsa, atrav�s de uma string de conex�o (que em SQL Server CE � representada apenas pelo caminho do arquivo de extens�o *.sdf) a conex�o � realizada.

O m�todo FechaConexao, faz a mesma verificaç�o de estado do m�todo de abertura. Se a resposta for verdadeira, ele finaliza a conex�o.

Quando o banco de dados n�o existe no Pocket, pode-se utilizar o objeto Engine para a criaç�o de um arquivo pronto de extens�o *.sdf. O m�todo a ser chamado � o CreateDatabase().

Preencha o conte�do dos tr�s m�todos apresentados como nas Listagens 2, 3 e 4.

Listagem 2 - M�todo AbreConexao(banco as String)

Public Sub AbreConexao(ByVal banco as String)

            Try

                If (conexao.State = ConnectionState.Closed) Then

                    Dim strConexao As String = "data source=\Temp\�+ banco +�.sdf"

                    conexao = New SqlCeConnection(strConexao)

                    conexao.Open()

                End If

            Catch ex As Exception

                Throw New Exception("Ocorreu um problema na conex�o com o base de dados, 
                 devido ao seguinte erro: " + ex.Message)

            End Try

        End Sub

Listagem 3 - M�todo FechaConexao()

Public Sub FechaConexao()

            Try

                If (conexao.State = ConnectionState.Open) Then

                    conexao.Close()

                End If

            Catch ex As Exception

                Throw New Exception("Ocorreu um problema na conex�o com o base de dados,
                 devido ao seguinte erro: " + ex.Message)

            End Try

        End Sub

Listagem 4 - M�todo CriaBD(nomeBD As String)

Sub CriaBD(ByVal nomeBD As String)

            Dim sqlengine As New SqlCeEngine("data source=\Temp\" + nomeBD + ".sdf")

            sqlengine.CreateDatabase()

        End Sub

M�todos de Seleç�o de Dados

Agora vamos implementar os m�todos que acessam a base de dados criada e retornam valores para serem trabalhados dentro do nosso aplicativo. Para isso, criaremos tr�s m�todos. Cada um deles atrav�s de uma string SQL ter� como funç�o preencher objetos DataSet, DataTable e DataReader. Acompanhe os m�todos a serem criados nas Listagens 5, 6 e 7.

Listagem 5 - M�todo PreencheDataSet(dts as DataSet, sql as String)

Public Sub PreencheDataSet(ByVal dts As DataSet, ByVal sql As String)

            Try

                Dim da As New SqlCeDataAdapter(sql, conexao)

                da.Fill(dts)

            Catch ex As Exception

                Throw New Exception("Ocorreu um problema na conex�o com o base de dados, 
                 devido ao seguinte erro: " + ex.Message)

            End Try

        End Sub

Listagem 6 - M�todo PreencheDataTable(dt as DataTable, sql as String)

Public Sub PreencheDataTable
        (ByVal dt As DataTable, ByVal sql As String)

            Try

                Dim da As New SqlCeDataAdapter(sql, conexao)

                da.Fill(dt)

            Catch ex As Exception

                Throw New Exception("Ocorreu um problema na conex�o com o base de dados, 
                 devido ao seguinte erro: " + ex.Message)

            End Try

        End Sub

Listagem 7 - M�todo PreencheDataReader(sql as String)

Public Function PreencheDataReader(ByVal sql As String) As SqlCeDataReader

            Dim cmd As New SqlCeCommand(sql, conexao)

            Dim dr As SqlCeDataReader = cmd.ExecuteReader()

            Return dr

        End Function

Cada um dos m�todos criados espera por par�metro uma string SQL e um objeto a ser preenchido. � importante ressaltar que no caso do m�todo que visa o preenchimento de um DataReader n�o temos uma forma gen�rica de preenchimento. O objeto a ser definido no preenchimento � um SqlCeDataReader, se estiv�ssemos utilizando outro banco de dados seria necess�rio trocar a ref�rencia a um objeto que desenhado para este banco determinado.

M�todos de Alteraç�o, Exclus�o e Inserç�o de Dados

� imprescind�vel na maioria das aplicaç�es que possamos manipular os dados existentes em uma base de dados. Assim, criaremos agora o m�todo que executa strings SQL na base de dados e n�o retorna nenhum tipo de valor, ou seja, visa alterar, incluir ou deletar dados. Acompanhe o m�todos citado na Listagem 8.

Listagem 8 - M�todo ExecutaComandoSQL(sql as String)

Public Sub ExecutaComandoSQL(ByVal sql As String)

            Try

                Dim cmd As New SqlCeCommand(sql, conexao)

                cmd.ExecuteNonQuery()

            Catch ex As Exception

                Throw New Exception("Ocorreu um problema na conex�o com o base de dados, 
                 devido ao seguinte erro: " + ex.Message)

            End Try

        End Sub

Nesse m�todos criamos um objeto do tipo SqlCeCommand para executar um comando em nossa base de dados, essa execuç�o � definida atrav�s do ExecuteNonQuery().

M�todos para Transaç�es

Em alguns de nossos aplicativos precisamos �s vezes operar processos que sejam, ou executados com completo sucesso, ou que n�o sejam executados. Por exemplo, se na sua aplicaç�o fosse necess�rio inserir um milh�o e meio de registros em uma tabela e essa operaç�o levasse 1 hora para ocorrer. Certo, imagine agora que no meio da operaç�o, uma pane no sistema ocorra, um dano no hardware, por exemplo. Apenas metade dos registros seria inserida, em outras palavras a aç�o ficaria incompleta. Em sistemas banc�rios, uma ocorr�ncia como essa pode definir se uma quantia de dinheiro foi ou n�o depositada em uma conta, o que caracteriza um s�rio risco. Para tratar eventos como esses, a maioria dos SGBD�s vem equipado com sistemas de transaç�o, que tem por funç�o gerenciar processos enquanto ocorrem, e se alguma coisa de errado acontecer enquanto o processo roda, ele inteiro � desfeito. Veja nos m�todos apresentados nas Listagens 9 e 10, como aplicar esse conceito ao SQL Server CE.

Listagem 9 - M�todo IniciaTransacao()

Public Sub IniciaTransacao()

        Try

            If (conexao.State = ConnectionState.Open) Then

                transacao = conexao.BeginTransaction

            End If

        Catch ex As Exception

            Throw New Exception("Ocorreu um problema na conex�o com a base da dados, 
             devido ao seguinte erro: " + ex.Message)

        End Try

        End Sub

Listagem 10 - M�todo FinalizaTransacao()

Public Sub FinalizaTransacao(ByRef flag As Boolean)

            If flag = False Then

                transacao.Commit()

            Else

                transacao.Rollback()

            End If

        End Sub

Exemplo de utilizaç�o do framework de acesso a dados

Para finalizar este artigo vamos agora ver um pequeno exemplo onde utilizaremos o framework criado. Inicialmente, modifique o arquivo chamado Form1.vb para frmProjeto.vb. Abra esse formul�rio e configure-o da forma como � apresentado na Figura 5.

Figura 5 - Exemplo de aplicativo que acessa o framework de dados

Ap�s criar o menu, com as opç�es de criar um banco, conectar e desconectar, vamos codifica-los utilizando nosso framework para acesso a dados, num exemplo simples e hipot�tico. Clique duas vezes sobre a opç�o destinada a codificaç�o e correspondentemente insira nos eventos os c�digos da Listagem 11. Repare, como apresentado na Figura 6, como o encapsulamento das funç�es criadas � apresentado de forma intuitiva. Estamos uma camada acima das aç�es que manipulam a base de dados.

Figura 6 - Encapsulamento do acesso ao banco de dados

Listagem 11 � Code-Behind do frmProjeto.vb

Dim con As New Conexoes.conexaoSQLServerCE

Private Sub cmdCriaBanco_Click(ByVal sender As System.Object, ByVal e As 
  System.EventArgs) Handles cmdCriaBanco.Click

    con.CriaBD("bd_teste")

    MsgBox("Banco criado com sucesso!")

End Sub

 

Private Sub cmdConecta_Click(ByVal sender As System.Object, ByVal e 
   As System.EventArgs) Handles cmdConecta.Click

    con.AbreConexao("bd_teste")

    MsgBox("Conex�o estabelecida!")

End Sub

 

Private Sub cmdDesconecta_Click(ByVal sender As System.Object, ByVal e As 
  System.EventArgs) Handles cmdDesconecta.Click

    con.FechaConexao()

End Sub

Inserido os c�digos, aperte F5. Quando o projeto for executado, uma janela perguntando qual emulador deseja utilizar ser� apresentada. Escolha um ao seu gosto. Clique nas opç�es e repare como o projeto executa. � interessante dizer que um framework como o que desenvolvemos nesta aplicaç�o pode ser utilizado em qualquer tipo de projeto .NET. Ao executar essa aplicaç�o um arquivo DLL foi compilado e se encontra na pasta BIN de nosso projeto. Se precisar utiliz�-lo e n�o quiser copiar a classe novamente, basta fazer uma refer�ncia a este arquivo de extens�o DLL. Muito simples e r�pido! Para projetos desktop, ou WEB pode-se tamb�m utilizar esta mesma estrutura de framework, modificando apenas a biblioteca que se deseja fazer acesso, no nosso caso utilizamos a System.Data.SqlServerCe.

Bem pessoal, � isso, espero que façam bastante proveito desse framework, especialmente �til para trabalhar em camadas.