SpringDataJPAおよびQuerydslを使用したRESTクエリ言語

投稿日: 2019-10-19 2022-10-27
タグ: JPA, REST, REST Query Language, Spring Data

1. 概要

このチュートリアルでは、Spring DataJPAとQuerydslを使用してRESTAPIのクエリ言語を構築する方法について説明します。

このシリーズの最初の2つの記事では、JPA基準とSpringDataJPA仕様を使用して同じ検索/フィルタリング機能を構築しました。

そう – なぜクエリ言語なのか？なぜなら、十分に複雑なAPIの場合、非常に単純なフィールドでリソースを検索/フィルタリングするだけでは不十分だからです。 クエリ言語はより柔軟で、必要なリソースに正確に絞り込むことができます。

2. Querydsl構成

まず、Querydslを使用するようにプロジェクトを構成する方法を見てみましょう。

pom.xmlに次の依存関係を追加する必要があります。

<dependency> 
    <groupId>com.querydsl</groupId> 
    <artifactId>querydsl-apt</artifactId> 
    <version>4.2.2</version>
    </dependency>
<dependency> 
    <groupId>com.querydsl</groupId> 
    <artifactId>querydsl-jpa</artifactId> 
    <version>4.2.2</version> 
</dependency>

また、APT –注釈処理ツール–プラグインを次のように構成する必要があります。

<plugin>
    <groupId>com.mysema.maven</groupId>
    <artifactId>apt-maven-plugin</artifactId>
    <version>1.1.3</version>
    <executions>
        <execution>
            <goals>
                <goal>process</goal>
            </goals>
            <configuration>
                <outputDirectory>target/generated-sources/java</outputDirectory>
                <processor>com.mysema.query.apt.jpa.JPAAnnotationProcessor</processor>
            </configuration>
        </execution>
    </executions>
</plugin>

これにより、エンティティのQ-typesが生成されます。

**3. MyUserエンティティ**

次へ–SearchAPIで使用する「MyUser」エンティティを見てみましょう。

@Entity
public class MyUser {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;

    private String firstName;
    private String lastName;
    private String email;

    private int age;
}

4. カスタム述語With PathBuilder

それでは、任意の制約に基づいてカスタム述語を作成しましょう。

ここでは、自動生成されたQタイプの代わりに PathBuilder を使用しています。これは、より抽象的な使用法のためにパスを動的に作成する必要があるためです。

public class MyUserPredicate {

    private SearchCriteria criteria;

    public BooleanExpression getPredicate() {
        PathBuilder<MyUser> entityPath = new PathBuilder<>(MyUser.class, "user");

        if (isNumeric(criteria.getValue().toString())) {
            NumberPath<Integer> path = entityPath.getNumber(criteria.getKey(), Integer.class);
            int value = Integer.parseInt(criteria.getValue().toString());
            switch (criteria.getOperation()) {
                case ":":
                    return path.eq(value);
                case ">":
                    return path.goe(value);
                case "<":
                    return path.loe(value);
            }
        } 
        else {
            StringPath path = entityPath.getString(criteria.getKey());
            if (criteria.getOperation().equalsIgnoreCase(":")) {
                return path.containsIgnoreCase(criteria.getValue().toString());
            }
        }
        return null;
    }
}

述語の実装が一般的に複数のタイプの操作を処理していることに注意してください。これは、クエリ言語が定義上オープン言語であり、サポートされている操作を使用して、任意のフィールドでフィルタリングできる可能性があるためです。

この種のオープンフィルタリング基準を表すために、シンプルですが非常に柔軟な実装を使用しています– SearchCriteria ：

public class SearchCriteria {
    private String key;
    private String operation;
    private Object value;
}

SearchCriteria は、制約を表すために必要な詳細を保持します。

key ：フィールド名–例： firstName 、 age 、…など
operation ：操作–例：Equality、less than、…など
value ：フィールド値–例：john、25、…など

5. MyUserRepository

それでは、MyUserRepositoryを見てみましょう。

MyUserRepositoryを拡張してQuerydslPredicateExecutorを拡張し、後でPredicatesを使用して検索結果をフィルタリングできるようにする必要があります。

public interface MyUserRepository extends JpaRepository<MyUser, Long>, 
  QuerydslPredicateExecutor<MyUser>, QuerydslBinderCustomizer<QMyUser> {
    @Override
    default public void customize(
      QuerydslBindings bindings, QMyUser root) {
        bindings.bind(String.class)
          .first((SingleValueBinding<StringPath, String>) StringExpression::containsIgnoreCase);
        bindings.excluding(root.email);
      }
}

ここでは、 MyUser エンティティ用に生成されたQタイプを使用していることに注意してください。これは、QMyUser。という名前になります。

6. 述語を組み合わせる

次に、結果のフィルタリングで複数の制約を使用するために述語を組み合わせる方法を見てみましょう。

次の例では、ビルダー– MyUserPredicatesBuilder –を使用して、述語を結合します。

public class MyUserPredicatesBuilder {
    private List<SearchCriteria> params;

    public MyUserPredicatesBuilder() {
        params = new ArrayList<>();
    }

    public MyUserPredicatesBuilder with(
      String key, String operation, Object value) {
  
        params.add(new SearchCriteria(key, operation, value));
        return this;
    }

    public BooleanExpression build() {
        if (params.size() == 0) {
            return null;
        }

        List predicates = params.stream().map(param -> {
            MyUserPredicate predicate = new MyUserPredicate(param);
            return predicate.getPredicate();
        }).filter(Objects::nonNull).collect(Collectors.toList());
        
        BooleanExpression result = Expressions.asBoolean(true).isTrue();
        for (BooleanExpression predicate : predicates) {
            result = result.and(predicate);
        }        
        return result;
    }
}

7. 検索クエリをテストする

次へ–SearchAPIをテストしましょう。

数人のユーザーでデータベースを初期化することから始めます–これらを準備してテストに利用できるようにします：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { PersistenceConfig.class })
@Transactional
@Rollback
public class JPAQuerydslIntegrationTest {

    @Autowired
    private MyUserRepository repo;

    private MyUser userJohn;
    private MyUser userTom;

    @Before
    public void init() {
        userJohn = new MyUser();
        userJohn.setFirstName("John");
        userJohn.setLastName("Doe");
        userJohn.setEmail("[email protected]");
        userJohn.setAge(22);
        repo.save(userJohn);

        userTom = new MyUser();
        userTom.setFirstName("Tom");
        userTom.setLastName("Doe");
        userTom.setEmail("[email protected]");
        userTom.setAge(26);
        repo.save(userTom);
    }
}

次に、名前がのユーザーを見つける方法を見てみましょう。

@Test
public void givenLast_whenGettingListOfUsers_thenCorrect() {
    MyUserPredicatesBuilder builder = new MyUserPredicatesBuilder().with("lastName", ":", "Doe");

    Iterable<MyUser> results = repo.findAll(builder.build());
    assertThat(results, containsInAnyOrder(userJohn, userTom));
}

次に、givenの名前と姓の両方がのユーザーを見つける方法を見てみましょう。

@Test
public void givenFirstAndLastName_whenGettingListOfUsers_thenCorrect() {
    MyUserPredicatesBuilder builder = new MyUserPredicatesBuilder()
      .with("firstName", ":", "John").with("lastName", ":", "Doe");

    Iterable<MyUser> results = repo.findAll(builder.build());

    assertThat(results, contains(userJohn));
    assertThat(results, not(contains(userTom)));
}

次に、指定された名前と最小年齢の両方を持つユーザーを見つける方法を見てみましょう。

@Test
public void givenLastAndAge_whenGettingListOfUsers_thenCorrect() {
    MyUserPredicatesBuilder builder = new MyUserPredicatesBuilder()
      .with("lastName", ":", "Doe").with("age", ">", "25");

    Iterable<MyUser> results = repo.findAll(builder.build());

    assertThat(results, contains(userTom));
    assertThat(results, not(contains(userJohn)));
}

それでは、が実際には存在しない MyUserを検索する方法を見てみましょう。

@Test
public void givenWrongFirstAndLast_whenGettingListOfUsers_thenCorrect() {
    MyUserPredicatesBuilder builder = new MyUserPredicatesBuilder()
      .with("firstName", ":", "Adam").with("lastName", ":", "Fox");

    Iterable<MyUser> results = repo.findAll(builder.build());
    assertThat(results, emptyIterable());
}

最後に、次の例のように、名の一部のみが指定された MyUserを見つける方法を見てみましょう。

@Test
public void givenPartialFirst_whenGettingListOfUsers_thenCorrect() {
    MyUserPredicatesBuilder builder = new MyUserPredicatesBuilder().with("firstName", ":", "jo");

    Iterable<MyUser> results = repo.findAll(builder.build());

    assertThat(results, contains(userJohn));
    assertThat(results, not(contains(userTom)));
}

8. UserController

最後に、すべてをまとめてRESTAPIを構築しましょう。

クエリ文字列を渡すための「search」パラメータを使用して、単純なメソッド findAll（）を定義するUserControllerを定義しています。

@Controller
public class UserController {

    @Autowired
    private MyUserRepository myUserRepository;

    @RequestMapping(method = RequestMethod.GET, value = "/myusers")
    @ResponseBody
    public Iterable<MyUser> search(@RequestParam(value = "search") String search) {
        MyUserPredicatesBuilder builder = new MyUserPredicatesBuilder();

        if (search != null) {
            Pattern pattern = Pattern.compile("(\w+?)(:|<|>)(\w+?),");
            Matcher matcher = pattern.matcher(search + ",");
            while (matcher.find()) {
                builder.with(matcher.group(1), matcher.group(2), matcher.group(3));
            }
        }
        BooleanExpression exp = builder.build();
        return myUserRepository.findAll(exp);
    }
}

簡単なテストURLの例を次に示します。

http://localhost:8080/myusers?search=lastName:doe,age>25

そして応答：

[{
    "id":2,
    "firstName":"tom",
    "lastName":"doe",
    "email":"[email protected]",
    "age":26
}]

9. 結論

この3番目の記事では、Querydslライブラリをうまく利用して、 RESTAPIのクエリ言語を構築する最初のステップについて説明しました。

もちろん、実装は初期段階ですが、追加の操作をサポートするように簡単に進化させることができます。

この記事の完全実装は、 GitHubプロジェクトにあります。これはMavenベースのプロジェクトであるため、そのままインポートして実行するのは簡単です。

getdocs

13036