Criando um aplicativo Maven Swing utilizando o Hibernate: tutorial do NetBeans IDE

Neste tutorial, você utiliza o NetBeans IDE para criar um aplicativo Java Swing a partir de um arquetipo Maven. O aplicativo utiliza o framework do Hibernate como camada de persistência para recuperar POJOs (objetos Java antigos e simples) a partir de um banco de dados relacional. Este tutorial demonstra como os assistentes no IDE podem ajudar a criar os arquivos Hibernate necessários e adicionar dependências Hibernate no POM. Depois de criar objetos Java e configurar o aplicativo para utilizar o Hibernate, você cria uma interface GUI para pesquisar e exibir dados.

O suporte ao Maven está totalmente integrado no NetBeans e o Maven 3 está incorporado com o IDE iniciando no NetBeans 7.0. É possível criar aplicativos a partir dos arquetipos Maven incorporados ou a partir de arquetipos em repositórios remotos no assistente Novo projeto. O Navegador do repositório Maven permite explorar seus repositórios Maven locais e remotos, examinar artefatos e adicionar dependências de projeto ao POM do projeto.

Para construir este aplicativo utilizando o Ant, consulte Utilizando o Hibernate em um aplicativo Java Swing.

Para construir um aplicativo Maven Java EE, consulte Criando um aplicativo corporativo com o Maven.

Conteúdo

• Criando o banco de dados
• Configurando o Maven
  • Visualizando os repositórios Maven
• Criando o aplicativo Maven
  • Modificando as propriedades do projeto Maven
• Adicionando arquivos e dependências Hibernate
  • Criando o arquivo de configuração do Hibernate
  • Modificando o arquivo de configuração do Hibernate
  • Criando o HibernateUtil.java, que é um arquivo de ajuda
• Gerando arquivos de mapeamento Hibernate e classes Java
  • Criando arquivos de mapeamento Hibernate e POJOs a partir de um banco de dados
• Criando o aplicativo GUI
  • Criando o formulário JFrame
  • Adicionando elementos ao formulário
• Criando a consulta no editor de consultas HQL
• Adicionando a consulta ao formulário
• Executando um projeto Maven
  • Baixando o projeto da solução
• Criando POJOs e mapeando arquivos individualmente(Opcional)

Para seguir este tutorial, são necessários os seguintes recursos e softwares.

Software ou recurso	Versão necessária
NetBeans IDE	6.8, 6.9, 7.0, 7.1, pacote Java
Java Development Kit (JDK)	versão 6
Maven	versão 2.09 ou posterior
Servidor de banco de dados MySQL	versão 5.x
Banco de dados Sakila	plugin disponível na Central de Atualizações

Antes de começar este tutorial, talvez você queira se familizar com a documentação a seguir.

• Melhores práticas para o Apache Maven no NetBeans 6.x
• Capítulo 1. Introdução ao Apache Maven (do Maven: o guia definitivo)
• Documentação do Hibernate em hibernate.org
• Introdução à construção GUI
• Conectando a um banco de dados MySQL tutorial

Você pode baixar de um arquivo zip do projeto concluído.

Criando o banco de dados

Este tutorial utiliza um banco de dados MySQL chamado sakila. O banco de dados de amostra não é incluído quando o IDE é instalado, portanto é necessário primeiro criar o banco de dados para seguir este tutorial.

O banco de dados Sakila é uma amostra gratuita do banco de dados MySQL, disponível no site do MySQL. Para criar o banco de dados sakila, baixe e instale o plug-in do banco de dados de amostra utilizando o gerenciador de plug-ins. Depois de instalar o plug-in, é possível excluir o banco de dados sakila da janela Serviços. O banco de dados sakila é adicionado à lista de bancos de dados na caixa de diálogo Criar banco de dados MySQL.

Para obter mais informações sobre a configuração do IDE para funcionar com o MySQL, consulte o tutorial Conectando a um banco de dados MySQL.

1. Abra o gerenciador de Plug-ins e instale o plug-in Sakila Sample Database.
2. Depois de instalar o plug-in, inicie o servidor do banco de dados MySQL ampliando o nó Banco de dados na janela Serviços, clicando com o botão direito do mouse no nó Servidor MySQL e escolhendo Iniciar.
3. Clique com o botão direito do mouse no nó Servidor MySQL e escolha Criar banco de dados.
4. Selecione o banco de dados Sakila a partir da lista suspensa Novo nome de banco de dados, na caixa de diálogo Criar banco de dados MySQL. Clique em OK.
   

   Ao clicar em OK, o IDE executará um script para criar o banco de dados Sakila e preencher as tabelas do banco de dados. Você pode ver o resultado da execução do script na janela Saída. É adicionado também um nó para o banco de dados Sakila sob o nó do Servidor MySQL. O

5. Clique com o botão direito do mouse e escolha Conectar.

Ao clicar em Conectar, um nó de conexão do banco de dados do banco de dados Sakila (jdbc:mysql://localhost:3306/sakila [nome de usuário em Padrão]) será listado abaixo do nó Bancos de dados. Quando uma conexão for aberta, será possível visualizar os dados no banco de dados ampliando o nó de conexão.

Configurando o Maven

Se você ainda não criou um projeto Maven no IDE, é preciso primeiro ativar o módulo Maven no IDE. Isso pode ser feito ao selecionar um arquetipo de projeto Maven no assistente Novo Projeto. Quando você seleciona o arquetipo, o IDE ativará automaticamente o módulo. Não é preciso finalizar o assistente para ativar o Maven no IDE.

Se este for seu primeiro Projeto Maven, talvez você queira verificar as definições de configurações do Maven na janela Opções. Para completar este tutorial é preciso ter o Maven instalado em seu sistema local. Se você estiver usando o NetBeans IDE 7.0 ou 7.1, o Maven está incorporado no IDE e é instalado quando você instala o IDE. Se você estiver usando uma versão anterior do IDE, é possível efetuar o download do instalador do site do Maven.

1. Selecione a categoria Miscelâneos na janela Opções e clique na aba Maven.
2. Confirme se um Maven Home está especificado.

   É possível usar a instalação do Maven 3 incorporada no IDE no NetBeans IDE 7.0, especficada por padrão, ou especificar a localização de uma instalação local do Maven (requer versão 2.0.9 ou posterior).

3. Verifique se a localização do repositório local do Maven está correta.
4. Clique em OK.

Criando o aplicativo Maven

Neste tutorial, é criado um projeto de aplicativo Java Swing simples denominado DVDStoreAdmin. O projeto será criado a partir de um dos arquetipos Maven incorporados e, em seguida, as configurações padrão do projeto serão modificadas.

Adicionando arquivos e dependências Hibernate

Para adicionar o suporte para Hibernate, é necessário tornar disponíveis as bibliotecas do Hibernate ao declarar os artefatos necessários como dependências no POM. O IDE inclui assistentes para ajudá-lo a criar os arquivos Hibernate necessários em seu projeto. É possível utilizar os assistentes no IDE para criar um arquivo de configuração Hibernate e uma classe de ajuda do utilitário. Se criar o arquivo de configuração Hibernate utilizando um assistente, o IDE atualiza automaticamente o POM e as dependências Hibernate para o projeto.

É possível adicionar dependências ao projeto na janela Propriedades ou ao editar diretamente o pom.xml. Para adicionar uma dependência na janela Propriedades, clique com o botão direito do mouse no nó Bibliotecas na janela Projetos e escolha Adicionar dependência no menu suspenso para abrir a caixa de diálogo Adicionar dependência. Quando uma dependência é adicionada, o IDE atualiza o POM e baixa quaisquer artefatos necessários para o repositório local, que ainda não estão localmente presentes.

Para editar diretamente o pom.xml, abra o arquivo ao expandir o nó Arquivos do projeto na janela Projetos e clique duas vezes em pom.xml.

Gerando arquivos de mapeamento Hibernate e classes Java

Neste tutorial, é utilizado um POJO (objeto Java antigo e simples), Actor.java, para representar os dados na tabela ACTOR do banco de dados. A classe especifica os campos para as colunas nas tabelas e utiliza setters e getters simples para recuperar e escrever dados. Para mapear o Actor.java para a tabela ACTOR, é possível utilizar um arquivo de mapeamento do Hibernate ou anotações na classe.

É possível utilizar o assistente Engenharia reversa e os Arquivos de mapeamento do Hibernate e POJOs obtidos a partir assistente de banco de dados para criar vários POJOs e arquivos de mapeamento com base nas tabelas selecionadas do banco de dados. Alternativamente, é possível utilizar assistentes no IDE para ajudar a criar POJOs individuais e arquivos de mapeamento a partir do rascunho.

Nota. Ao criar arquivos para várias tabelas, você provavelmente desejará utilizar os assistentes. Neste tutorial, só é necessários criar um POJO e um arquivo de mapeamento, portanto, é muito mais fácil criar os arquivos individualmente. É possível consultar as etapas para a criação dos POJOs e arquivos de mapeamento individualmente no final deste tutorial.

Agora que você possui o POJO e os arquivos necessários relacionados ao Hibernate, poderá criar um front-end simples Java GUI para o aplicativo. Também é possível criar e adicionar uma consulta HQL que consulte o banco de dados para recuperar os dados. Nesse processo, também utilizamos o editor HQL para construir e testar a consulta.

Criando a GUI do aplicativo

Neste exercício, um formulário JFrame simples será criado com alguns campos para a entrada e exibição de dados. Também será adicionado um botão que disparará uma consulta do banco de dados para recuperar os dados.

Se você não estiver familiarizado com o uso do Construtor de GUI para criar formulários, talvez queira examinar o tutorial Introdução à construção GUI.

Criando a consulta no editor de consultas HQL

No IDE, é possível construir e testar consultas com base na Linguagem de consulta do Hibernate (HQL) utilizando o Editor de consultas HQL. À medida que a consulta é inserida, o editor mostra a consulta SQL equivalente (traduzida). Ao clicar no botão "Executar consulta HQL" na barra de ferramentas, o IDE executará a consulta e mostrará os resultados na parte inferior do editor.

Neste exercício, o Editor HQL é utilizado para construir consultas HQL simples que recuperam uma lista de detalhes de atores com base na correspondência do nome ou sobrenome. Antes de adicionar a consulta à classe, você utilizará o Editor de consulta HQL para testar se a conexão está funcionando corretamente e se a consulta produz os resultados desejados. Antes de executar a pesquisa, é preciso compilar o aplicativo.

1. Clique com o botão direito do mouse no nó do projeto e escolha Construir.

   Ao clicar em Compilar, o IDE baixará os artefatos necessários para seu repositório Maven local.

2. Expanda o nó do pacote de código-fonte <pacote padrão> sob o nó Outros códigos-fonte na janela Projetos.
3. Clique com o botão direito do mouse em hibernate.cfg.xml e escolha Executar consulta HQL para abrir o Editor HQL.
4. Teste a conexão inserindo from Actor no Editor de consultas HQL. Clique no botão Executar consulta HQL () na barra de ferramentas.

   Ao clicar em Executar consulta HQL, deverá visualizar os resultados da consulta no painel inferior do Editor de consultas HQL.

   
5. Digite a consulta a seguir no Editor de consultas HQL e clique em Executar consulta HQL para verificar os resultados da consulta quando a string de pesquisa for "PE".

   from Actor a where a.firstName like 'PE%'

   A consulta retorna uma lista de detalhes de atores para aos atores cujos nomes começam com "PE".

   Ao clicar no botão SQL acima dos resultados, deverá ser exibida a seguinte consulta SQL equivalente.

   select actor0_.actor_id as col_0_0_ from sakila.actor actor0_ where (actor0_.first_name like 'PE%' )

6. Abra uma nova guia do Editor de consulta HQL e insira a consulta a seguir no painel do editor. Clique em Executar consulta HQL.

   from Actor a where a.lastName like 'MO%'

   A consulta retorna uma lista de detalhes de atores para os atores cujos sobrenomes começam com "MO".

Testar as consultas mostra que as elas retornam os resultados desejados. A próxima etapa é implementar as consultas no aplicativo de modo que a consulta apropriada seja invocada clicando-se no botão Consulta no formulário.

Adicionando a consulta ao formulário

Agora é necessário modificar o DVDStoreAdmin.java para adicionar as strings de consulta e criar os métodos para construir e invocar uma consulta que incorpore as variáveis de entrada. É necessário também modificar o manipulador de eventos do botão para invocar a consulta correta e adicionar um método para exibir os resultados da consulta na tabela.

1. Abra DVDStoreAdmin.java e clique na aba Código-fonte.
2. Adicione as seguintes strings de consulta (em negrito) à classe.

   public DVDStoreAdmin() {
       initComponents();
   }
   
   private static String QUERY_BASED_ON_FIRST_NAME="from Actor a where a.firstName like '";
   private static String QUERY_BASED_ON_LAST_NAME="from Actor a where a.lastName like '";

   É possível copiar as consultas das guias do Editor de consulta HQL para o campo e, em seguida, modificar o código.

3. Adicione os métodos a seguir para criar a consulta com base na string de entrada do usuário.

   private void runQueryBasedOnFirstName() {
       executeHQLQuery(QUERY_BASED_ON_FIRST_NAME + firstNameTextField.getText() + "%'");
   }
       
   private void runQueryBasedOnLastName() {
       executeHQLQuery(QUERY_BASED_ON_LAST_NAME + lastNameTextField.getText() + "%'");
   }

   Esses métodos chamam o método executeHQLQuery() e cria a consulta combinando a string de consulta com o usuário que inseriu a string de pesquisa.

4. Adicione o método executeHQLQuery().

   private void executeHQLQuery(String hql) {
       try {
           Session session = HibernateUtil.getSessionFactory().openSession();
           session.beginTransaction();
           Query q = session.createQuery(hql);
           List resultList = q.list();
           displayResult(resultList);
           session.getTransaction().commit();
       } catch (HibernateException he) {
           he.printStackTrace();
       }
   }

   O método executeHQLQuery() chama o Hibernate para executar a consulta selecionada. Esse método utiliza a classe de utilitário HibernateUtil.java para obter a Sessão Hibernate.

5. Corrija suas importações para adicionar instruções de importação para as bibliotecas Hibernate (org.hibernate.Query, org.hibernate.Session) e java.util.List.
6. Crie um manipulador de eventos do botão Consulta alternando para a visualização Desenho e clicando duas vezes no botão Consulta.

   O IDE cria o método queryButtonActionPerformed e exibe o método na visualização Código-fonte.

7. Modifique o método queryButtonActionPerformed na visualização Código-fonte adicionando o código a seguir de modo que uma consulta seja executada quando o usuário clicar no botão.

   private void queryButtonActionPerformed(java.awt.event.ActionEvent evt) {
       if(!firstNameTextField.getText().trim().equals("")) {
           runQueryBasedOnFirstName();
       } else if(!lastNameTextField.getText().trim().equals("")) {
           runQueryBasedOnLastName();
       }
   }

8. Adicione o método a seguir para exibir os resultados na JTable.

   private void displayResult(List resultList) {
       Vector<String> tableHeaders = new Vector<String>();
       Vector tableData = new Vector();
       tableHeaders.add("ActorId"); 
       tableHeaders.add("FirstName");
       tableHeaders.add("LastName");
       tableHeaders.add("LastUpdated");
   
       for(Object o : resultList) {
           Actor actor = (Actor)o;
           Vector<Object> oneRow = new Vector<Object>();
           oneRow.add(actor.getActorId());
           oneRow.add(actor.getFirstName());
           oneRow.add(actor.getLastName());
           oneRow.add(actor.getLastUpdate());
           tableData.add(oneRow);
       }
       resultTable.setModel(new DefaultTableModel(tableData, tableHeaders));
   }

9. Corrija as importações (Ctrl+Shift+I) para adicionar o java.util.Vector e salve as alterações.

Depois de salvar o formulário, é possível executar o projeto.

Executando um projeto Maven

Agora que a codificação foi concluída, é possível construir o projeto e iniciar o aplicativo. Quando um projeto Maven é construído no IDE, o Maven lê o POM do projeto para identificar as dependências do projeto. Todos os artefatos especificados como dependências precisam estar em seu repositório local do Maven para que o projeto possa ser construído. Se um artefato necessário não está no repositório local, o Maven retirará o artefato do repositório remoto antes de tentar construir e executar o projeto. Após construir o projeto, o Maven instalará o binário resultante como um artefato em seu repositório local.

Notas.

Para compilar e iniciar este aplicativo, execute as tarefas a seguir.

1. Clique com o botão direito do mouse no nó do projeto na janela Projetos e escolha Propriedades.
2. Selecione a categoria Executar, na caixa de diálogo Propriedades do projeto.
3. Digite sakila.ui.DVDStoreAdmin como a Classe principal. Clique em OK.

   Alternativamente, é possível clicar no botão Procurar e escolher a classe principal na caixa de diálogo.

   
4. Clique em Executar projeto principal na barra de ferramentas principal para iniciar o aplicativo.

Quando a ação Executar é chamada em um projeto Maven no IDE, o IDE executa os objetivos Maven associados com a ação Executar. O IDE possui objetivos padrão vinculados às ações do IDE de acordo com o pacote do projeto. É possível visualizar os objetivos vinculados à ação Executar no painel Ações da janela Propriedades do projeto

É possível personalizar a vinculação de objetivos às ações no painel Ações da janela Propriedades do projeto.

O formulário GUI é aberto quando o aplicativo é iniciado. Digite uma string de pesquisa no campo de texto Nome ou Sobrenome e clique em Consulta para pesquisar um ator e ver os detalhes.

Se você observar a janela Saída do IDE, poderá visualizar a consulta SQL que recuperou os resultados exibidos.

Criando POJOs e arquivos de mapeamento individualmente

Como um POJO é uma classe Java simples, é possível utilizar o assistente Nova classe Java para criar a classe e, em seguida, editar a classe no editor de código-fonte para adicionar os campos, getters e setters necessários. Depois de criar o POJO, utilize um assistente para criar um arquivo de mapeamento do Hibernate para associar a classe à tabela e adicionar informações de mapeamento ao hibernate.cfg.xml. Ao criar um arquivo de mapeamento a partir do rascunho, é necessário associar os campos às colunas no editor XML.

Nota. Este exercício é opcional e descreve como criar o POJO, o arquivo de mapeamento criado com os arquivos de mapeamento Hibernate e POJOs obtidos do assistente de Banco de dados.

1. Clique com o botão direito do mouse no nó Pacotes de códigos-fonte na janela Projetos e escolha Novo > Classe Java para abrir o novo assistente para Classe Java.
2. No assistente, digite Actor para o nome da classe e sakila.entity para o pacote. Clique em Terminar.
3. Faça as seguintes alterações (exibidas em negrito) nas classes para implementar a interface Serializable e adicionar campos nas colunas da tabela.

   public class Actor implements Serializable {
       private Short actorId;
       private String firstName;
       private String lastName;
       private Date lastUpdate;
   }

4. Gere os getters e setters para os campos colocando o cursor de inserção no editor de código-fonte, digitando Alt-Insert e, em seguida, selecionando Getter e setter.
5. Na caixa de diálogo Gerar getters e setters, selecione todos os campos e clique em Gerar.
   

   Na caixa de diálogo Gerar getters e setters, é possível utilizar a seta para cima no teclado para mover o item selecionado para o nó Ator e pressionar a barra de espaço para selecionar todos os campos em Ator.

6. Corrija as importações e salve as alterações.

Depois de criar o POJO para a tabela, você desejará criar um arquivo de mapeamento do Hibernate para Actor.java.

1. Clique com o botão direito do mouse no nó pacotes de código-fonte sakila.entity, na janela Projetos, e escolha Novo > Outro para abrir o assistente Novo arquivo.
2. Selecione o assistente Mapeamento do Hibernate na categoria Hibernate. Clique em Próximo.
3. Digite Actor.hbm como o nome do arquivo e defina a pasta como src/main/resources/sakila/entity . Clique em Próximo.
4. Digite sakila.entity.Actor para a classe a ser mapeada.
5. Selecione actor na lista suspensa Tabela do banco de dados, se não estiver selecionado. Clique em Terminar.
   

   Ao clicar em Terminar, o arquivo de mapeamento do Hibernate Actor.hbm.xml será aberto no editor de código-fonte. O IDE também adiciona automaticamente uma entrada para o recurso de mapeamento para hibernate.cfg.xml. É possível visualizar os detalhes da entrada ampliando o nó Mapeamento, na visualização Desenho do hibernate.cfg.xml ou na visualização XML. A entrada mapping na visualização XML será semelhante a:

           <mapping resource="sakila/entity/Actor.hbm.xml"/>
       </session-factory>
   </hibernate-configuration>

6. Associe os campos Actor.java às colunas na tabela ACTOR fazendo as seguintes alterações (em negrito) no Actor.hbm.xml.

   <hibernate-mapping>
     <class name="sakila.entity.Actor" table="actor">
       <id name="actorId" type="java.lang.Short">
         <column name="actor_id"/>
         <generator class="identity"/>
       </id>
       <property name="firstName" type="string">
         <column length="45" name="first_name" not-null="true"/>
       </property>
       <property name="lastName" type="string">
         <column length="45" name="last_name" not-null="true"/>
       </property>
       <property name="lastUpdate" type="timestamp">
         <column length="19" name="last_update" not-null="true"/>
       </property>
     </class>
   </hibernate-mapping>

   É possível utilizar o recurso autocompletar de código no editor para completar os valores ao modificar o arquivo de mapeamento.

   Nota: por padrão, o elemento class gerado tem uma aba de fechamento. Como é necessário adicionar elementos de propriedade entre as marcações de abertura e fechamento do elemento class, é necessário fazer as alterações a seguir (exibidas em negrito). Depois de fazer as alterações, será possível utilizar o recurso autocompletar de código entre as marcações class.

   <hibernate-mapping>
     <class name="sakila.entity.Actor" table="actor">
     </class>
   </hibernate-mapping>

7. Clique no botão Validar XML na barra de ferramentas e salve as alterações.

A criação de POJOs individuais e arquivos de mapeamento do Hibernate pode ser um modo conveniente de personalizar ainda mais seu aplicativo.

Consulte também

Para obter mais informações sobre a criação de aplicativos GUI Swing, consulte os tutoriais a seguir.

• Criando um GUI Swing no NetBeans IDE
• Construindo um aplicativo de banco de dados de área de trabalho Java
• Introdução à construção GUI
• Trilha de aprendizado dos aplicativos Java GUI