REST Query Language - Реализация операции ИЛИ

Язык запросов REST - реализация операции ИЛИ

1. обзор

В этой быстрой статье мы расширим расширенные операции поиска, которые мы реализовали вprevious article, и включимOR-based search criteria into our REST API Query Language.

2. Подход к реализации

Раньше все критерии в параметре запросаsearch формировали предикаты, сгруппированные только оператором AND. Давай изменим это.

Мы должны иметь возможность реализовать эту функцию как простой, быстрый переход к существующему подходу или как новый с нуля.

При простом подходе мы отметим критерии, чтобы указать, что они должны быть объединены с помощью оператора ИЛИ.

Например, вот URL-адрес для тестирования API для «firstName OR lastName”:

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

Обратите внимание, что мы пометили критерийlastName одинарной кавычкой, чтобы различать его. Мы зафиксируем этот предикат для оператора ИЛИ в нашем объекте значения критерия -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,, чтобы при построенииSpecification<User> учесть квалифицированный критерий OR:

public Specification build() {
    if (params.size() == 0) {
        return null;
    }
    Specification 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 Улучшение**

Наконец, давайте настроим новую конечную точку REST в нашем контроллере, чтобы использовать эту функцию поиска с оператором OR. Улучшенная логика синтаксического анализа извлекает специальный флаг, который помогает идентифицировать критерии с помощью оператора OR:

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

protected Specification 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. Живой тест с условиемOR

В этом живом тестовом примере с новой конечной точкой API мы будем искать пользователей по имени «john» ИЛИ по фамилии «doe». Обратите внимание, что параметрlastName заключен в одинарную кавычку, что квалифицирует его как «предикат ИЛИ»:

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. Испытание на стойкость с условиемOR

Теперь давайте проведем тот же тест, что и выше, на уровне сохраняемости для пользователейwith first name “john” OR last name “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 results = repository
      .findAll(builder.with(spec).with(spec1).build());

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

7. Альтернативный подход

В альтернативном подходе мы могли бы предоставить поисковый запрос, больше похожий на полное предложениеWHERE SQL-запроса.

Например, вот URL для более сложного поиска поfirstName иage:

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

Обратите внимание, что мы разделили отдельные критерии, операторы и группирующие скобки с пробелом, чтобы сформировать правильное выражение инфикса.

Разберем инфиксное выражение с помощью aCriteriaParser. НашCriteriaParser разбивает данное инфиксное выражение на токены (критерии, скобки, операторы И и ИЛИ) и создает для них постфиксное выражение:

public Deque parse(String searchParam) {

    Deque

TOC