摘要：我們將充分利用作為，并將標準用于持久性方面。一方面我們需要很大的靈活性，另一方面我們需要保持復(fù)雜性可管理性。是的它仍然很粗糙，可以改進下一篇文章將對此進行改進但它是在上實現(xiàn)這種過濾功能的堅實起點。

案例概述

在本系列的第一篇文章中，我們將探索一種用于REST API的簡單查詢語言。我們將充分利用Spring作為REST API，并將JPA 2標準用于持久性方面。

為什么使用查詢語言？因為 - 對于任何復(fù)雜的API - 通過非常簡單的字段搜索/過濾資源是不夠的。查詢語言更靈活，允許您精確過濾所需的資源。

User Entity

首先 - 讓我們提出我們將用于過濾器/搜索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;
}

使用CriteriaBuilder進行過濾

現(xiàn)在 - 讓我們深入研究問題 - 持久層中的查詢。

構(gòu)建查詢抽象是一個平衡問題。一方面我們需要很大的靈活性，另一方面我們需要保持復(fù)雜性可管理性。高級別，功能很簡單 - 你傳遞一些約束，你會得到一些結(jié)果。

讓我們看看它是如何工作的：

@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();
?
????????for (SearchCriteria param : params) {
????????????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()));
????????????????}
????????????}
????????}
????????query.where(predicate);
?
????????List result = entityManager.createQuery(query).getResultList();
????????return result;
????}
?
????@Override
????public void save(User entity) {
????????entityManager.persist(entity);
????}
}

如您所見，searchUser API獲取非常簡單的約束列表，根據(jù)這些約束組成查詢，執(zhí)行搜索并返回結(jié)果。

約束類也很簡單：

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

該SearchCriteria實現(xiàn)持有我們的查詢參數(shù)：

key：用于保存字段名稱 - 例如：firstName，age，...等。

operation：用于保持操作 - 例如：Equality，less，...等。

value：用于保存字段值 - 例如：john，25，...等。

測試搜索查詢

現(xiàn)在 - 讓我們測試我們的搜索機制，以確保它可用。

首先 - 讓我們通過添加兩個用戶來初始化我們的數(shù)據(jù)庫以進行測試 - 如下例所示：

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

現(xiàn)在，讓我們得到一個具有特定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)));
}

接下來，讓我們得到一個具有相同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));
}

接下來，讓age大于或等于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)));
}

接下來，讓我們搜索實際不存在的用戶：

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

最后，讓我們搜索僅給出部分firstName的用戶：

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

UserController

最后，讓我們現(xiàn)在將這種靈活搜索的持久性支持連接到我們的REST API。

我們將設(shè)置一個簡單的UserController - 使用findAll()使用“search”傳遞整個搜索/過濾器表達式：

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

請注意我們?nèi)绾魏唵蔚貜乃阉鞅磉_式中創(chuàng)建搜索條件對象。

我們現(xiàn)在正處于開始使用API??并確保一切正常工作的地步：

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

這是它的回應(yīng)：

[{
????"id":2,
????"firstName":"tom",
????"lastName":"doe",
????"email":"[email protected]",
????"age":26
}]

案例結(jié)論

這個簡單而強大的實現(xiàn)支持對REST API進行相當多的智能過濾。是的—它仍然很粗糙，可以改進(下一篇文章將對此進行改進)—但它是在api上實現(xiàn)這種過濾功能的堅實起點。