1. 개요
이 새 시리즈 의 첫 번째 기사에서는 REST API에 대한 간단한 쿼리 언어를 살펴 보겠습니다 . REST API에는 Spring을, 지속성 측면에는 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는 매우 간단한 제약 조건 List을 가져 와서 이러한 제약 조건을 기반으로 쿼리를 작성하고 검색을 수행하고 결과를 반환합니다.
제약 클래스도 매우 간단합니다.
public class SearchCriteria {
private String key;
private String operation;
private Object value;
}SearchCriteria의 구현은 우리의 보유 쿼리 매개 변수를 :
- key : 필드 이름을 보관하는 데 사용됩니다 (예 : firstName , age ,… 등).
- operation : 작업 을 유지하는 데 사용됩니다. 예 : Equality, less than,… 등.
- 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);
}
}이제 다음 예제에서 와 같이 특정 firstName 및 lastName을 가진 사용자 를 가져옵니다 .
@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)));
}다음으로 lastName 이 같은 사용자 List 을 가져옵니다 .
@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. UserController
마지막으로이 유연한 검색에 대한 지속성 지원을 REST API에 연결해 보겠습니다.
우리는 전체 검색 / 필터 표현식을 전달하기 위해“ search ”를 사용 하는 findAll ()을 사용하여 간단한 UserController를 설정할 것입니다 .
@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 프로젝트 에서 찾을 수 있습니다 .