Linguagem de Consulta REST com Suporte da Web Querydsl

1. Visão geral

Neste tutorial rápido, discutiremos o Spring Data Querydsl Web Support.

Esta é definitivamente uma alternativa interessante para todas as outras maneiras que focamos emthe main REST Query Language series.

2. The Maven Config

Primeiro, vamos começar com nossa configuração maven:


    org.springframework.boot
    spring-boot-starter-parent
    1.3.0.RELEASE



    
        org.springframework.boot
        spring-boot-starter-web
    
    
        org.springframework.data
        spring-data-commons
    
    
        com.mysema.querydsl
        querydsl-apt
        ${querydsl.version}
    
    
        com.mysema.querydsl
        querydsl-jpa
        ${querydsl.version}
    
...

Observe que o suporte da web Querydsl está disponível emspring-data-commons desde1.11

3. O Repositório do Usuário

A seguir, vamos dar uma olhada em nosso repositório:

public interface UserRepository extends
  JpaRepository, QueryDslPredicateExecutor, QuerydslBinderCustomizer {
    @Override
    default public void customize(QuerydslBindings bindings, QUser root) {
        bindings.bind(String.class).first(
          (StringPath path, String value) -> path.containsIgnoreCase(value));
        bindings.excluding(root.email);
    }
}

Observe que:

Estamos substituindoQuerydslBinderCustomizercustomize() para personalizar a ligação padrão
Estamos personalizando a ligação padrãoequals para ignorar maiúsculas e minúsculas para todas as propriedadesString
Também excluímos o e-mail do usuário da resolução dePredicate

Confira a documentação completahere.

4. O controlador de usuário

Agora, vamos dar uma olhada no controlador:

@RequestMapping(method = RequestMethod.GET, value = "/users")
@ResponseBody
public Iterable findAllByWebQuerydsl(
  @QuerydslPredicate(root = User.class) Predicate predicate) {
    return userRepository.findAll(predicate);
}

Esta é a parte interessante - observe comowe’re obtaining a Predicate directly out of the HttpRequest, usando a anotação@QuerydslPredicate.

Esta é a aparência de um URL com esse tipo de consulta:

http://localhost:8080/users?firstName=john

E aqui está como uma resposta potencial seria a estrutura:

[
   {
      "id":1,
      "firstName":"john",
      "lastName":"doe",
      "email":"[email protected]",
      "age":11
   }
]

5. Teste ao vivo

Por fim, vamos testar o novo Suporte da Web Querydsl:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebAppConfiguration
public class UserLiveTest {

    private ObjectMapper mapper = new ObjectMapper();
    private User userJohn = new User("john", "doe", "[email protected]");
    private User userTom = new User("tom", "doe", "[email protected]");

    private static boolean setupDataCreated = false;

    @Before
    public void setupData() throws JsonProcessingException {
        if (!setupDataCreated) {
            givenAuth().contentType(MediaType.APPLICATION_JSON_VALUE)
                       .body(mapper.writeValueAsString(userJohn))
                       .post("http://localhost:8080/users");

            givenAuth().contentType(MediaType.APPLICATION_JSON_VALUE)
                       .body(mapper.writeValueAsString(userTom))
                       .post("http://localhost:8080/users");
            setupDataCreated = true;
        }
    }

    private RequestSpecification givenAuth() {
        return RestAssured.given().auth().preemptive().basic("user1", "user1Pass");
    }
}

Primeiro, vamos colocar todos os usuários no sistema:

@Test
public void whenGettingListOfUsers_thenCorrect() {
    Response response = givenAuth().get("http://localhost:8080/users");
    User[] result = response.as(User[].class);
    assertEquals(result.length, 2);
}

A seguir, vamos encontrar usuários porfirst name:

@Test
public void givenFirstName_whenGettingListOfUsers_thenCorrect() {
    Response response = givenAuth().get("http://localhost:8080/users?firstName=john");
    User[] result = response.as(User[].class);
    assertEquals(result.length, 1);
    assertEquals(result[0].getEmail(), userJohn.getEmail());
}

A seguir, para não encontrar usuários porpartial last name:

@Test
public void givenPartialLastName_whenGettingListOfUsers_thenCorrect() {
    Response response = givenAuth().get("http://localhost:8080/users?lastName=do");
    User[] result = response.as(User[].class);
    assertEquals(result.length, 2);
}

Agora, vamos tentar encontrar usuários poremail:

@Test
public void givenEmail_whenGettingListOfUsers_thenIgnored() {
    Response response = givenAuth().get("http://localhost:8080/users?email=john");
    User[] result = response.as(User[].class);
    assertEquals(result.length, 2);
}

Nota: Quando tentamos encontrar o usuário por e-mail - a consulta foi ignorada, porque excluímos o e-mail do usuário da resolução dePredicate.

6. Conclusão

Neste artigo, apresentamos uma introdução rápida ao Spring Data Querydsl Web Support e uma maneira simples e legal de obter umPredicate diretamente da solicitação HTTP e usando-o para recuperar dados.

TOC

Linguagem de Consulta REST com Suporte da Web Querydsl