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

Você já pensou em ser palestrante em algum evento ?

Você já deve ter participado de algum evento e pensado como deve ser legal ser palestrante... E para falar a verdade, é muito bom mesmo. Eu adoro, o Vinicius adora e conheço muitas pessoas que curtem cada minuto da participação no evento como palestrante. Com certeza é uma responsabilidade a mais. Você sente medo, adrenalina, tem que se preparar. Literalmente coloca a cara a tapa para qualquer pessoa te avaliar em todos os sentidos. Qual o seu tom de voz?  Seus slides são legais? Você manja mesmo ?  Seu português está ok?  E as palavras em inglês ?  Teve algum deslize técnico? E MUITO mais.  Mas é claro que a exposição tem dois lados... e os resultados podem ser ótimos. Normalmente conhecemos mais pessoas como palestrantes e podem surgir boas oportunidades de negócio. É sempre positivo ter uma nova referência positiva quando as pessoas buscam nosso nome no Google, podemos fazer a diferença para quem está assistindo a palestra e muito mais.  No The Developer's

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

Inscrever sua equipe em eventos de TI vale a pena? Entenda aqui

Os eventos de TI são importantes para o aprendizado contínuo, especialmente em uma área tão dinâmica, como a de tecnologia. A necessidade de estar sempre por dentro das tendências pode esbarrar em algumas objeções, como investir em especializações pouco práticas ou opções pulverizadas de mercado. Por isso, participar de conferências e assistir palestras de especialistas é uma excelente oportunidade para sua equipe se desenvolver. O melhor de participar de eventos de TI é expandir os conhecimentos e habilidades independentemente da experiência específica, seja um desenvolvedor web ou full stack, por exemplo, as conferências de tecnologia podem ajudar o profissional a se aperfeiçoar. Isso ocorre devido ao contato com outros especialistas e colegas da mesma área. Além disso, é possível descobrir novas soluções e fazer networking . Neste artigo, você conhecerá as vantagens da sua equipe participar em eventos de TI. Aproveite a leitura! Vantagens de participar de eventos de TI Se o seu ob

Entendendo como funciona a programação de computadores: linguagens de programação, lógica, banco de dados

Nesse post, diferente dos últimos que foram mais enfáticos nas experiências com tecnologias, vou focar um pouco mais nos profissionais que estão começando, ou pretendem ingressar na área de desenvolvimento de software, falando sobre conceitos fundamentais relacionados a programação em geral . Mercado de trabalho para programação Conforme já sabemos, o mercado de desenvolvimento de software, especialmente no Brasil, continua em franca expansão, sendo que cada vez mais as empresas buscam desenvolver seus próprios sistemas usando as mais diferentes e novas tecnologias. Algumas matérias interessantes: As seis profissões mais valorizadas em 2010 no IDG Now! Muitas vagas e sensação de reaquecimento da economia Por isso, a área de desenvolvimento de software tem despertado interesse em muitos profissionais de outras áreas que desejam mudar de profissão, já que as oportunidades de trabalho tendem a ser maiores. Esse é um perfil presente em muitos dos clientes da Globalcode que acabou m

Segurança da informação no alvo: o que esperar do futuro?

A segurança da informação não se trata apenas de proteger os dados contra acesso não autorizado. Na prática, refere-se aos recursos que impedem: uso; registro; inspeção; divulgação; interrupção; modificação; destruição de dados. O uso de dados pode abranger desde um perfil nas redes sociais a detalhes financeiros, biometrias ou novos projetos. Por isso, a preocupação com a proteção dos dados é crescente, tanto para empresas quanto clientes. Para muitas pessoas, a coleta de dados é considerada invasão de privacidade, criando desconfiança do titular dos dados, pois o uso dos dados pode ser facilmente corrompido, utilizado para fins não declarados. Apesar de o uso dos dados terem impulsionado os avanços tecnológicos na última década, as organizações lidam com o desafio de distinguir dados de informações pessoais de modo a proteger a privacidade e as preferências dos clientes. Neste artigo, abordaremos o impacto da segurança da informação e o que esperar do futuro. Confira casos conhecido

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