QuerydslWebサポートを備えたRESTクエリ言語

投稿日: 2019-10-19 2022-11-09
タグ: Persistence, REST, REST Query Language, Spring

1. 概要

このクイックチュートリアルでは、Spring DataQuerydslWebサポートについて説明します。

これは、メインのRESTクエリ言語シリーズで焦点を当てた他のすべての方法に代わる興味深い方法です。

2. Maven構成

まず、Mavenの構成から始めましょう。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.3.0.RELEASE</version>
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-commons</artifactId>
    </dependency>
    <dependency>
        <groupId>com.mysema.querydsl</groupId>
        <artifactId>querydsl-apt</artifactId>
        <version>${querydsl.version}</version>
    </dependency>
    <dependency>
        <groupId>com.mysema.querydsl</groupId>
        <artifactId>querydsl-jpa</artifactId>
        <version>${querydsl.version}</version>
    </dependency>
...

Querydsl Webサポートは、 spring-data-commons since 1.11で利用可能であることに注意してください。

3. ユーザーリポジトリ

次に、リポジトリを見てみましょう。

public interface UserRepository extends 
  JpaRepository<User, Long>, QueryDslPredicateExecutor<User>, QuerydslBinderCustomizer<QUser> {
    @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);
    }
}

ご了承ください：

QuerydslBinderCustomizer customize（）をオーバーライドして、デフォルトのバインディングをカスタマイズします
すべてのStringプロパティの大文字と小文字を無視するように、デフォルトのequalsバインディングをカスタマイズしています
また、述語の解決からユーザーのメールを除外しています

完全なドキュメントここをチェックしてください。

4. ユーザーコントローラー

それでは、コントローラーを見てみましょう。

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

これは興味深い部分です。@QuerydslPredicateアノテーションを使用して、HttpRequestから直接述語を取得していることに注目してください。

このタイプのクエリを含むURLは次のようになります。

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

そして、潜在的な応答がどのように構造になるかを次に示します。

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

5. ライブテスト

最後に、新しいQuerydslWebサポートをテストしてみましょう。

@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");
    }
}

まず、システム内のすべてのユーザーを取得しましょう。

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

次に、名でユーザーを検索しましょう。

@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());
}

次に、部分的な名前でユーザーを見つけないようにします。

@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);
}

それでは、emailでユーザーを見つけてみましょう。

@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);
}

注：電子メールでユーザーを検索しようとすると、述語の解決からユーザーの電子メールを除外したため、クエリは無視されました。

6. 結論

この記事では、Spring Data Querydsl Webサポートの概要と、HTTPリクエストから直接 Predicate を取得し、それを使用してデータを取得するためのクールでシンプルな方法について説明しました。

getdocs

13036