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

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

1. 概要

this new seriesのこの最初の記事では、a simple query language for a REST APIについて説明します。 RESTAPIにはSpringを、永続性の側面にはJPA 2Criteriaをうまく利用します。

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

**2. Userエンティティ**

まず、フィルター/検索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を使用したフィルター**

それでは、問題の核心に取り掛かりましょう。永続性レイヤーのクエリです。

クエリ抽象化の構築はバランスの問題です。一方では十分な柔軟性が必要であり、他方では複雑さを管理しやすくする必要があります。高レベル、機能は単純です–you pass in some constraints and you get back some results。

その仕組みを見てみましょう。

@Repository
public class UserDAO implements IUserDAO {

    @PersistenceContext
    private EntityManager entityManager;

    @Override
    public List searchUser(List params) {
        CriteriaBuilder builder = entityManager.getCriteriaBuilder();
        CriteriaQuery 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 result = entityManager.createQuery(query).getResultList();
        return result;
    }

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

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

public class UserSearchQueryCriteriaConsumer implements Consumer{

    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：操作を保持するために使用されます–例：等式、より小さい、…など。
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);
    }
}

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

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

    List results = userApi.searchUser(params);

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

次に、同じlastNameでUserのListを取得しましょう。

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

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

次に、agegreater than or equal 25のユーザーを取得しましょう。

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

    List results = userApi.searchUser(params);

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

次に、don’t actually existのユーザーを検索しましょう。

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

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

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

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

    List results = userApi.searchUser(params);

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

6. UserController

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

単純なUserControllerを設定します–findAll()using the “search” to pass in the entire search/filter expression：

@Controller
public class UserController {

    @Autowired
    private IUserDao api;

    @RequestMapping(method = RequestMethod.GET, value = "/users")
    @ResponseBody
    public List findAll(@RequestParam(value = "search", required = false) String search) {
        List params = new ArrayList();
        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にこの種のフィルタリング機能を実装するための確かな出発点です。

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

TOC