Язык запросов REST с критериями Spring и JPA

1 января 2021 г. · 5 мин. чтения

1. Обзор

В этой первой статье этой новой серии мы рассмотрим простой язык запросов для REST API . Мы будем хорошо использовать Spring для REST API и JPA 2 Criteria для аспектов сохраняемости.

Почему язык запросов? Потому что — для любого достаточно сложного 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 содержит параметры нашего запроса :

key : используется для хранения имени поля — например: firstName , age , … и т. д.
операция : используется для проведения операции — например: равенство, меньше, … и т. д.
value : используется для хранения значения поля — например: john, 25, … и т. д.

4. Тестируйте поисковые запросы

Теперь давайте проверим наш механизм поиска, чтобы убедиться, что он выдерживает критику.

Во-первых, давайте инициализируем нашу базу данных для тестирования, добавив двух пользователей, как в следующем примере:

@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("john@doe.com");
        userJohn.setAge(22);
        userApi.save(userJohn);

        userTom = new User();
        userTom.setFirstName("Tom");
        userTom.setLastName("Doe");
        userTom.setEmail("tom@doe.com");
        userTom.setAge(26);
        userApi.save(userTom);
    }
}

Теперь давайте получим пользователя с определенным именем и фамилией , как в следующем примере:

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

Далее, давайте получим список пользователей с той же фамилией : ``

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

Наконец, давайте найдем пользователей, которым дано только частичное имя 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. Пользовательский `контроллер`

Наконец, давайте теперь подключим поддержку сохраняемости для этого гибкого поиска к нашему REST API.

Мы собираемся настроить простой 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":"tom@doe.com",
    "age":26
}]

7. Заключение

Эта простая, но мощная реализация позволяет выполнять интеллектуальную фильтрацию в REST API. Да, он все еще несовершенен и может быть улучшен (и будет улучшен в следующей статье), но это хорошая отправная точка для реализации такого рода функций фильтрации в ваших API.

Полную реализацию этой статьи можно найти в проекте GitHub .

1. Обзор​

2. Объект пользователя ​

3. Фильтр с помощью CriteriaBuilder​

4. Тестируйте поисковые запросы​

6. Пользовательский контроллер​

7. Заключение​