1. 概要

この新しいシリーズのこの最初の記事では、 RESTAPIの単純なクエリ言語について説明します。 REST APIにはSpringを、永続性の側面にはJPA2基準をうまく利用します。

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

2. ユーザーエンティティ

まず、フィルター/検索APIに使用する単純なエンティティである基本的なユーザーを提案しましょう。

@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 than、…など。
  • value :フィールド値を保持するために使用されます-例:john、25、…など。

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

次に、次の例のように、特定のfirstNamelastNameを持つ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を持つUserListを取得しましょう。

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

次に、年齢が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

最後に、この柔軟な検索の永続性サポートをRESTAPIに接続しましょう。

単純な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. 結論

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

この記事の完全な実装は、GitHubプロジェクトにあります。