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

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 é