Pular para o conteúdo principal

Bastidores do Spring Roo: A camada de persistência

Por
Como funciona a criação e manutenção da camada de persistência de uma aplicação desenvolvida com Roo?

Esse post demonstra como o Spring Roo configura a camada de persistência, descreve os comandos de persistência e como eles funcionam, além de esclarecer como o Spring Roo atua sob as entidades no decorrer do desenvolvimento. Esse texto complementa o conteúdo postado em Aventuras com Spring Roo no mundo real.


O Spring Roo é uma ferramenta RAD (Rapid Application Development) para desenvolvimento de aplicativos para Web, usando a linguagem Java. Se você nunca ouviu falar sobre o Spring Roo, leia Hello Roo.


Projeto demo
O exemplo usado como demonstração é bem simples, um CRUD de Produtos usando o HSQLDB, em poucos passos e sem burocracia o aplicativo poderá ser testado.  Considerando que a instalação e configuração do Roo já foram concluídas, para criar o projeto basta executar no shell do Roo:
roo> project --topLevelPackage br.com.yaw.produtos


Configuração da persistência
O Roo resolve o mapeamento objeto relacional através da JPA, habilitamos o mecanismo de persistência através do comando persistence setup.

Atributos do comando persistence setup:
  • database: indica qual é o Banco de Dados, as opções são MySQL, Oracle, DB2, PostgreSQL e outros.
  • provider: o provedor JPA que será utilizado, as opções são: EclipseLink, OpenJPA e Data Nucleus.
  • databaseName: indica o nome (instância) do banco de dados;
  • userName e password: nome e senha do usuário de banco de dados;
  • hostName: endereço da máquina com o banco de dados;
  • jndiDataSource: indica o nome do DataSource armazenado no JNDI;
  • persistenceUnit: nome da unidade persistência JPA (persistence.xml);
  • applicationId: identificador o aplicativo no Google App Engine, caso o projeto venha a ser executado na infra-estrutura de Cloud do Google;
Na demonstração usaremos a alternativa mais simples:
roo> persistence setup --database HYPERSONIC_IN_MEMORY --provider HIBERNATE

Com essa instrução o Roo altera e cria alguns arquivos de configuração. Veja:
  • pom.xml: configura as dependências do Maven, isso inclui: API JPA, provedor JPA, driver do banco de dados, Spring ORM, Spring JDBC, Commons DBCP e Commons Pool.
  • applicationContext.xml: adiciona as configurações de beans (do Spring) para DataSource, LocalContainerEntityManagerFactoryBean e ativa o Spring Transaction.
  • persistence.xml: cria o arquivo com as configurações da JPA.
  • database.properties: esse arquivo contém as configurações de conexão com o banco de dados.

Esses arquivos podem ser alterados diretamente em qualquer editor de texto a qualquer momento, sem o uso do Shell do Roo. Mas o Roo suporta alteração das propriedades através do comando properties set. A seguir um exemplo para mudar o nome do usuário do banco:
roo> properties set --path SRC_MAIN_RESOURCES --name /META-INF/spring/database.properties --key database.username --value teste

Outra forma de configurar propriedades do banco de dados é através do comando database properties set. O exemplo a seguir lista todas as propriedades contidas no arquivo database.properties:
roo> database properties list

O comando persistence setup pode ser executado a qualquer momento durante o desenvolvimento e quantas vezes necessário. Imagine a seguinte situação: no início de um projeto, como prova de conceito, o HSQLDB era uma opção interessante, mas no decorrer do projeto o restante da implementação deve ocorrer no MySQL.


Entidades
As entidades de domínio, Pojos que representam o modelo da aplicação, na verdade são a origem para geração de código no Spring Roo. A partir de uma entidade o Roo gera o Mapeamento Objeto Relacional e o código para os componentes Controller e View, seguindo o modelo Scaffold.

A seguir os comandos para criação da entidade Produto e dos campos Descrição e Preço. O mecanismo validação foi ativado através dos atributos notNull e min, o Spring Roo suporta a JSR 303.
roo> entity --class ~.model.Produto
roo> field string descricao --notNull
roo> field number --type java.lang.Double --fieldName preco --min 1

As entidades seguem o pattern ActiveRecord, onde cada entidade resolve o código CRUD para a tabela mapeada. Com o Spring Roo não usamos o pattern Data Access Object (DAO).


Mágica
A estratégia utilizada pelo Roo para implementar meta-programação em Java é através de Aspectos, com o AspectJ, popular implementação de AOP na plataforma Java. O código Java da classe Produto é extremamente pequeno, até os getters e setters são gerados por aspecto!

O Roo gera o arquivo Produto.java e demarcada a classe com 3 annotations e ainda gera 4 aspectos.

1. Produto_Roo_Entity.aj
Principal aspecto, define o ORM comum em todas as entidades, os atributos @Id e @Version. Esse aspecto implementa o código ActiveRecord com os métodos: persist, remove, flush e merge.

O aspecto implementa alguns métodos para consultas contra a base dados: findProduto, findAllProdutos, findProdutoEntries e countProdutos. Para não engessar a camada de persistência, esse aspecto também cria o método entityManager para expor o gestor de persistência fora do contexto de aspectos. Criado a partir da annotation @RooEntity.

2. Produto_Roo_Configurable.aj
Habilita a Injeção de Dependência do EntityManager via Spring IoC, através da annotation @Configurable.

3. Produto_Roo_JavaBean.aj
Esse aspecto cria o método get e o método set de cada atributo definido na entidade. Criado a partir da annotation @RooJavaBean.

4. Produto_Roo_ToString.aj
Gera o método toString concatenando os atributos em uma String. Criado a partir da annotation @RooToString.

Uma restrição importante do Roo: NUNCA manipule o código dos aspectos, afinal esse conteúdo é gerado pela ferramenta. A proposta do Roo é inferir o mínimo possível no código Java. O Roo demarca as classes com annotations e gera o código através de aspectos.



O driagrama acima ilustra como o Roo trabalha desde de a geração do código até a compilação da classe. O Roo monitora o arquivo Produto.java, qualquer modificação pode refletir nos aspectos, por fim o compilador AspectJ unifica o conteúdo dos aspectos com Java para gerar Produto.class. 


Transação
No Roo o controle do escopo transacional com o banco de dados é realizado pelo Spring Transaction. Nas entidades, seguindo a linha Active Record, os métodos persist, remove, flush e merge são demarcados com a annotation @Transactional. Na camada Controller, gerada pelo Roo, esses métodos serão invocados em transações isoladas. 

O desenvolvedor tem autonomia para aumentar o escopo transacional de uma requisição demarcando o método da Controller com @Transactional. Dessa forma todas as operações CRUD acionadas a partir desse método irão pertencer a mesma transação.

Em algumas situações pode fazer mais sentido criar um método na própria entidade para agrupar a execução de outros métodos na mesma transação, um exemplo disso poderia ocorrer no relacionamento master-detail. Basta marcar esse método com @Transactional, a única restrição é de que este método não pode ser static.


Terminando a demo
Para concluir e rodar a aplicação demonstração basta executar os seguintes comandos:
roo> controller all --package ~.web
roo> perform package
roo> quit
$ mvn tomcat:run

Dica: os comandos executados no Shell do Roo ficam armazenados no arquivlo log.roo no diretório raiz da aplicação.

O Roo contém outros dois comandos que também envolvem a camada de persistência, finder e database reverser engineer. Mas deixo esses dois comandos para o próximo post!

Outras referências

[]s
Eder Magalhães
www.yaw.com.br
twitter.com/youandwe
twitter.com/edermag
Marcadores:

Comentários

Postar um comentário

Postagens mais visitadas deste blog

10 reasons why we love JSF

Por
1. One-slide technology: it's so simple that I can explain basic JSF with one slide. 2. Easy to extend: components, listeners, render kit, Events, Controller, etc. 3. Real-world adoption: JBoss, Exadel, Oracle, IBM, ... 4. Architecture model: you can choose between more than 100 different architecture. 5. Open-mind community: using JSF you are going to meet very interesting people. 6. We are using JSF the last 5 years and we found very good market for JSF in Brazil 7. Progress: look to JSf 1.1 to JSF 1.2, JSF 1.2 to JSF 2.0. People are working really hard! 8. Many professionals now available 9. It's a standard. It's JCP. Before complain, report and help! 10. Ed Burns, spec leader, is an old Globalcode community friend! EXTRA: My wife is specialist in JSF. She's my F1 for JSF :) Nice job JSF community! -Vinicius Senger
67 comentários
Leia mais

Vem vindo novidade por ai... Minicurso de desenvolvimento iOS

Por
Ola pessoal, Depois de uma conversa com a Yara, resolvemos colocar em prática uma idéia que já tinhamos a um tempo, que é aumentar as opções de mobilidade no portifólio da Globalcode e também da iniciativa Open4Education. E nesse caso estamos falando de um minicurso sobre desenvolvimento para iPhone e iPad. O objetivo desse minicurso vai ser mostrar que desenvolver para iOS não é tão complicado como se pode pensar e que não é preciso ter medo do Objective-C ! Serão algumas horas onde os alunos poderão entender os fundamentos da plataforma, como funciona o programa para desenvolvedores da Apple, preparação do ambiente e dos devices de teste e também um overview dos layers de desenvolvimento do iOS. Além disso, o objetivo também vai ser passar um pouco da minha experiência na "migração" que fiz de Java (seja SE, ME ou Android) para o novo mundo do Objective-C e Cocoa Touch. O material está no começo e ainda não temos uma data certa (só sabemos que a primeira edição desse minicu...
2 comentários
Leia mais

Transmissão do minicurso Google App Engine

Por
Os minicursos gratuitos realizados através da iniciativa Open4Education da Globalcode têm sido transmitidos ao vivo em forma de webcast e eu tenho acompanhado pessoalmente muitos deles, conversado com os alunos no chat, observando a qualidade e as limitações das transmissões. Sem dúvida o aproveitamento presencial é muito maior, principalmente pelo networking e pelo foco dado ao conteúdo. Mas, para aqueles que não estão em São Paulo o custo benefício é sensacional. Mesmo perdendo um pouco nas transmissões, é muito melhor poder assistir os minicursos à distância. Com o sucesso das transmissões do Profissão Java e do The Developer's Conference 2010 queremos melhorar e atingir um público ainda maior, e é por isto, que iremos fazer a primeira transmissão ao vivo em parceria com a WTV Streaming hoje! Os principais benefícios desta parceria são: Transmissão do vídeo e não apenas do conteúdo que está sendo projetado Captação e edição do conteúdo, para posterior disponibilizaç...
11 comentários
Leia mais

JavaMail: Enviando e-mail com Java

Por
Introdução Além da necessidade de envio de e-mail ser comum a várias aplicações, foi a pergunta de um aluno da Academia Java ,  “Como enviar um e-mail com Java?”, que me motivou a escrever este post sobre JavaMail. JavaMail Para realizar o envio de e-mail por meio de uma aplicação Java, precisamos da biblioteca JavaMail, pois ela não é incluída no Java SE. A biblioteca está disponível em http://www.oracle.com/technetwork/java/index-138643.html . Neste download, além da biblioteca mail.jar que inclui a implementação completa da API e providers, também é disponibilizada a documentação da biblioteca ( javadoc ) na pasta docs , alguns exemplos na pasta demo e partes da implementação em lib . A forma mais simples de utilizar a JavaMail e incluir o mail.jar , porém para uma aplicação que só envia e-mail como o nosso exemplo, necessitamos apenas dos arquivos mailapi.jar e smtp.jar , economizando 177KB. Como a economia é pouca e as aplicações evoluem, vamos adicionar o mail.j...
9 comentários
Leia mais

Facelets uma forma mais ágil para construção de telas – Parte I

Por
A construção de telas ou camada de apresentação em um sistema MVC seja web ou desktop é uma tarefa complexa e de extrema importância. Nesse post vou comentar e mostrar algum exemplo do Facelets como solução para os desafios existentes nessa etapa especificamente para web. Com a web cada vez mais presente em nosso dia-a-dia, um fato é que com isso nossos usuários tornam-se mais exigentes em relação a usabilidade, agilidade, performance ou de uma forma bem resumida “o usuário espera uma navegação simples e agradável aonde uma determinado tarefa possa ser concluída em poucos passos e em um curto espaço de tempo”. Atender as expectativas em relação ao que o usuário espera com o que realmente ele precisa, definir uma estrutura flexível a mudanças sem engessar o desenvolvimento, acessibilidade, portabilidade em múltiplos navegadores, tudo isso e muito mais, num prazo que quase sempre é apertado. Um outro ponto fundamental é manter o time motivado e produtivo em um ambiente que favoreça a...
11 comentários
Leia mais

JavaOne Brasil, dicas para submissão de palestras

Por
Não quero parecer pretensiosa dando dicas para submissão de palestras para o JavaOne Brasil, mas sim repassar os tantos conselhos e sugestões recebidas pelos vetaranos do JavaOne: Bruno Souza e Leonardo Galvão que revisaram dezenas de submissões para o JavaOne e ajudaram a aprovar tantas palestras, e também misturar um pouco da minha experiência na seleção de palestras nos eventos realizados pela Globalcode e SouJava . 10 anos de JavaOne: http://www.globalcode.com.br/noticias/Globalcode10AnosNoJavaOne Os palestrantes ganham a entrada! A submissão pode ser feita em português! O passo mais importante para ser aprovado como palestrante no JavaOne é sem dúvida nenhuma submeter pelo menos uma palestra. Então, independente de qualquer coisa, participe, arrisque, divulgue.  Mas, se quiser aumentar as suas chances...   1) Leve a sério: peça para amigos fazerem uma leitura crítica do texto, e claro uma boa revisão ortográfica. 2) Submissão de várias palestras ou variações do ...
3 comentários
Leia mais