Pular para o conteúdo principal

Bastidores do Spring Roo: A camada de persistência

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

Comentários

Postagens mais visitadas deste blog

Palestras do TDC Business Disponíveis Online

🚨 Atenção, TDC Lovers! O TDC Business em São Paulo acabou, mas os conteúdos mal começaram!  Não pô de aproveitar a STADIUM ao vivo? Não tem problema, porque trouxemos ela até você. Todas as palestras da STADIUM, palco principal do TDC, já estão no ar e liberadas para qualquer pessoa assistir. Essa Trilha incrível conta com palestras de Trilhas Premium e temas variados de forma GRATUITA para você poder maratonar de casa!  Aproveite para prestigiar seu evento de TI favorito com pipoca direto do seu sofá. 🎥 🍿 Gravação da STADIUM, 22 a 24 de Agosto de 2022, disponível aqui: https://www.globalcode.com.br/videos/tdc-2022-business/  Todas as demais trilhas do TDC Business serão publicadas gradualmente nas próximas semanas, fique atento aos nossos e-mails, você será notificado por lá quando sua Trilha estiver disponível. Acompanhe nossas redes sociais para não perder nada e ficar por dentro de todas as novidades do TDC!

TDC INNOVATION lança University Pass

Modalidade de ingresso tem como objetivo ajudar na capacitação dos universitários Uma pesquisa realizada em 2020 pela Associação Brasileira das Empresas de Tecnologia da Informação e Comunicação (Brasscom) diz que até o ano de 2024 o Brasil precisará de cerca de 420 mil profissionais na área de Tecnologia da Informação. Porém, por ano, a mesma pesquisa diz que o país forma apenas 46 mil profissionais capacitados no nicho. Pensando nisso, para ajudar na formação e capacitação desses jovens profissionais, o TDC INNOVATION, segunda edição do ano do The Developer's Conference, lança o University Pass, modalidade de ingresso que possibilita aceso digital gratuito a todas as palestras do evento, ou com 50% de desconto para quem preferir ir pessoalmente. Com o tema central “Desafios para a criação do futuro Digital”, o TDC INNOVATION ocorrerá entre 1 e 3 de junho, de forma híbrida: presencialmente no Centro de Convenções CentroSul, em Florianópolis, e com transmissão simultaneamente pela

TDC Digital: o que você precisa saber para transformar sua carreira em 2022

O TDC Digital é o maior evento de TI do mercado e proporciona crescimento profissional a partir de palestras com especialistas e oportunidades de networking com o mundo todo, direto da sua casa. Através da escolha individual de cada participante é possível obter experiências imersivas e transformadoras conforme o tema-chave de cada trilha.  O evento também é o lugar ideal para ajudar no desenvolvimento de carreiras, permitindo que qualquer pessoa com vontade — e um tema interessante — seja palestrante e compartilhe suas experiências e conhecimentos. Para aqueles que querem  participar como ouvinte a plataforma do TDC favorece conferências dinâmicas, e o encontro de diversas comunidades e ecossistemas de TI. E, após a escolha de uma trilha, fica mais fácil acompanhar especialistas para aprender e se inspirar. Em 2021 , o The Developer’s Conference (TDC) foi 100% digital e, em três dias de evento, contou com mais de 300 horas de conteúdos , incluindo: Agile; Testes; Design; Web e Mobile;

TDC ONLINE: SUA PLATAFORMA DE PALESTRAS GRAVADAS DO TDC DISPONÍVEL

Além do conteúdo ao vivo transmitido online nas edições do TDC, agora você pode ter acesso à centenas de palestras gravadas, através da nossa nova plataforma de vídeos - o TDC Online, que reúne todas as Trilhas premium, Stadium e Salas dos Patrocinadores das edições anteriores de 2022, TDC Innovation e TDC Connections.  Para acessar, basta clicar na edição em que você participou ( TDC Innovation ou TDC Connections ); Fazer o mesmo login (com e-mail e senha) cadastrados na hora de adquirir ou resgatar o seu ingresso no TDC; E clicar na Trilha de sua opção, e de acordo com a modalidade do seu ingresso. Logo em seguida, você será direcionado para a seguinte página com a lista de todas as palestras por Trilha: Pronto! Agora você tem acesso à centenas de palestras gravadas da sua área de interesse, para assistir como e quando quiser! Caso tenha esquecido a senha, clique na opção "Esqueci a senha" , insira o e-mail que você realizou para o cadastro no evento, e aparecerá a op

Inspire a mudança com a liderança ágil

A liderança ágil é essencial para que uma organização realize mudanças de negócios significativas. Ser líder é uma tarefa desafiadora, especialmente em um cenário de constantes transformações, principalmente na forma de lidar com a relação empresa e pessoal. Pesquisas sobre liderança na era digital revelam que algumas soft skills têm sido substituídas por outras, o profundo conhecimento na área de negócio, ser referência nas tecnologias utilizadas, ter foco total no prazo e nas entregas e conhecer um arsenal de técnicas e ferramentas, têm dado espaço a habilidades, como: empatia; adaptabilidade; senso de equipe; visão e propósito; engajamento constante. A colaboração entre pessoas de todos os níveis hierárquicos são vitais, afinal, as equipes estão trabalhando para o mesmo objetivo: o encantamento e atendimento das necessidades do cliente que proporcionarão um crescimento sustentável da organização. Com propósito claro, estratégia e prioridades definidas, os times desfrutam de uma ma

Seja palestrante no TDC!

Os interessados em palestrar na maior plataforma de Inovação Aberta para desenvolvimento do ecossistema de teologia, tem até 25 de setembro para se inscrever A última edição do ano do TDC (The Developer's Conference), maior conferência para profissionais de tecnologia do Brasil, já tem data confirmada. O TDC Future, que acontece nos dias 6 a 8 de dezembro, em formato híbrido, ocorrerá presencialmente na UniRitter de Porto Alegre, e com transmissão simultânea pela plataforma Hopin. O evento traz como tema central: “O papel da tecnologia na construção do amanhã”, e reúne gestores, especialistas e profissionais da área para debater sobre o futuro da tecnologia, o impacto na vida das pessoas e seu papel na transformação da sociedade. A seleção de palestras nacionais e internacionais, ainda está com o Call4Papers aberto até 25 de setembro, os interessados em participar poderão submeter uma proposta por meio do site do evento . O tema deve estar vinculado a uma trilha específica, que é