REST Query Language с RSQL

1. обзор

В этой пятой статьеthe series мы проиллюстрируем создание языка запросов REST API с помощьюa cool library – rsql-parser..

RSQL - это расширенный набор языка запросов элементов ленты (FIQL) - чистый и простой синтаксис фильтра для лент; поэтому он вполне естественно вписывается в REST API. **

2. Препараты

Во-первых, давайте добавим в библиотеку зависимость maven:


    cz.jirutka.rsql
    rsql-parser
    2.0.0

А такжеdefine the main entity, с которым мы будем работать в примерах -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. Разобрать запрос

Внутреннее представление выражений RSQL осуществляется в форме узлов, а шаблон анализа посетителей используется для анализа входных данных.

Имея это в виду, мы собираемся реализоватьRSQLVisitor interface и создать нашу собственную реализацию посетителя -CustomRsqlVisitor:

public class CustomRsqlVisitor implements RSQLVisitor, Void> {

    private GenericRsqlSpecBuilder builder;

    public CustomRsqlVisitor() {
        builder = new GenericRsqlSpecBuilder();
    }

    @Override
    public Specification visit(AndNode node, Void param) {
        return builder.createSpecification(node);
    }

    @Override
    public Specification visit(OrNode node, Void param) {
        return builder.createSpecification(node);
    }

    @Override
    public Specification visit(ComparisonNode node, Void params) {
        return builder.createSecification(node);
    }
}

Теперь нам нужно разобраться с постоянством и построить наш запрос из каждого из этих узлов.

Мы собираемся использовать спецификации Spring Data JPAwe used before - и мы собираемся реализовать построительSpecification дляconstruct Specifications out of each of these nodes we visit:

public class GenericRsqlSpecBuilder {

    public Specification createSpecification(Node node) {
        if (node instanceof LogicalNode) {
            return createSpecification((LogicalNode) node);
        }
        if (node instanceof ComparisonNode) {
            return createSpecification((ComparisonNode) node);
        }
        return null;
    }

    public Specification createSpecification(LogicalNode logicalNode) {
        List specs = logicalNode.getChildren()
          .stream()
          .map(node -> createSpecification(node))
          .filter(Objects::nonNull)
          .collect(Collectors.toList());

        Specification result = specs.get(0);
        if (logicalNode.getOperator() == LogicalOperator.AND) {
            for (int i = 1; i < specs.size(); i++) {
                result = Specification.where(result).and(specs.get(i));
            }
        } else if (logicalNode.getOperator() == LogicalOperator.OR) {
            for (int i = 1; i < specs.size(); i++) {
                result = Specification.where(result).or(specs.get(i));
            }
        }

        return result;
    }

    public Specification createSpecification(ComparisonNode comparisonNode) {
        Specification result = Specification.where(
          new GenericRsqlSpecification(
            comparisonNode.getSelector(),
            comparisonNode.getOperator(),
            comparisonNode.getArguments()
          )
        );
        return result;
    }
}

Обратите внимание, как:

LogicalNode являетсяAND/ * OR *Node и имеет несколько дочерних элементов
ComparisonNode не имеет потомков и содержитSelector, Operator and the Arguments

Например, для запроса «name==john» - имеем:

Selector: «имя»
Operator: «==»
Arguments: [джон]

4. Создать собственныйSpecification

При построении запроса мы использовалиSpecification:

public class GenericRsqlSpecification implements Specification {

    private String property;
    private ComparisonOperator operator;
    private List arguments;

    @Override
    public Predicate toPredicate(Root root, CriteriaQuery query, CriteriaBuilder builder) {
        List

TOC

REST Query Language с RSQL