Pular para o conteúdo principal

Criação de consultas com o Spring Roo

No post Bastidores do Spring Roo: A camada de persistência descrevi como o Spring Roo cria e mantém a camada de persistencia de um aplicativo Java para Web, usando como exemplo um CRUD de Produtos. Porém, deixei de fora propositalmente, algumas funcionalidades interessantes do Roo ainda na área de persistência. Nesse post vou demonstrar como implementar funcionalidade de pesquisa em uma aplicação através do Spring Roo.

O Spring Roo disponibiliza o comando finder para criar consultas via linha de comando, no shell. O finder gera toda estrutura necessária para implementar uma funcionalidade de pesquisa em uma entidade, desde o método Java com código JPA-QL, passando pela controller até chegar na página web.


Demo: a entidade Produto
Para testar essa funcionalidade do Roo, vou relembrar um trecho do exemplo usado no post anterior, a criação da entidade Produto. Os comandos a seguir são executados no shell do Roo para criar Produto com descrição e o valor:
roo> entity --class ~.model.Produto 
roo> field string --fieldName descricao --notNull
roo> field number --type java.lang.Double --fieldName preco --min 1

O finder pode ser usado de duas maneiras, a primeira delas para listar quais são as opções de consulta a partir de uma entidade. Veja o exemplo:
roo> finder list --class ~.model.Produto

findProdutoesByDescricao(String descricao)
findProdutoesByDescricaoEquals(String descricao)
findProdutoesByDescricaoIsNotNull()
findProdutoesByDescricaoIsNull()
findProdutoesByDescricaoLike(String descricao)
findProdutoesByDescricaoNotEquals(String descricao)
findProdutoesByPreco(Double preco)
findProdutoesByPrecoBetween(Double minPreco, Double maxPreco)
findProdutoesByPrecoEquals(Double preco)
findProdutoesByPrecoGreaterThan(Double preco)
findProdutoesByPrecoGreaterThanEquals(Double preco)
findProdutoesByPrecoIsNotNull()
findProdutoesByPrecoIsNull()
findProdutoesByPrecoLessThan(Double preco)
findProdutoesByPrecoLessThanEquals(Double preco)
findProdutoesByPrecoNotEquals(Double preco)

O finder list mostra as opções de consultas do Produto levando em consideração os atributos definidos na classe. A propriedade class é opcional, não precisa ser indicada se o cursor, no shell, estiver posicionado na entidade. Esse comando suporta outras duas propriedades:
  • depth: indica a profundidade para as combinações dos atributos, padrão é 1. Veja o que acontece repetindo o comando acima com: --depth 2
  • filter: filtro que indica o atributo que o finder deve listar.
Veja um exemplo com o atributo filter:
roo> finder list --class ~.model.Produto --filter preco             

findProdutoesByPreco(Double preco)
findProdutoesByPrecoBetween(Double minPreco, Double maxPreco)
findProdutoesByPrecoEquals(Double preco)
findProdutoesByPrecoGreaterThan(Double preco)
findProdutoesByPrecoGreaterThanEquals(Double preco)
findProdutoesByPrecoIsNotNull()
findProdutoesByPrecoIsNull()
findProdutoesByPrecoLessThan(Double preco)
findProdutoesByPrecoLessThanEquals(Double preco)
findProdutoesByPrecoNotEquals(Double preco)

Agora que sabemos quais são as opções de consulta, é possível usar o outro comando do finder para criar a consulta. No exemplo a seguir uso o comando finder add para criar a consulta de Produtos com filtro em preço mínimo e máximo. Na propriedade finderName indicamos qual é a consulta.
roo> finder add --class ~.model.Produto --finderName findProdutoesByPrecoBetween                  

Updated SRC_MAIN_JAVA/br/com/yaw/produtos/model/Produto.java
Created SRC_MAIN_WEBAPP/WEB-INF/views/produtoes/findProdutoesByPrecoBetween.jspx
Updated SRC_MAIN_WEBAPP/WEB-INF/views/menu.jspx
Updated SRC_MAIN_WEBAPP/WEB-INF/views/produtoes/views.xml
Updated SRC_MAIN_WEBAPP/WEB-INF/i18n/application.properties
Created SRC_MAIN_JAVA/br/com/yaw/produtos/model/Produto_Roo_Finder.aj
Updated SRC_MAIN_JAVA/br/com/yaw/produtos/web/ProdutoController_Roo_Controller.aj
Um detalhe importante: estou considerando que a camada web do projeto foi criada (controller all).

Repare no log do shell que o Roo atualizou o menu de navegação, o arquivo properties (i18n), o aspecto da camada controller e criou a página findProdutoesByPrecoBetween.jspx para o usuário executar a consulta.


O Roo muda a anotação @RooEntity da classe Produto, indicando que a entidade utiliza o finder findProdutoesByPrecoBetween. A partir daí o Roo cria um outro aspecto Produto_Roo_Finder.aj para concentrar todas as consultas do Produto, seguindo a mesma estratégia de manipulação do código via aspectos. Veja o código do aspecto:
...
privileged aspect Produto_Roo_Finder {
    
    public static TypedQuery<Produto> Produto.findProdutoesByPrecoBetween(Double minPreco, Double maxPreco) {
        if (minPreco == null) 
          throw new IllegalArgumentException("The minPreco argument is required");
        if (maxPreco == null) 
          throw new IllegalArgumentException("The maxPreco argument is required");

        EntityManager em = Produto.entityManager();
        TypedQuery<Produto> q = em.createQuery("SELECT p FROM Produto AS p "+
          "WHERE p.preco BETWEEN :minPreco AND :maxPreco", Produto.class);
        q.setParameter("minPreco", minPreco);
        q.setParameter("maxPreco", maxPreco);
        return q;
    }   
}

O método findProdutoesByPrecoBetween será compilado, junto com os outros aspectos, na classe Produto.class. Da mesma forma que ocorre com os outros aspectos do Roo, vale a pena rever o diagrama que ilustra como o Roo manipula o código.

Além do finder
O finder quebra um tremendo galho, mas não cobre todas as possibilidades de consultas. Imagine por exemplo que é necessário criar uma consulta para retornar uma soma dos valores de todos os produtos cadastrados, o finder não gera essa consulta e nesse caso vamos sujar as mãos com um pouco de código. O conteúdo JPA-QL para essa consulta é extremamente simples, o código seria algo como:
...
    public static Number getSumPreco() {
        EntityManager em = Produto.entityManager();
        Query q = em.createQuery("SELECT SUM(p.preco) FROM Produto AS p");
        return (Number) q.getSingleResult();
    }
...

Mas a questão aqui é outra, qual é o lugar certo para escrever esse método? Lembre-se de que NUNCA devemos manipular o conteúdo de um aspecto gerado pelo Spring Roo, e de que o Roo não usa DAOs. Seguindo a linha do ActiveRecord, afinal todo código ORM do Roo é compilado na classe da entidade, o lugar mais indicado é a classe Produto.

Uma questão sobre o Design
Explorando um pouco mais esse cenário, pensando no design e organização do projeto, imagine uma aplicação maior, tanto em tamanho quanto em complexidade, com queries criadas pelo finder e outras escritas na mão. Como fica a organização do código?

Me deparei com uma situação dessa em um projeto que desenvolvi com o Roo, naquela ocasião a equipe não se sentiu confortável em lidar com uma parte do código em aspectos e outra no código Java. Em alguns momentos isso gerou uma certa confusão.

A solução mais interessante para aquele caso foi colocar todo o código das consultas, gerados ou não pelo finder, na entidade. Ainda usávamos o finder para gerar boa parte das consultas, mas passamos a copiar os métodos gerados pelo Roo para a classe (entidade) Java.

Uma característica interessante do Roo é de ele não gera código redundante. Caso o desenvolvedor implemente um método que foi, ou ainda será, implemetando pelo Roo a ferramenta descarta a criação desse método, além disso se o método já foi escrito no aspecto o Roo elimina esse código.

Vou discutir sobre engenharia reversa no Roo em um terceiro 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

Melhorando Performance de JPA com Spring Web Flow

No TDC2009 realizado pela Globalcode em São Paulo foi apresentado um Lightning Talk sobre um problema específico de performance em aplicações Web com JPA e uma possível solução usando o Spring Web Flow . Num período de 15 minutos, os slides a seguir foram apresentados e seguidos de alguns vídeos de demonstração de uma aplicação Web em execução. Melhorando performance do JPA com Spring Web Flow View more presentations from Dr. Spock . Nesta apresentação foi dito que temos encontrado problemas de performance em aplicações Web que utilizam as tecnologias JSF + JPA + Ajax quando precisamos gerenciar um contexto de persistência (EntityManager). Estes problemas se manifestam quando aplicamos uma resposta errada para a pergunta: Como gerenciar o contexto de persistência numa aplicação Web? Se as aplicações não usam Ajax e limitam-se ao modelo orientado a requisições, a solução mais comum é o uso do design pattern chamado "Open Session In View Filter". Através deste design

Dica rápida: Apagando registros duplicados no MySQL

Ola pessoal, Sei que vocês estão acostumados a ver posts meus sobre tecnologia móvel ou algo relacionado, mas hoje vou falar sobre um pequeno "truque" que usei esse final de semana com o MySQL. Eu estava desenvolvendo o lado servidor de uma nova aplicação mobile (ahh, então "tem a ver" com mobile hehe), e quando fui fazer alguns testes percebi que tinha quase 7 mil registros duplicados (!!!) na minha base de dados! Bom, o meu primeiro reflexo como programador foi pensar em fazer um "programinha" Java para buscar e deletar todos esses registros duplicados. Mas ai, resolvi tirar as teias de aranha dos neurônios e usar os vários anos de experiência que passei com SQL e criar uma query que fizesse esse trabalho todo de uma vez!! E a query ficou assim: delete from TABLE_NAME USING  TABLE_NAME, TABLE_NAME  AS  auxtable WHERE   ( NOT  TABLE_NAME.id  =  auxtable.id ) AND   ( TABLE_NAME.name  =  auxtable.name ) Explicação direta: TABLE_NAME

O que é Lógica de programação?

Este é o segundo de uma série de posts voltados aos leitores do blog que estão dando início à carreira de desenvolvimento de software. O assunto de hoje é a lógica de programação. Para ler antes: Entendendo como funciona a programação de computadores: linguagens de programação, lógica, banco de dados A lógica de programação é um pré-requisito para quem quer se tornar um desenvolvedor de software, independente da linguagem de programação que se pretende utilizar. Mas o que é de fato a Lógica de Programação e como saber se eu tenho esse pré-requisito? A lógica de programação nada mais é do que a organização coerente das instruções do programa para que seu objetivo seja alcançado. Para criar essa organização, instruções simples do programa, como mudar o valor de uma variável ou desenhar uma imagem na tela do computador, são interconectadas a estruturas lógicas que guiam o fluxo da execução do programa. Isso é muito próximo ao que usamos em nosso cotidiano para realizar atividad

10 reasons why we love JSF

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

Devo fazer um curso ou ler um livro?

Acredito que todos os instrutores ou professores, independentemente da área, escola ou centro de treinamento, já devam ter recebido essa pergunta alguma vez na vida: devo fazer um curso ou ler um livro? Para responder a essa pergunta, precisamos avaliar os prós e contras de cada opção. Trabalho com treinamento há algum tempo e, hoje, recebi essa pergunta de um aluno. Não adianta responder a ou b sem argumentar, demonstrando as opções conforme a situação do aluno. O conteúdo, a forma de transmissão e a capacidade de assimilação do indivíduo são chaves para haver benefício maior de aprendizado. Tanto em um bom curso quanto em um bom livro, o conteúdo é a premissa básica . Por conteúdo entendemos: se está organizado; se respeita pré-requisitos; se promove o aprendizado guiado e incremental; se aborda de forma satisfatória os principais pontos; se tem bom balanço entre teoria, exemplos e prática (favorecendo exemplos e prática); se tem como premissa a acessibilidade possível (e cabível) pa

JavaMail: Enviando mensagem HTML com anexos

Introdução Depois do post "JavaMail: Enviando e-mail com Java" , que apresentava como enviar um e-mail com Java, resolvi complementar a assunto apresentando como enviar uma mensagem formatada, em HTML , e também como realizar o envio de anexos. Bibliotecas Além da biblioteca JavaMail, veja mais no post anterior , é necessário incluir o JavaBeans Activation Framework (JAF), apenas se a versão utilizada for anterior ao JSE 6.0 , que já tem o JAF incluso. O JAF está disponível em http://www.oracle.com/technetwork/java/javase/downloads/index-135046.html , e neste download encontramos, alguns exemplos na pasta demo , documentação, incluindo javadocs, na pasta docs e a biblioteca activation.jar , que deve ser acrescentada no classpath da aplicação para versões anteriores ao JSE 6.0. Exemplo Primeiramente devemos realizar a configuração da javax.mail.Session e da javax.mail.internet.MimeMessage , estes passos podem ser vistos no post anterior . Agora vamos montar um