RELACIONAMENTOS ENTRE OS OBJETOS NO FRAMEWORK HIBERNATE Elio Lovisi Filho 1 Ronney Moreira de Castro 2 RESUMO

Transcrição

1 Revista Eletrônica da Faculdade Metodista Granbery - ISSN Curso de Sistemas de Informação - N. 10, JAN/JUN 2011 RELACIONAMENTOS ENTRE OS OBJETOS NO FRAMEWORK HIBERNATE Elio Lovisi Filho 1 Ronney Moreira de Castro 2 RESUMO Este artigo apresenta a implementação de relacionamentos no framework Hibernate, em duas diferentes situações. São apresentadas técnicas e as ferramentas empregadas neste desenvolvimento, em especial o framework Hibernate, a IDE NetBeans, bem como os resultados obtidos durante a realização do processo. PALAVRAS-CHAVE: HIBERNATE, RELACIONAMENTOS, NETBEANS, JAVA ABSTRACT This article presents the implementation of relationships in Hibernate Framework in two different situations. Techniques and the tools used are presented in this development, especially the Hibernate framework, the NetBeans IDE, and the results obtained during the development process. KEY-WORDS: HIBERNATE, RELATIONSHIPS, NETBEANS, JAVA 1 - Mestre em Informática pelo Instituto Tecnológico de Aeronáutica, Professor do curso de Sistemas de Informação da Faculdade Metodista Granbery e do curso de Redes de Computadores da Faculdade Estácio de Sá, e ainda, Analista de Sistemas da Prefeitura de Juiz de Fora. eliolovisi.professor@gmail.com 2 - Mestrando em Ciência da Computação pala Universidade Federal de Viçosa, Professor do curso de Sistemas de Informação da Faculdade Metodista Granbery e Analista de Sistemas da Prefeitura de Juiz de Fora. ronneymc@gmail.com

2 1. INTRODUÇÃO O framework Hibernate fornece ferramentas que permitem o mapeamento objetorelacional (Object-relational mapping ORM) com o objetivo principal de possibilitar que os objetos de uma determinada aplicação sejam mapeados em entidades de uma base de dados relacional. Este framework pode ser utilizado em programas implementados na linguagem Java, possuindo também uma versão para.net chamada NHibernate [Bauer e King 2007]. Como o Hibernate é um framework para mapeamento objeto-relacional, ele também deve oferecer suporte para as associações e heranças entre as classes, permitindo também a realização da correspondência das mesmas com relacionamentos entre as tabelas. Sendo assim, o Hibernate permite a realização de diferentes tipos de associações entre as classes, como: um-para-um; um-para-muitos; e muitos-para-muitos. Além disso, pode-se também utilizar a herança no modelo de classes do sistema. Neste artigo, apresenta-se um tutorial sobre a implementação de relacionamentos no framework Hibernate. Para permitir o melhor entendimento, será utilizado como exemplo o software apresentado no artigo de Lovisi e Castro (2009), acrescentando-se ao mesmo uma associação um-para-muitos e uma herança. A aplicação original permite apenas a manutenção de departamentos. Para exemplificar os relacionamentos serão acrescentadas duas novas funcionalidades: a manutenção de funcionários e de departamentos especiais. As ferramentas empregadas no desenvolvimento deste tutorial foram: a IDE NetBeans 6.9, disponível em e o framework Hibernate versão 3.6.1, que pode ser obtido em Nos próximos itens serão apresentadas as atividades realizadas para a implementação das funcionalidades citadas. Apresenta-se o código das classes das camadas model, view, control e DAO necessárias para o desenvolvimento do aplicativo. 2. CRIAÇÃO DE NOVAS TABELAS Até então, o sistema utilizado no exemplo possui somente a tabela Departamento. Para apresentar a utilização de relacionamentos, serão criadas as tabelas Funcionário e 2

3 Departamento Especial, onde um funcionário pertence a um departamento, e um departamento pode ter vários funcionários. Para tanto, deve-se criar as tabelas utilizando o seguinte script SQL CREATE TABLE `funcionario` ( `id` int(11) NOT NULL AUTO_INCREMENT, `cargo` varchar(60) DEFAULT NULL, `datanascimento` date DEFAULT NULL, `nome` varchar(60) DEFAULT NULL, `departamento` int(11) DEFAULT NULL, PRIMARY KEY (`id`), FOREIGN KEY (`departamento`) REFERENCES `departamento` (`id`) ) ENGINE=InnoDB ; CREATE TABLE `departamentoespecial` ( `id` int(11) NOT NULL, `caracteristica` varchar(60) default NULL, PRIMARY KEY (`id`), CONSTRAINT `departamentoespecial_ibfk_1` FOREIGN KEY (`id`) REFERENCES `departamento` (`id`) ON DELETE NO ACTION ON UPDATE NO ACTION ) ENGINE=InnoDB; 3. CRIAÇÃO DA CLASSE FUNCIONÁRIO Na aplicação Java, deve-se criar uma nova classe chamada Funcionário no pacote model. Esta classe será empregada para exemplificar uma associação um-para-muitos com a classe Departamento, devendo ter os seguintes atributos: id do tipo Integer; cargo do tipo String; datanascimento do tipo Date (java.util.date); nome do tipo String; e departamento da classe Departamento. Encapsule os atributos e crie um construtor para a classe. Finalmente, acrescente as anotações nos atributos conforme o fragmento de código abaixo e importe os pacotes necessários. 2. public class Funcionario implements Serializable { 3

4 (strategy=generationtype.identity) 6. private Integer id; 7. private String nome; 8. private String cargo; 10. private Date datanascimento; 13. private Departamento departamento; Na linha 1 do código acima, deve-se observar que a define que a classe Funcionário corresponde a uma tabela de mesmo nome. Já na linha 3, a define que o campo é chave e a (linha 11) define o relacionamento entre as tabelas, por meio do atributo definido (linha 11). Além disso, sobrescreva o método tostring() da classe funcionário da seguinte forma: 1. public String tostring() { 2. return this.getnome(); 3. } 4. CRIAÇÃO DAS CLASSES DAO E CONTROLADORA DO FUNCIONARIO No pacote DAO, criar uma nova classe chamada DAOFuncionario, a qual herda de DAOGenerico, com um construtor próprio. Lembre-se que as classes DAO devem permitir o acesso da aplicação ao banco de dados, e que os métodos da classe DAOGenerico já implementam genericamente as operações básicas de acesso aos dados [Richardson 2007]. Agora, no pacote control, crie uma nova classe chamada CtrManterFuncionario, com um contrutor próprio. Acrescente o código abaixo à nova classe. 1. DAOFuncionario acessohibernatefunc = new DAOFuncionario(); public int gravarfuncionario(funcionario funcionario) { 4. try { 5. acessohibernatefunc.gravar(funcionario); 6. return 1; 7. } catch (HibernateException e) { 8. return 2; 9. } 10. } public List carregarfuncionarios() { 4

5 13. try { 14. return acessohibernatefunc.carregartudoordenado (Funcionario.class, "nome"); 15. } catch (HibernateException e) { 16. return null; 17. } 18. } 19. public boolean excluirfuncionario(funcionario funcionario) { 20. try { 21. acessohibernatefunc.excluir(funcionario); 22. return true; 23. } catch (HibernateException e) { 24. return false; 25. } 26. } public boolean alterarfuncionario(funcionario funcionario) { 29. try { 30. acessohibernatefunc.alterar(funcionario); 31. return true; 32. } catch (HibernateException e) { 33. return false; 34. } 35. } Os métodos acima permitem a realização das operações básicas (gravar, excluir, alterar e carregar) para os objetos da classe Funcionário, chamando os métodos que estão implementados na classe DAO. Agora, no método criasessionfactory() da classe HibernateConfiguracao altere o código conforme apresentado a seguir. 1. if (sessionfactory == null) { 2. AnnotationConfiguration cfg = new AnnotationConfiguration(); 3. cfg.addannotatedclass(departamento.class); 4. cfg.addannotatedclass(funcionario.class); 5. sessionfactory = cfg.buildsessionfactory(); 6. } Observe que a linha 4 foi incluída no código, permitindo que o framework carregue as configurações da classe Funcionario. 5. CRIAÇÃO DO FORMULÁRIO DE FUNCIONÁRIOS Agora, no pacote view, crie um novo formulário Jframe (FrmManterFuncionario) de acordo com a próxima figura. 5

6 Figura 1: Tela de Manutenção de Funcionários Observe que o nome dos componentes do formulário devem ser os seguintes: Lista de funcionários: jlstfuncionarios; Texto para o nome do funcionário: jtxtnome; Texto para o cargo do funcionário: jtxtcargo; Texto com máscara (JFormattedTextField) para a data de nascimento do funcionário: jtxtdatanascimento; Combo para listagem de departamentos: jcbxdepartamento; Botão para inclusão: jbtnincluir; Botão para exclusão: jbtnexcluir; Botão para alteração: jbtnalterar. Para a lista de funcionários e a combo de departamentos, a propriedade model deve ser vazia. O campo data de nascimento é do tipo Date. Logo, deve-se apresentar uma máscara no mesmo para que seja inserido o dado. Para tanto, selecione o campo texto e altere sua propriedade Pre-Init Code conforme a próxima figura. 6

7 Figura 2: Pre-Init Code do campo Data de Nascimento Nesta propriedade inclua o código a seguir: 1. MaskFormatter mascara; 2. try { 3. mascara = new MaskFormatter("##/##/####"); 4. mascara.setvalidcharacters(" "); 5. mascara.install(jtxtdatanascimento); 6. } catch(exception ex) { 7. ex.printstacktrace(); 8. } 9. jtxtdatanascimento.updateui(); O código anterior acrescenta uma máscara ao campo data de nascimento, no formato dia/mês/ano, aceitando somente números, conforme pode ser visto nas linhas 3 e 4. 7

8 Agora acesse o código do formulário e inclua os seguintes atributos fazendo as importações necessárias: 1. CtrManterFuncionario ctrmanterfuncionario; 2. CtrManterDepartamento ctrmanterdepartamento; 3. Departamento depart; 4. Funcionario func; 5. SimpleDateFormat df; No evento windowactivated do formulário, inclua o seguinte código, para carregar a lista de funcionários e a combo box de departamentos. 1. //inicia os atributos 2. ctrmanterfuncionario = new CtrManterFuncionario(); 3. ctrmanterdepartamento = new CtrManterDepartamento(); 4. depart = new Departamento(); 5. func = new Funcionario(); DefaultListModel listmodel = new DefaultListModel(); 8. List listfunc = new ArrayList(); listfunc = ctrmanterfuncionario.carregarfuncionarios(); 11. if (listfunc!= null) { 12. Iterator i = listfunc.iterator(); 13. while (i.hasnext()) { 14. Funcionario funclist = (Funcionario) i.next(); 15. listmodel.addelement(funclist); 16. } 17. jlstfuncionarios.setmodel(listmodel); 18. } 19. //carrega combo de departamentos 20. DefaultComboBoxModel modelcombo = new DefaultComboBoxModel(); 21. List listdept = ctrmanterdepartamento.carregardepartamentos(); 22. if (listdept!= null) { 23. Iterator j = listdept.iterator(); 24. while (j.hasnext()) { 25. Departamento deptlist = (Departamento) j.next(); 26. modelcombo.addelement(deptlist); 27. } 28. jcbxdepartamento.setmodel(modelcombo); 29. } 30. //inicializa o formato das datas 31. df = new SimpleDateFormat("dd/MM/yyyy"); 32. df.setlenient(false); Para exibir os dados dos funcionários, implemente o código a seguir no método mouseclicked da lista. 8

9 { 1. //recupera o funcionario selecionado 2. func = (Funcionario) jlstfuncionarios.getselectedvalue(); 3. //apresenta os dados do funcionario 4. if (func!= null) { 5. jtxtnome.settext(func.getnome()); 6. jtxtcargo.settext(func.getcargo()); 7. jtxtdatanascimento.settext(df.format(func.getdatanascimento())); 8. int cont; 9. //apresenta o departamento do funcionario 10. for (cont = 0; cont < jcbxdepartamento.getmodel().getsize(); cont+ +) { 11. if (((Departamento) jcbxdepartamento.getmodel(). getelementat(cont)).getid(). equals (func.getdepartamento().getid())) 12. jcbxdepartamento.setselectedindex(cont); 13. break; 14. } else { 15. JOptionPane.showMessageDialog(null, "Objeto não Encontrado!"); 16. } Ao selecionar-se um funcionário, deve-se exibir o departamento que ele está associado. Isto é feito no código, entre as linhas 10 e 15, onde percorre-se a lista de departamentos e, se o departamento da lista possuir o mesmo atributo id do departamento associado ao funcionário (condição da linha 11), o índice da lista será posicionado neste valor. Finalmente, na página principal crie um botão para carregar o formulário e teste a aplicação. A tela deverá exibir os funcionários cadastrados no banco. Ao selecionar-se um funcionário, serão exibidos os seus dados nos campos texto e no combo. 6. MANTENDO OS DADOS DOS FUNCIONÁRIOS Agora, as funcionalidades de manutenção de dados do usuário (Incluir, Alterar e Excluir) serão adicionadas à aplicação. Para tanto implemente o código a seguir no evento mouseclicked do botão de inclusão. 1. //recupera o departamento selecionado 2. depart = (Departamento) jcbxdepartamento.getselecteditem(); 3. func = new Funcionario(); 4. //atribui os valores 5. func.setnome(jtxtnome.gettext()); 6. func.setcargo(jtxtcargo.gettext()); 7. func.setdepartamento(depart); 8. //valida data 9. try { 10. func.setdatanascimento(df.parse(jtxtdatanascimento.gettext())); 9

10 11. } catch (ParseException ex) { 12. JOptionPane.showMessageDialog(this, "Data Incorreta!"); 13. return; 14. } 15. //inclui objeto 16. if (ctrmanterfuncionario.gravarfuncionario(func) == 1) { 17. JOptionPane.showMessageDialog(this, "Objeto persistido"); 18. } else { 19. JOptionPane.showMessageDialog(this,"Objeto não persistido"); 20. } No código acima, é mostrada a inserção de objetos da classe Funcionário. Na linha 7, é atribuído o Departamento selecionado ao Funcionário, criando a associação. O tratamento adequado desta associação no banco de dados é feito pelo hibernate. Agora, o código a seguir no evento mouseclicked do botão de alteração: 1. //recupera o funcionario e o departamento selecionado 2. func = (Funcionario) jlstfuncionarios.getselectedvalue(); 3. depart = (Departamento) jcbxdepartamento.getselecteditem(); 4. if (func!= null) { 5. //atribui os valores 6. func.setnome(jtxtnome.gettext()); 7. func.setcargo(jtxtcargo.gettext()); 8. func.setdepartamento(depart); 9. //valida data 10. try { 11. func.setdatanascimento(df.parse(jtxtdatanascimento.gettext())); 12. } catch (ParseException ex) { 13. JOptionPane.showMessageDialog(this, "Data Incorreta!"); 14. return; 15. } 16. //altera objeto 17. if (ctrmanterfuncionario.alterarfuncionario(func)) { 18. JOptionPane.showMessageDialog(this, "Objeto persistido"); 19. } else { 20. JOptionPane.showMessageDialog(this, "Objeto não persistido"); 21. } 22. } else { 23. JOptionPane.showMessageDialog(this, "Objeto não localizado"); 24. } E finalmente, o código a seguir no evento mouseclicked do botão de exclusão: 1. //recupera o funcionario selecionado 2. func = (Funcionario) jlstfuncionarios.getselectedvalue(); 3. //exclui o funcionario 4. if (ctrmanterfuncionario.excluirfuncionario(func)) { 5. JOptionPane.showMessageDialog(this, "Objeto excluido"); 6. } else { 7. JOptionPane.showMessageDialog(this, "Objeto não excluido"); 10

11 8. } Execute o programa e observe os resultados. Se desejar, limpe os campos da tela após a inclusão, a alteração e a exclusão do objeto. 7. CRIANDO A CLASSE DEPARTAMENTO ESPECIAL Agora, será mostrada a implementação de herança empregando o framework Hibernate. Para tanto, no pacote model, crie uma nova classe chamada Departamento especial. Esta classe será empregada para exemplificar uma herança com a classe Departamento, devendo ter somente o atributo característica do tipo String e um construtor vazio. O código da classe deverá ser implementado conforme apresentado abaixo. 2. public class DepartamentoEspecial extends Departamento{ 3. private String caracteristica; public DepartamentoEspecial() { 6. } public String getcaracteristica() { 9. return caracteristica; 10. } 11. public void setcaracteristica(string caracteristica) { 12. this.caracteristica = caracteristica; 13. } } Além disso, acrescente a anotação que define a herança na classe Departamento conforme apresentado abaixo e faça as importações necessárias. = InheritanceType.JOINED) 3. public class Departamento implements Serializable{ 4....} Neste exemplo cada classe corresponde a uma tabela. Outros tipos de herança podem ser empregadas, de acordo com o que for definido na [Bauer e King 2007]. 11

12 8. CRIAÇÃO DAS CLASSES DAO E CONTROLADORA DO DEPARTAMENTO ESPECIAL Conforme feito no item 4, no pacote DAO, crie a classe DAODepartamentoEspecial herdando de DAOGenerico, com um construtor próprio. Agora, no pacote control, crie uma nova classe chamada CtrManterDepartamentoEspecial, com um construtor próprio. Acrescente o código abaixo à nova classe. 1. DAODepartamentoEspecial acessohibernatedepto; public CtrManterDepartamentoEspecial( ){ 4. acessohibernatedepto = new DAODepartamentoEspecial(); 5. } 6. public int gravardepartamento( DepartamentoEspecial departamento{ 7. try { 8. acessohibernatedepto.gravar(departamento); 9. return 1; 10. } catch (HibernateException e) { 11. e.printstacktrace(); 12. return 2; 13. } 14. } public List carregardepartamentos() { 17. try { 18. return acessohibernatedepto.carregartudoordenado ( DepartamentoEspecial.class, "nome"); 19. } catch (HibernateException e) { 20. return null; 21. } 22. } 23. public boolean excluirdepartamento( DepartamentoEspecial departamento) { 24. try { 25. acessohibernatedepto.excluir(departamento); 26. return true; 27. } catch (HibernateException e) { 28. e.printstacktrace(); 29. return false; 30. } 31. } public boolean alterardepartamento( DepartamentoEspecial departamento) { 34. try { 35. acessohibernatedepto.alterar(departamento); 36. return true; 12

13 37. } catch (HibernateException e) { 38. e.printstacktrace(); 39. return false; 40. } 41. } Os métodos acima permitem a realização das operações básicas (gravar, excluir, alterar e carregar) para os objetos da classe Departamento Especial. Observe que os métodos são semelhantes àqueles desenvolvidos para os controladores de Departamento e Funcionário. 9. CRIAÇÃO DO FORMULÁRIO DE DEPARTAMENTOS ESPECIAIS Novamente no pacote view, crie um novo formulário Jframe (FrmManterDepartamentoEspecial). Observe que o nome dos componentes do formulário devem ser os seguintes: Lista de departamentos: jlstdepartamentos; Texto para o nome do departamento: jtxtnome; Texto para a área do departamento: jtxtarea; Texto para a característica do departamento: jtxtcaracteristica; Botão para inclusão: jbtnincluir; Botão para exclusão: jbtnexcluir; e Botão para alteração: jbtnalterar. Figura 3: Tela de Manutenção de Departamentos Especiais 13

14 Agora, inclua no formulário os seguintes atributos e faça as importações necessárias. CtrManterDepartamentoEspecial ctrmanterdepartamento; DepartamentoEspecial depart; No evento windowactivated do formulário, inclua o seguinte código. 1. DefaultListModel listmodel = new DefaultListModel(); 2. List listdepartamento = new ArrayList(); 3. ctrmanterdepartamento = new CtrManterDepartamentoEspecial(); 4. depart = new DepartamentoEspecial(); 5. listdepartamento = ctrmanterdepartamento.carregardepartamentos(); 6. if (listdepartamento!= null) { 7. Iterator i = listdepartamento.iterator(); 8. while (i.hasnext()) { 9. Departamento deptlist = (Departamento) i.next(); 10. listmodel.addelement(deptlist); 11. } 12. jlstdepartamentos.setmodel(listmodel); 13. } Para exibir os dados de cada departamento especial selecionado, implemente o código a seguir no método mouseclicked da lista. 1. depart = (DepartamentoEspecial) jlstdepartamentos.getselectedvalue(); 2. if (depart!= null) { 3. jtxtnome.settext(depart.getnome()); 4. jtxtarea.settext(depart.getarea()); 5. jtxtcaracteristica.settext(depart.getcaracteristica()); 6. } else { 7. JOptionPane.showMessageDialog(null, "Objeto não Encontrado!"); 8. } Na página principal crie um botão para carregar o formulário e teste a aplicação. Além disso, incluir o mapeamento da classe Departamento Especial no método criasessionfactory(), conforme a seção MANTENDO OS DADOS DOS DEPARTAMENTOS ESPECIAIS Agora, conforme foi feito para a classe funcionário, serão adicionadas as funcionalidades de manutenção de dados do departamento: Incluir, Alterar e Excluir. Para tanto, implemente o código a seguir no evento mouseclicked do botão de inclusão. 1. depart = new DepartamentoEspecial(); 2. depart.setnome(jtxtnome.gettext()); 3. depart.setarea(jtxtarea.gettext()); 14

15 4. depart.setcaracteristica(jtxtcaracteristica.gettext()); 5. if (ctrmanterdepartamento.gravardepartamento(depart) == 1) { 6. JOptionPane.showMessageDialog(this, "Objeto persistido"); 7. } else { 8. JOptionPane.showMessageDialog(this, "Objeto não persistido"); 9. } A seguir, o código a seguir no evento mouseclicked do botão de alteração. 1. depart = (DepartamentoEspecial) jlstdepartamentos.getselectedvalue(); 2. if (depart!= null) { 3. depart.setnome(jtxtnome.gettext()); 4. depart.setarea(jtxtarea.gettext()); 5. depart.setcaracteristica(jtxtcaracteristica.gettext()); 6. if (ctrmanterdepartamento.alterardepartamento(depart)) { 7. JOptionPane.showMessageDialog(this, "Objeto persistido"); 8. } else { 9. JOptionPane.showMessageDialog(this, "Objeto não persistido"); 10. } 11. } else { 12. JOptionPane.showMessageDialog(this, "Objeto não localizado"); 13. } E finalmente, o código a seguir no evento mouseclicked do botão de exclusão: 1. depart = (DepartamentoEspecial) jlstdepartamentos.getselectedvalue(); 2. if (depart!= null) { 3. if (ctrmanterdepartamento.excluirdepartamento(depart)) { 4. JOptionPane.showMessageDialog(null, "Objeto Excluído"); 5. } else { 6. JOptionPane.showMessageDialog(null, "Objeto não excluído"); 7. } 8. } else { 9. JOptionPane.showMessageDialog(null, "Selecione o Objeto"); 10. } Novamente, se desejar limpe os campos da tela após a inclusão, a alteração e a exclusão do objeto. 11. CONSIDERAÇÕES FINAIS Neste artigo foi apresentado um tutorial sobre a implementação de relacionamentos no framework Hibernate, acrescentando-se a uma aplicação existente uma associação um-para-muitos e uma herança. A utilização do framework Hibernate permite o mapeamento objeto-relacional, possibilitando uma implementação mais simples de relacionamentos entre as classes. Propõe-se a aplicação, em trabalhos futuros, da ferramenta apresentada para o desenvolvimento de aplicações em outras plataformas, em especial, para softwares Web. 15

16 Além disso, pode-se aplicar a refatoração nas classes da aplicação melhorando a qualidade do código desenvolvido. 12. REFERÊNCIAS BIBLIOGRÁFICAS BAUER, Christian; KING Gavin.Java Persistence com Hibernate. 1ª ed. Rio de Janeiro: Ciência Moderna p. LOVISI FILHO, Elio; CASTRO, Gustavo Mendes. Tutorial sobre a Construção de Aplicações empregando Java, Hibernate e MySql. Revista Eletrônica da Faculdade Metodista Granbery - N. 6, JAN/JUN Disponível em: < Acesso em: 21 jan RICHARDSON, Chris. POJOS em Ação - Como Desenvolver aplicações Corporativas com Frameworks Leves. 1ª ed. Rio de Janeiro: Ciência Moderna p. 16