RESTクエリ言語–OR操作の実装

投稿日: 2019-10-18 2022-11-05
タグ: REST, REST Query Language, Spring

1. 概要

このクイック記事では、前の記事で実装した高度な検索操作を拡張し、ORベースの検索条件をRESTAPIクエリ言語に含めます。

2. 実装アプローチ

以前は、 search クエリパラメータのすべての基準は、AND演算子によってのみグループ化された述語を形成していました。それを変えましょう。

この機能は、既存のアプローチへの単純で迅速な変更として、または最初から新しいアプローチとして実装できるはずです。

単純なアプローチでは、OR演算子を使用して組み合わせる必要があることを示すために、基準にフラグを立てます。

たとえば、「 firstName ORlastName」のAPIをテストするためのURLは次のとおりです：

http://localhost:8080/users?search=firstName:john,'lastName:doe

基準lastNameに、区別するために一重引用符でフラグを付けていることに注意してください。 OR演算子のこの述語を、基準値オブジェクト– SpecSearchCriteria：にキャプチャします。

public SpecSearchCriteria(
  String orPredicate, String key, SearchOperation operation, Object value) {
    super();
    
    this.orPredicate 
      = orPredicate != null
      && orPredicate.equals(SearchOperation.OR_PREDICATE_FLAG);
    
    this.key = key;
    this.operation = operation;
    this.value = value;
}

**3. UserSpecificationBuilderの改善**

それでは、仕様ビルダーを変更してみましょう。 UserSpecificationBuilder、 構築時にOR修飾基準を考慮する仕様：

public Specification<User> build() {
    if (params.size() == 0) {
        return null;
    }
    Specification<User> result = new UserSpecification(params.get(0));

    for (int i = 1; i < params.size(); i++) {
        result = params.get(i).isOrPredicate()
          ? Specification.where(result).or(new UserSpecification(params.get(i))) 
          : Specification.where(result).and(new UserSpecification(params.get(i)));
    }
    return result;
 }

**4. UserControllerの改善**

最後に、この検索機能をOR演算子で使用するために、コントローラーに新しいRESTエンドポイントを設定しましょう。改善された解析ロジックは、OR演算子で基準を識別するのに役立つ特別なフラグを抽出します。

@GetMapping("/users/espec")
@ResponseBody
public List<User> findAllByOrPredicate(@RequestParam String search) {
    Specification<User> spec = resolveSpecification(search);
    return dao.findAll(spec);
}

protected Specification<User> resolveSpecification(String searchParameters) {
    UserSpecificationsBuilder builder = new UserSpecificationsBuilder();
    String operationSetExper = Joiner.on("|")
      .join(SearchOperation.SIMPLE_OPERATION_SET);
    Pattern pattern = Pattern.compile(
      "(\\p{Punct}?)(\\w+?)("
      + operationSetExper 
      + ")(\\p{Punct}?)(\\w+?)(\\p{Punct}?),");
    Matcher matcher = pattern.matcher(searchParameters + ",");
    while (matcher.find()) {
        builder.with(matcher.group(1), matcher.group(2), matcher.group(3), 
        matcher.group(5), matcher.group(4), matcher.group(6));
    }
    
    return builder.build();
}

**5. または条件でのライブテスト**

このライブテストの例では、新しいAPIエンドポイントを使用して、名「john」または姓「doe」でユーザーを検索します。パラメータlastNameには一重引用符があり、「OR述語」として修飾されていることに注意してください。

private String EURL_PREFIX
  = "http://localhost:8082/spring-rest-full/auth/users/espec?search=";

@Test
public void givenFirstOrLastName_whenGettingListOfUsers_thenCorrect() {
    Response response = givenAuth().get(EURL_PREFIX + "firstName:john,'lastName:doe");
    String result = response.body().asString();

    assertTrue(result.contains(userJohn.getEmail()));
    assertTrue(result.contains(userTom.getEmail()));
}

**6. または条件での永続性テスト**

ここで、上記と同じテストを、名が「john」または姓が「doe」のユーザーの永続性レベルで実行してみましょう。

@Test
public void givenFirstOrLastName_whenGettingListOfUsers_thenCorrect() {
    UserSpecificationsBuilder builder = new UserSpecificationsBuilder();

    SpecSearchCriteria spec 
      = new SpecSearchCriteria("firstName", SearchOperation.EQUALITY, "john");
    SpecSearchCriteria spec1 
      = new SpecSearchCriteria("'","lastName", SearchOperation.EQUALITY, "doe");

    List<User> results = repository
      .findAll(builder.with(spec).with(spec1).build());

    assertThat(results, hasSize(2));
    assertThat(userJohn, isIn(results));
    assertThat(userTom, isIn(results));
}

7. 代替アプローチ

別のアプローチでは、SQLクエリの完全なWHERE句のように検索クエリを提供できます。

たとえば、 firstNameおよびage：によるより複雑な検索のURLは次のとおりです。

http://localhost:8080/users?search=( firstName:john OR firstName:tom ) AND age>22

有効な中置式を形成するために、個々の基準、演算子、およびグループ化括弧をスペースで区切っていることに注意してください。

CriteriaParserを使用して中置式を解析してみましょう。私たちの CriteriaParser 指定された中置式をトークン（基準、括弧、AND＆OR演算子）に分割し、同じ後置式を作成します。

public Deque<?> parse(String searchParam) {

    Deque<Object> output = new LinkedList<>();
    Deque<String> stack = new LinkedList<>();

    Arrays.stream(searchParam.split("\\s+")).forEach(token -> {
        if (ops.containsKey(token)) {
            while (!stack.isEmpty() && isHigerPrecedenceOperator(token, stack.peek())) {
                output.push(stack.pop().equalsIgnoreCase(SearchOperation.OR_OPERATOR)
                  ? SearchOperation.OR_OPERATOR : SearchOperation.AND_OPERATOR);
            }
            stack.push(token.equalsIgnoreCase(SearchOperation.OR_OPERATOR) 
              ? SearchOperation.OR_OPERATOR : SearchOperation.AND_OPERATOR);

        } else if (token.equals(SearchOperation.LEFT_PARANTHESIS)) {
            stack.push(SearchOperation.LEFT_PARANTHESIS);
        } else if (token.equals(SearchOperation.RIGHT_PARANTHESIS)) {
            while (!stack.peek().equals(SearchOperation.LEFT_PARANTHESIS)) { 
                output.push(stack.pop());
            }
            stack.pop();
        } else {
            Matcher matcher = SpecCriteraRegex.matcher(token);
            while (matcher.find()) {
                output.push(new SpecSearchCriteria(
                  matcher.group(1), 
                  matcher.group(2), 
                  matcher.group(3), 
                  matcher.group(4), 
                  matcher.group(5)));
            }
        }
    });

    while (!stack.isEmpty()) {
        output.push(stack.pop());
    }
  
    return output;
}

仕様ビルダーGenericSpecificationBuilder、に新しいメソッドを追加して、接尾辞式から検索仕様を作成しましょう。

    public Specification<U> build(Deque<?> postFixedExprStack, 
        Function<SpecSearchCriteria, Specification<U>> converter) {

        Deque<Specification<U>> specStack = new LinkedList<>();

        while (!postFixedExprStack.isEmpty()) {
            Object mayBeOperand = postFixedExprStack.pollLast();

            if (!(mayBeOperand instanceof String)) {
                specStack.push(converter.apply((SpecSearchCriteria) mayBeOperand));
            } else {
                Specification<U> operand1 = specStack.pop();
                Specification<U> operand2 = specStack.pop();
                if (mayBeOperand.equals(SearchOperation.AND_OPERATOR)) {
                    specStack.push(Specification.where(operand1)
                      .and(operand2));
                }
                else if (mayBeOperand.equals(SearchOperation.OR_OPERATOR)) {
                    specStack.push(Specification.where(operand1)
                      .or(operand2));
                }
            }
        }
        return specStack.pop();

最後に、 UserController に別のRESTエンドポイントを追加して、新しいCriteriaParserを使用して複雑な式を解析します。

@GetMapping("/users/spec/adv")
@ResponseBody
public List<User> findAllByAdvPredicate(@RequestParam String search) {
    Specification<User> spec = resolveSpecificationFromInfixExpr(search);
    return dao.findAll(spec);
}

protected Specification<User> resolveSpecificationFromInfixExpr(String searchParameters) {
    CriteriaParser parser = new CriteriaParser();
    GenericSpecificationsBuilder<User> specBuilder = new GenericSpecificationsBuilder<>();
    return specBuilder.build(parser.parse(searchParameters), UserSpecification::new);
}

8. 結論

このチュートリアルでは、OR演算子を使用して検索する機能を使用して、RESTクエリ言語を改善しました。

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

getdocs

13036