1. 개요

이 예제에서는 SpringData JPA 및 사양을 사용하여 검색 / 필터 REST API 를 빌드합니다 .

우리는의 쿼리 언어에서 찾기 시작 첫 번째 기사 의 이 시리즈 - JPA 기준 기반의 솔루션으로.

그래서 – 왜 쿼리 언어입니까? 왜냐하면 – 충분히 복잡한 API의 경우 – 매우 간단한 필드로 리소스를 검색 / 필터링하는 것만으로는 충분하지 않습니다. 쿼리 언어는 더 유연 하며 필요한 리소스로 정확히 필터링 할 수 있습니다.

2. 사용자 엔티티

먼저, Search 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;
    
    // standard getters and setters
}

3. 사양을 사용한 필터링

이제 문제의 가장 흥미로운 부분 인 사용자 정의 SpringData JPA 사양을 사용한 쿼리로 바로 들어가 보겠습니다 .

사양 인터페이스 를 구현 하는 UserSpecification 을 만들고 실제 쿼리를 생성하기 위해 자체 제약 조건을 전달합니다 .

public class UserSpecification implements Specification<User> {

    private SearchCriteria criteria;

    @Override
    public Predicate toPredicate
      (Root<User> root, CriteriaQuery<?> query, CriteriaBuilder builder) {
 
        if (criteria.getOperation().equalsIgnoreCase(">")) {
            return builder.greaterThanOrEqualTo(
              root.<String> get(criteria.getKey()), criteria.getValue().toString());
        } 
        else if (criteria.getOperation().equalsIgnoreCase("<")) {
            return builder.lessThanOrEqualTo(
              root.<String> get(criteria.getKey()), criteria.getValue().toString());
        } 
        else if (criteria.getOperation().equalsIgnoreCase(":")) {
            if (root.get(criteria.getKey()).getJavaType() == String.class) {
                return builder.like(
                  root.<String>get(criteria.getKey()), "%" + criteria.getValue() + "%");
            } else {
                return builder.equal(root.get(criteria.getKey()), criteria.getValue());
            }
        }
        return null;
    }
}

보시다시피 – 우리 는 다음“ SearchCriteria ”클래스 에서 나타내는 몇 가지 간단한 제약 을 기반으로 사양 을 생성합니다 .

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

SearchCriteria의 구현은 제약 조건의 기본 표현을 보유하고 - 그것은 우리가 쿼리를 작성 할 거라고이 제약을 기반으로 :

  • key : 필드 이름 – 예 : firstName , age ,… 등.
  • operation : 작업 – 예 : 같음,보다 작음,… 등.
  • value : 필드 값 – 예 : john, 25,… 등.

물론 구현은 단순하고 개선 될 수 있습니다. 그러나 우리가 필요로하는 강력하고 유연한 작업을위한 견고한 기반입니다.

4. UserRepository

다음으로 UserRepository를 살펴 보겠습니다 . 새로운 사양 API를 얻기 위해 JpaSpecificationExecutor 를 확장하는 것입니다 .

public interface UserRepository 
  extends JpaRepository<User, Long>, JpaSpecificationExecutor<User> {}

5. 검색 쿼리 테스트

이제 새 검색 API를 테스트 해 보겠습니다.

먼저 테스트가 실행될 때 준비 할 몇 명의 사용자를 만들어 보겠습니다.

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { PersistenceJPAConfig.class })
@Transactional
@TransactionConfiguration
public class JPASpecificationsTest {

    @Autowired
    private UserRepository repository;

    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);
        repository.save(userJohn);

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

다음으로 성이 지정된 사용자를 찾는 방법을 살펴 보겠습니다 .

@Test
public void givenLast_whenGettingListOfUsers_thenCorrect() {
    UserSpecification spec = 
      new UserSpecification(new SearchCriteria("lastName", ":", "doe"));
    
    List<User> results = repository.findAll(spec);

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

이제 이름과 성을 모두 지정한 사용자를 찾는 방법을 살펴 보겠습니다 .

@Test
public void givenFirstAndLastName_whenGettingListOfUsers_thenCorrect() {
    UserSpecification spec1 = 
      new UserSpecification(new SearchCriteria("firstName", ":", "john"));
    UserSpecification spec2 = 
      new UserSpecification(new SearchCriteria("lastName", ":", "doe"));
    
    List<User> results = repository.findAll(Specification.where(spec1).and(spec2));

    assertThat(userJohn, isIn(results));
    assertThat(userTom, not(isIn(results)));
}

참고 : 사양 을 결합 하기 위해 “ where ”및“ and ”를 사용했습니다 .

다음 으로 성 및 최소 연령을 모두 지정한 사용자를 찾는 방법을 살펴 보겠습니다 .

@Test
public void givenLastAndAge_whenGettingListOfUsers_thenCorrect() {
    UserSpecification spec1 = 
      new UserSpecification(new SearchCriteria("age", ">", "25"));
    UserSpecification spec2 = 
      new UserSpecification(new SearchCriteria("lastName", ":", "doe"));

    List<User> results = 
      repository.findAll(Specification.where(spec1).and(spec2));

    assertThat(userTom, isIn(results));
    assertThat(userJohn, not(isIn(results)));
}

자,하자가를 검색하는 방법을 참조 사용자 실제로 존재하지 않습니다 :

@Test
public void givenWrongFirstAndLast_whenGettingListOfUsers_thenCorrect() {
    UserSpecification spec1 = 
      new UserSpecification(new SearchCriteria("firstName", ":", "Adam"));
    UserSpecification spec2 = 
      new UserSpecification(new SearchCriteria("lastName", ":", "Fox"));

    List<User> results = 
      repository.findAll(Specification.where(spec1).and(spec2));

    assertThat(userJohn, not(isIn(results)));
    assertThat(userTom, not(isIn(results)));  
}

마지막으로 이름의 일부만 제공된 사용자 를 찾는 방법을 살펴 보겠습니다 .

@Test
public void givenPartialFirst_whenGettingListOfUsers_thenCorrect() {
    UserSpecification spec = 
      new UserSpecification(new SearchCriteria("firstName", ":", "jo"));
    
    List<User> results = repository.findAll(spec);

    assertThat(userJohn, isIn(results));
    assertThat(userTom, not(isIn(results)));
}

6. 사양 결합

다음 – 사용자 지정 사양 을 결합 하여 여러 제약 조건을 사용하고 여러 기준에 따라 필터링 하는 방법을 살펴 보겠습니다 .

우리는 빌더 ( UserSpecificationsBuilder) 를 구현 하여 사양 을 쉽고 유창하게 결합 할 것입니다 .

public class UserSpecificationsBuilder {
    
    private final List<SearchCriteria> params;

    public UserSpecificationsBuilder() {
        params = new ArrayList<SearchCriteria>();
    }

    public UserSpecificationsBuilder with(String key, String operation, Object value) {
        params.add(new SearchCriteria(key, operation, value));
        return this;
    }

    public Specification<User> build() {
        if (params.size() == 0) {
            return null;
        }

        List<Specification> specs = params.stream()
          .map(UserSpecification::new)
          .collect(Collectors.toList());
        
        Specification result = specs.get(0);

        for (int i = 1; i < params.size(); i++) {
            result = params.get(i)
              .isOrPredicate()
                ? Specification.where(result)
                  .or(specs.get(i))
                : Specification.where(result)
                  .and(specs.get(i));
        }       
        return result;
    }
}

7. UserController

마지막으로 -의이 새로운 영구 검색 / 필터 기능을 사용하자 나머지 API를 설정 - 만들어 UserController 간단한과 검색 작업을 :

@Controller
public class UserController {

    @Autowired
    private UserRepository repo;

    @RequestMapping(method = RequestMethod.GET, value = "/users")
    @ResponseBody
    public List<User> search(@RequestParam(value = "search") String search) {
        UserSpecificationsBuilder builder = new UserSpecificationsBuilder();
        Pattern pattern = Pattern.compile("(\\w+?)(:|<|>)(\\w+?),");
        Matcher matcher = pattern.matcher(search + ",");
        while (matcher.find()) {
            builder.with(matcher.group(1), matcher.group(2), matcher.group(3));
        }
        
        Specification<User> spec = builder.build();
        return repo.findAll(spec);
    }
}

영어가 아닌 다른 시스템을 지원하기 위해 Pattern 객체를 다음과 같이 변경할 수 있습니다.

Pattern pattern = Pattern.compile("(\\w+?)(:|<|>)(\\w+?),", Pattern.UNICODE_CHARACTER_CLASS);

다음은 API를 테스트하기위한 테스트 URL 예제입니다.

http://localhost:8080/users?search=lastName:doe,age>25

그리고 응답 :

[{
    "id":2,
    "firstName":"tom",
    "lastName":"doe",
    "email":"tom@doe.com",
    "age":26
}]

패턴 예 에서 검색은 ","로 분할되므로 검색어 에이 문자가 포함될 수 없습니다. 패턴도 공백과 일치하지 않습니다.

쉼표가 포함 된 값을 검색하려면 ";"과 같은 다른 구분 기호를 사용하는 것을 고려할 수 있습니다.

또 다른 옵션은 따옴표 사이의 값을 검색하도록 패턴을 변경 한 다음 검색어에서이를 제거하는 것입니다.

Pattern pattern = Pattern.compile("(\\w+?)(:|<|>)(\"([^\"]+)\")");

8. 결론

이 사용방법(예제)에서는 강력한 REST 쿼리 언어의 기반이 될 수있는 간단한 구현을 다룹니다. 우리는 API를 도메인에서 멀리 하고 다른 많은 유형의 작업을 처리 할 수있는 옵션을 확보 하기 위해 Spring 데이터 사양을 잘 활용 했습니다 .

이 기사 의 전체 구현 은 GitHub 프로젝트 에서 찾을 수 있습니다. 이 프로젝트 는 Maven 기반 프로젝트이므로 그대로 가져 와서 실행하기 쉽습니다.

다음 »
SpringData JPA 및 Querydsl을 사용한 REST 쿼리 언어
« 이전
Spring 및 JPA 기준을 사용한 REST 쿼리 언어