SpringおよびJPAの基準を使用したRESTクエリー言語

1概要

リンクのこの最初の記事では、/spring-rest-api-query-search-language-tutorial[この新しいシリーズ]で、 REST API用の簡単なクエリー言語 を探ります。 REST APIにはSpringを、永続性にはJPA 2 Criteriaを利用します。

  • なぜクエリ言語なのか?** 複雑なAPIに対しては、非常に単純なフィールドでリソースを検索/フィルタリングするだけでは不十分です。クエリ言語はより柔軟であり、必要なリソースだけに絞り込むことができます。

2 ユーザー エンティティ

まず、フィルタ/検索APIに使用する単純なエンティティ、つまり基本的な User を紹介しましょう。

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

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

    private int age;
}

3 CriteriaBuilder を使用してフィルタリングする

それでは、問題の本質、つまり永続層のクエリについて詳しく説明します。

クエリーの抽象化を構築することはバランスの問題です。一方ではかなりの量の柔軟性を必要とし、他方では複雑さを管理可能に保つ必要があります。高レベルでは、機能は単純です - あなたはいくつかの制約を渡し、いくつかの結果を取り戻します。

それがどのように機能するのかを見てみましょう。

@Repository
public class UserDAO implements IUserDAO {

    @PersistenceContext
    private EntityManager entityManager;

    @Override
    public List<User> searchUser(List<SearchCriteria> params) {
        CriteriaBuilder builder = entityManager.getCriteriaBuilder();
        CriteriaQuery<User> query = builder.createQuery(User.class);
        Root r = query.from(User.class);

        Predicate predicate = builder.conjunction();

        UserSearchQueryCriteriaConsumer searchConsumer =
          new UserSearchQueryCriteriaConsumer(predicate, builder, r);
        params.stream().forEach(searchConsumer);
        predicate = searchConsumer.getPredicate();
        query.where(predicate);

        List<User> result = entityManager.createQuery(query).getResultList();
        return result;
    }

    @Override
    public void save(User entity) {
        entityManager.persist(entity);
    }
}

UserSearchQueryCriteriaConsumer クラスを見てみましょう。

public class UserSearchQueryCriteriaConsumer implements Consumer<SearchCriteria>{

    private Predicate predicate;
    private CriteriaBuilder builder;
    private Root r;

    @Override
    public void accept(SearchCriteria param) {
        if (param.getOperation().equalsIgnoreCase(">")) {
            predicate = builder.and(predicate, builder
              .greaterThanOrEqualTo(r.get(param.getKey()), param.getValue().toString()));
        } else if (param.getOperation().equalsIgnoreCase("<")) {
            predicate = builder.and(predicate, builder.lessThanOrEqualTo(
              r.get(param.getKey()), param.getValue().toString()));
        } else if (param.getOperation().equalsIgnoreCase(":")) {
            if (r.get(param.getKey()).getJavaType() == String.class) {
                predicate = builder.and(predicate, builder.like(
                  r.get(param.getKey()), "%" + param.getValue() + "%"));
            } else {
                predicate = builder.and(predicate, builder.equal(
                  r.get(param.getKey()), param.getValue()));
            }
        }
    }

   //standard constructor, getter, setter
}

ご覧のとおり、 searchUser APIは非常に単純な制約のリストを受け取り、これらの制約に基づいてクエリを作成し、検索を実行して結果を返します。

制約クラスも非常に単純です。

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

SearchCriteria 実装は、 Query パラメーターを保持しています。

  • key :フィールド名を保持するために使用されます - 例: firstName age 、…​

  • operation :操作を保持するために使用されます - 例えば:Equality、less

より、…​など

  • value :フィールドの値を保持するために使用されます。

4検索クエリをテストする

それでは、検索メカニズムをテストして、検索メカニズムに水が含まれていることを確認しましょう。

まず、次の例のように、2人のユーザーを追加して、テスト用にデータベースを初期化しましょう。

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { PersistenceConfig.class })
@Transactional
@TransactionConfiguration
public class JPACriteriaQueryTest {

    @Autowired
    private IUserDAO userApi;

    private User userJohn;

    private User userTom;

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

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

さて、次の例のように、特定の firstName lastName を持つ User を取得しましょう。

@Test
public void givenFirstAndLastName__whenGettingListOfUsers__thenCorrect() {
    List<SearchCriteria> params = new ArrayList<SearchCriteria>();
    params.add(new SearchCriteria("firstName", ":", "John"));
    params.add(new SearchCriteria("lastName", ":", "Doe"));

    List<User> results = userApi.searchUser(params);

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

次に、同じ lastName を持つ List User として取得しましょう。

@Test
public void givenLast__whenGettingListOfUsers__thenCorrect() {
    List<SearchCriteria> params = new ArrayList<SearchCriteria>();
    params.add(new SearchCriteria("lastName", ":", "Doe"));

    List<User> results = userApi.searchUser(params);
    assertThat(userJohn, isIn(results));
    assertThat(userTom, isIn(results));
}

次に、 age が25 以上のユーザーを取得しましょう。

@Test
public void givenLastAndAge__whenGettingListOfUsers__thenCorrect() {
    List<SearchCriteria> params = new ArrayList<SearchCriteria>();
    params.add(new SearchCriteria("lastName", ":", "Doe"));
    params.add(new SearchCriteria("age", ">", "25"));

    List<User> results = userApi.searchUser(params);

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

次に、 実際には存在しない ユーザーを検索しましょう。

@Test
public void givenWrongFirstAndLast__whenGettingListOfUsers__thenCorrect() {
    List<SearchCriteria> params = new ArrayList<SearchCriteria>();
    params.add(new SearchCriteria("firstName", ":", "Adam"));
    params.add(new SearchCriteria("lastName", ":", "Fox"));

    List<User> results = userApi.searchUser(params);
    assertThat(userJohn, not(isIn(results)));
    assertThat(userTom, not(isIn(results)));
}

最後に、 partial firstName のみが指定されたユーザーを検索しましょう。

@Test
public void givenPartialFirst__whenGettingListOfUsers__thenCorrect() {
    List<SearchCriteria> params = new ArrayList<SearchCriteria>();
    params.add(new SearchCriteria("firstName", ":", "jo"));

    List<User> results = userApi.searchUser(params);

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

6. UserController

最後に、この柔軟な検索のための永続化サポートをREST APIに接続しましょう。

単純な UserController を設定します - findAll() を使用して、検索/フィルタ式全体を渡します

@Controller
public class UserController {

    @Autowired
    private IUserDao api;

    @RequestMapping(method = RequestMethod.GET, value = "/users")
    @ResponseBody
    public List<User> findAll(@RequestParam(value = "search", required = false) String search) {
        List<SearchCriteria> params = new ArrayList<SearchCriteria>();
        if (search != null) {
            Pattern pattern = Pattern.compile("(\w+?)(:|<|>)(\w+?),");
            Matcher matcher = pattern.matcher(search + ",");
            while (matcher.find()) {
                params.add(new SearchCriteria(matcher.group(1),
                  matcher.group(2), matcher.group(3)));
            }
        }
        return api.searchUser(params);
    }
}

検索条件オブジェクトを検索式から作成する方法に注目してください。

これで、APIを使い始めて、すべてが正しく機能していることを確認できます。

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

そして、これがその反応です。

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

7. 結論

このシンプルで強力な実装により、REST APIでかなりスマートなフィルタリングが可能になります。はい - それはまだ概説ではなく、改善することができます(そして次の記事で改善されるでしょう) - しかし、あなたのAPIにこの種のフィルタリング機能を実装するための確かな出発点です。

この記事の 完全な実装 はhttps://github.com/eugenp/tutorials/tree/master/spring-rest-query-language[GitHubプロジェクト]にあります。インポートしてそのまま実行するのは簡単なはずです。

"