NHibernate - Usando o ActiveRecord II

Na primeira parte deste artigo eu apresentei o ActiveRecord e agora vou mostrar como usar este recurso em um projeto Windows Forms usando a linguagem VB .NET.

Apenas recordando, o ActiveRecord é um recurso que facilita a utilização do NHibernate poupando o trabalho de criar os arquivos XML de mapeamento OR/M, para isso é criada uma classe onde usamos atributos para realizar esta tarefa.

Obs: O projeto Castle ActiveRecord  oferece uma maneira rápida e fácil para implementar o padrão de registro ativo para aplicativos do Microsoft com base no .NET Framework

Usando o ActiveRecord e o NHibernate em uma aplicação Windows Forms

Para que você possa entender como  implementar a utilização dos recursos do ActiveRecord em sua aplicação C# ou VB .NET eu vou criar um exemplo usando a linguagem VB .NET no qual iremos realizar as seguintes tarefas:

• Criação do banco de dados e da tabela usando o SQL Server 2008 Express;
• Criação do projeto WIndows Forms;
• Definição das referências para as DLLs do NHibernate e do ActiveRecord;
• Criação das classe para realizar o mapeamento;
• Definição do arquivo de configuração;
• Inicializando o Framework;
• Usando as classes na aplicação Windows Forms;

1- Criando o banco de dados e a tabela

A primeira coisa que eu vou fazer será criar o banco de dados Clientes e a tabela contatos no SQL Server 2008. Eu poderia criar as minhas classes de domínio e mandar gerar o banco de dados e as tabelas, mas por ser uma introdução vou seguir o caminho feliz.

Eu vou criar o banco de dados e a tabela usando o Microsoft SQL Server Management Studio. Abaixo vemos a estrutura da tabela definida com os campos : id, nome e email sendo que id é um campo chave primária do tipo identity;

2- Criando o projeto Windows Forms e fazendo a referência ao NHibernate e ao ActiveRecord

Abra agora o Visual Basic 2008 Express Edition e crie um novo projeto do tipo WIndows Forms Application com o nome NHibernateActiveRecordDemo;

A seguir clique com o botão direito do mouse sobre o nome do projeto e selecione a opção Add Reference:

Na guia Browse primeiro localize onde você instalou os arquivos do NHibernate e inclua as referências conforme a figura 1.0;

Em seguida repita a operação selecionando as dlls na pasta onde você instalou as dlls do ActiveRecord conforme a figura 2.0;

Fig 1.0 - Dlls do NHibernate	Fig 2.0 - Dlls do ActiveRecord

3- Criando a classe para efetuar o mapeamento OR/M

No menu Project selecione Add Class e informe o nome Contato.vb. Esta classe deverá herdar da classe ActiveRecordBase e usar os atributos do ActiveRecord para realizar o mapeamento OR/M para a tabela Contatos.

Imports Castle.ActiveRecord

<ActiveRecord("contatos")> _
Public Class Contato
    Inherits ActiveRecordBase(Of Contato)

    Private m_id As Integer
    Private m_nome As String
    Private m_email As String

    <PrimaryKey("Id")> _
    Public Property Id() As Integer
        Get
            Return (m_id)
        End Get
        Set(ByVal value As Integer)
            m_id = value
        End Set
    End Property

    <[Property]("Nome")> _
    Public Property Nome() As String
        Get
            Return (m_nome)
        End Get
        Set(ByVal value As String)
            m_nome = value
        End Set
    End Property

    <[Property]("Email")> _
    Public Property Email() As String
        Get
            Return (m_email)
        End Get
        Set(ByVal value As String)
            m_email = value
        End Set
    End Property

End Class

Obs: Nosso exemplo possui somente uma tabela mas podemos trabalhar com relacionamentos entre tabelas. A sintaxe do atributo do projeto ActiveRecord também é usada para estabelecer relacionamentos entre classes. Por exemplo, os atributos HasMany e BelongsTo podem ser usados em uma classe pai e filho, respectivamente, para indicar uma relação um-para-muitos.

4- Criando o arquivo XML para definir as configurações usadas pelo NHibernate

Vamos agora criar o arquivo de configuração para o NHibernate com o nome AppConfig.xml conforme abaixo:

Neste arquivo estamos definindo as seguintes informações:

• O driver do banco de dados usados no projeto:  key="connection.driver_class"
• O dialeto do banco de dados :  key="dialect"
• O provedor da conexão :  key="connection.provider"
• A string de conexão usada:  key="connection.connection_string"
• O proxy :   key="proxyfactory.factory_class" />

Estas informações referem-se ao banco de dados que estamos usando no caso o SQL Server 2008 Express.

Este arquivo XML deve estar localizado na pasta bin/debug quando o projeto estiver sendo executado no modo de debug.

Neste momento o seu projeto deverá ter a seguinte estrutura:

Vamos partir para a criação da interface e utilização na prática do ActiveRecord.

5- Criando o arquivo para inicializar o framework

No menu Project selecione Add Class e informe o nome App.vb e inclua nele o seguinte código:

Imports Castle.ActiveRecord
Imports Castle.ActiveRecord.Framework
Imports Castle.ActiveRecord.Framework.Config

Public Class App

    Public Shared Sub Main()
        Dim source As XmlConfigurationSource = New XmlConfigurationSource("AppConfig.xml")
        ActiveRecordStarter.Initialize(source, GetType(Contato))
    End Sub

End Class

Este arquivo irá ler as informações do arquivo AppConfig.xml criado e iniciar o framework usando o método Initialize da classe ActiveRecordStarter.

Temos que executar este código antes de poder usar os recursos do ActiveRecord, e , sem fazer isso o projeto não vai funcionar.

6- Criando a interface com o usuário

Agora vamos criar uma interface usando o formulário form1.vb conforme a figura abaixo:

Iremos implementar as funcionalidades de listar, incluir, alterar e excluir informações do banco de dados usando o NHibernate e o mapeamento gerado pelo ActiveRecord.

a-) Listando os contatos no DataGridView

Vamos primeiro definir  o código para listar as informações da tabela Contatos no evento Click do botão Listar:

 Private Sub btnListar_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnListar.Click
        Try
            gdvContato.DataSource = Contato.FindAll()
        Catch ex As Exception
            MsgBox(" ERRO : " & ex.Message)
        End Try
    End Sub

Olhe bem o código que usamos ; ele é responsável por obter os dados da tabela contatos e exibir no datagridview.

Cadê o comando SQL, a conexão, os objetos Command, Connection , dataset, datable, dataadapter ????

Esta é a vantagem em usar o NHibernate. Não precisamos de nada nisso.

Estamos usando apenas o método FindAll() que retorna todas as instâncias do tipo Contato. Lembre-se que a nossa classe Contato herda da classe ActiveRecordBase(Of Contato).

b-) Criando um novo contato

Para criar um novo contato eu vou incluir um novo formulário a partir do menu Project opção Add Windows Forms com o nome Novo.vb conforme o leiaute abaixo:

Este formulário possui 3 Labels, 3 TextBox : txtNome txtEmail Dois controles Buttons: btnSalvar btnCancelar

Para incluir um novo Contato não é preciso informar o código do mesmo visto que este campo foi definido como do tipo identity na tabela e é gerenciado pelo próprio banco de dados.

O código do evento Click do botão Salvar do formulário Novo.vb é dado a seguir:

  Private Sub btnSalvar_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnSalvar.Click

        If txtNome.Text <> String.Empty And txtEmail.Text <> String.Empty Then

            Dim contato As New Contato

            contato.Nome = txtNome.Text
            contato.Email = txtEmail.Text
            Try
                contato.Create()
                txtNome.Text = ""
                txtEmail.Text = ""
                MsgBox("Contato criado com sucesso.")
            Catch ex As Exception
                MsgBox("Erro " & ex.Message)
            End Try

        End If
    End Sub

Neste código verificamos se foram informados valores para nome e email nas caixas de texto e em seguida criamos uma instância da classe Contato.

A seguir atribuímos os valores para o objeto criado e usamos o método Create() que cria (Salva) uma nova instância do objeto para o banco de dados.

Limpamos os controles e exibimos uma mensagem ao usuário. Ocorrendo erro emitimos um aviso.

Antes que eu esqueça o código que abre este formulário esta no evento Click do botão Novo do formulário Form1.vb :

c-) Alterando um contato existente

O código do evento Click do botão Alterar do formulário Form1.vb  apenas abre um novo formulário que eu crie e chamei de Alterar.vb. O código é:

Para alterar um contato eu vou incluir um novo formulário a partir do menu Project opção Add Windows Forms com o nome Alterar.vb conforme o leiaute abaixo:

Este formulário possui 3 Labels, 3 TextBox : txtCodigo txtNome txtEmail Dois controles Buttons: btnSalvar btnCancelar

Dica:  Como os formulário Novo.vb e Alterar.vb são iguais poderíamos ter usado a herança visual para criá-los.

Neste formulário a propriedade Enabled  do controle txtCodigo  foi definida como False pois não podemos alterar o código do contato.

No evento Load do formulário Alterar.vb devemos incluir o código a seguir:

Private Sub Alterar_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load

        txtCodigo.Text = Form1.gdvContato.CurrentRow.Cells(0).Value.ToString()
        txtNome.Text = Form1.gdvContato.CurrentRow.Cells(1).Value.ToString()
        txtEmail.Text = Form1.gdvContato.CurrentRow.Cells(2).Value.ToString()
    End Sub

Este código apensa obtém os valores selecionados no controle DataGridView e os exibe nas caixas de texto do formulário Alterar.vb para que possamos realizar as mudanças.

No evento Click do botão Salvar temos o seguinte código :

Private Sub btnSalvar_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnSalvar.Click
        
        Dim codigo As Integer = Convert.ToInt32(txtCodigo.Text)
        Dim contato As Contato = contato.Find(Convert.ToInt32(codigo))

        contato.Nome = txtNome.Text
        contato.Email = txtEmail.Text
        Try
            contato.Update()
            MsgBox("Contato atualizado com sucesso.")
        Catch ex As Exception
            MsgBox("Erro " & ex.Message)
        End Try
    End Sub

O código obtém o código da caixa de texto e usando o método Find() procura pelo objeto na coleção de objetos.

Em seguida atribui os valores definidos nas caixas de texto ao objeto encontrado e usando o método Update() atualiza as informações no banco de dados.

d-) Excluindo um contato existente

Para excluir um contato existente incluímos o código abaixo no evento Click do botão Excluir:

 Private Sub btnExcluir_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnExcluir.Click

        If (MsgBox("Deseja excluir o contato : " & gdvContato.CurrentRow.Cells(1).Value.ToString(), MsgBoxStyle.YesNo) = MsgBoxResult.Yes) Then
            Dim codigo As Integer = Convert.ToInt32(gdvContato.CurrentRow.Cells(0).Value.ToString())
            Dim contato As Contato = contato.Find(Convert.ToInt32(codigo))

            Try
                contato.Delete()
                MsgBox("Contato excluído com sucesso.")
            Catch ex As Exception
                MsgBox("Erro " & ex.Message)
            End Try
        End If
    End Sub

No código primeiro obtemos o valor do código do contato a partir da célula do DataGridView selecionada e em seguida usando o método Find() procuramos pelo objeto na coleção de objetos.

Para excluir o objeto usamos o método Delete() que deleta uma instância do banco de dados.

Abaixo vemos a aplicação em execução mostrando a alteração de um contato:

Como podemos notar o NHibernate realiza as operações de persistência usando os métodos apropriados de forma que no nosso código não precisamos usar instruções SQL nem os objetos ADO .NET para realizar a conexão, criar comandos para efetivar tais operações.

De uma forma resumida podemos dizer que por trás dos panos quando usamos o  ActiveRecord  ocorrem as seguintes tarefas:

• os comandos SQL são gerados;
• os comandos SQL são passados para o Gerenciador de banco de dados em uso (RDBMS);
• o RDBMS compila e executa o SQL;
• retorna um enumerable;
• cria um modelo ActiveRecord para cada linha;

Pegue o projeto completo aqui: NHibernateActiveRecordDemoSQLServer.zip (sem as referências)

O código ficou mais limpo e fácil de manter e ainda temos uma vantagem adicional: se precisarmos mudar o banco de dados a única alteração que devemos fazer será no arquivo de configuração AppConfig.xml.

É isso que irei mostrar na continuação deste artigo.: NHibernate - Usando o ActiveRecord com MySQL III

Eu sei é apenas NHibernate mais eu gosto...

Referências:

• Usando o SQL Server Management Studio

• .NET - NHibernate

• Getting Started com o ActiveRecord

• VB .NET - Usando o NHibernate

• NHibernate -Efetuando o mapeamento XML

• .NET - NHibernate

José Carlos Macoratti