TOC

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

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

1. обзор

В этой первой статьеthis new series мы рассмотримa simple query language for a REST API. Мы будем хорошо использовать Spring для REST API и JPA 2 Criteria для аспектов устойчивости.

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
}

Как видите, APIsearchUser принимает список очень простых ограничений, составляет запрос на основе этих ограничений, выполняет поиск и возвращает результаты.

Класс ограничений также довольно прост: 

public class SearchCriteria {
    private String key;
    private String operation;
    private Object value;
}

РеализацияSearchCriteria содержит наши параметрыQuery:

  • key: используется для хранения имени поля - например:firstName,age и т. д.

  • operation: используется для удержания операции - например: равенство, меньше,… и т. д.

  • 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("[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);
    }
}

Теперь давайте получимUser с конкретнымиfirstName иlastName - как в следующем примере: 

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

Затем давайте получимList изUser с тем жеlastName: 

@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

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

Мы собираемся настроить простой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. Заключение

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

full implementation в этой статье можно найти вthe GitHub project - это проект на основе Maven, поэтому его должно быть легко импортировать и запускать как есть.

Related