Simplifique consultas no Hibernate com Query By Example

Para que o usuário possa escolher o Restaurante, ele vai poder pesquisar pelo nome, endereço e o tipo de comida que lhe interessar.

Considerando que todos os parâmetros estejam sempre preenchidos, poderíamos simplesmente escrever uma HQL para realizar a pesquisa, dado um objeto do tipo Restaurante:

Mas e se o usuário não soubesse que tipo de comida escolher, ou não soubesse o nome do restaurante? Para isso, precisamos fazer uma consulta considerando que os campos do filtro são opcionais.

Precisamos então de diversas condições no nosso código que verificam se as informações foram preenchidas:

Porém, para adicionar as condições na nossa query, estamos concatenando cada cláusula na string da HQL. Solução que evidentemente não é a mais adequada, pois além de deixar o código com diversos ifs, ainda é preciso tomar cuidado com espaços nas concatenações da HQL.

Para evitar toda essas concatenações, podemos utilizar a Criteria, do Hibernate. Com ela podemos simplesmente adicionar uma nova restrição caso a condição seja satisfeita.

Essa é uma solução que resolve nosso problema, mas quantas linhas foram necessárias para fazer esta consulta? Mesmo utilizando o Criteria ainda são 3 linhas de código para cada cláusula, dado que para cada parâmetro do filtro teríamos que fazer um if para adicionar a query. Claramente, já é melhor do que a concatenação de HQLs, mas será que ainda não dá para ficar melhor? E se pudessemos resolver nosso problema com apenas uma linha de código?

Não seria muito melhor se apenas passássemos para o Hibernate uma instância do Restaurante, com as informações que vierem populadas e ele descobrisse quais informações devem ser consideradas no filtro? Justamente para isso o Hibernate possui uma funcionalidade chamada Query By Example. Desta forma, ao invés de criarmos várias condições e adicionar uma Restriction em cada uma, podemos simplesmente adicionar um Example da seguinte forma:

Portanto, com apenas duas linhas (poderia ser uma linha se deixássemos a criação do Example inlined) conseguimos fazer a busca com base apenas nos campos preenchidos pelo nosso usuário. Ao executarmos essa Criteria, teremos o seguinte SQL gerado:

No entanto, executando o criteria acima é possível notar que todas as comparações feitas entre atributos foi com igual. Mas e se quisermos utilizar like? O Example permite que você configure a forma como ele fará as comparações. Para habilitar o like basta usar o método enableLike() e passar como parâmetro o MatchMode. Desta forma, se quisermos comparar string usando like e % no começo e fim de cada string, teríamos o seguinte código:

Executando novamente a query, veremos os likes sendo utilizados:

Assim, conseguimos realizar uma busca com campos opcionais para a classe Restaurante. Mas note que mesmo tendo adicionado as informações do tipo de comida dentro do objeto restaurante, ele está sendo ignorado no nosso filtro. O Example, por conta da Criteria, funciona sempre no nível do objeto pai (no caso o restaurante) e não desce para os filhos (no caso, o tipo de comida). Mas queremos deixar o tipo de comida como um campo do filtro.  Como adicionar esta restrição na nossa consulta?

Para resolver este problema basta usar a mesma ideia de quando é necessário adicionar restrições para um objeto de outro nível daquele considerado, ou seja, criar uma sub Criteria. Assim, depois de criar uma criteria para o tipo de comida basta adicionar um novo Example para esta instância. Portanto, temos o seguinte código:

E agora nossa consulta vai ser executada com o where completo:

Quando uma informação não for preenchida, ela será ignorada pelo where, sem você precisar ficar programando ifs intermináveis. Essa é a grande vantagem do Query By Example. E você já usou esse recurso em seus projetos? Quais outras funcionalidades do Hibernate você gosta?

Esse e diversos outros recursos do Hibernate e da JPA você aprende no nosso Curso Persistência com JPA, Hibernate e EJB lite