摘要:我们将充分利用作为,并将标准用于持久性方面。一方面我们需要很大的灵活性,另一方面我们需要保持复杂性可管理性。是的它仍然很粗糙,可以改进下一篇文章将对此进行改进但它是在上实现这种过滤功能的坚实起点。
案例概述
在本系列的第一篇文章中,我们将探索一种用于REST API的简单查询语言。我们将充分利用Spring作为REST API,并将JPA 2标准用于持久性方面。
为什么使用查询语言?因为 - 对于任何复杂的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进行过滤
现在 - 让我们深入研究问题 - 持久层中的查询。
构建查询抽象是一个平衡问题。一方面我们需要很大的灵活性,另一方面我们需要保持复杂性可管理性。高级别,功能很简单 - 你传递一些约束,你会得到一些结果。
让我们看看它是如何工作的:
@Repository public class UserDAO implements IUserDAO { @PersistenceContext private EntityManager entityManager; @Override public ListsearchUser(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获取非常简单的约束列表,根据这些约束组成查询,执行搜索并返回结果。
约束类也很简单:
public class SearchCriteria { private String key; private String operation; private Object value; }
该SearchCriteria实现持有我们的查询参数:
key:用于保存字段名称 - 例如:firstName,age,...等。
operation:用于保持操作 - 例如:Equality,less,...等。
value:用于保存字段值 - 例如:john,25,...等。
测试搜索查询
现在 - 让我们测试我们的搜索机制,以确保它可用。
首先 - 让我们通过添加两个用户来初始化我们的数据库以进行测试 - 如下例所示:
@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() { Listparams = 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() { Listparams = 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() { Listparams = 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() { Listparams = 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() { Listparams = new ArrayList (); params.add(new SearchCriteria("firstName", ":", "jo")); List results = userApi.searchUser(params); assertThat(userJohn, isIn(results)); assertThat(userTom, not(isIn(results))); }
UserController
最后,让我们现在将这种灵活搜索的持久性支持连接到我们的REST API。
我们将设置一个简单的UserController - 使用findAll()使用“search”传递整个搜索/过滤器表达式:
@Controller public class UserController { @Autowired private IUserDao api; @RequestMapping(method = RequestMethod.GET, value = "/users") @ResponseBody public ListfindAll(@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":"tom@doe.com", "age":26 }]
案例结论
这个简单而强大的实现支持对REST API进行相当多的智能过滤。是的—它仍然很粗糙,可以改进(下一篇文章将对此进行改进)—但它是在api上实现这种过滤功能的坚实起点。
文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。
转载请注明本文地址:https://www.ucloud.cn/yun/73075.html
摘要:还定义了一个运行时,用于处理对象的查询和管理事务。是持久化规范中的一个最新版本。旨在统一,,,从目前来看,的确取得了成功。目前大多数持久化供应商已经发布了的实现,并被行业和用户采用。这些包括由和收购,由收购和由和收购。需注意为时为第一页。 什么是jpaJPA (The Java Persistence API)是用于访问,持久化和管理 Java 对象/类与关系型数据库之间的数据交互的 ...
摘要:测试程序首先看到顶层服务使用格式进行输出。的列举包括以下值默认,公开所有公开和注解的,除非设置为暴露所有修饰的创建配置类测试分页和排序分页是一个由定义的接口,它拥有一个实现。排序提供一个对象提供排序机制。 使用 JPA 访问数据 创建项目 打开IDEA -> Create New Project showImg(https://segmentfault.com/img/bVbo9bO?...
摘要:市长信箱邮件查询服务使用构建工程一直想用做个微服务练练手为后续部署到打下基础今天比较空闲就开始把部分想法落地了概览用来练手的应用是一个市长信箱的内容抓取与检索页面鉴于我的八卦特质总想了解下周边的一些投诉信息而成都的市长信箱是一个绝好的信息来 市长信箱邮件查询服务: 使用SpringBoot构建工程 一直想用SpringBoot做个微服务,练练手, 为后续部署到docker打下基础. 今...
摘要:当秒杀日期尚未达到会提示用户秒杀尚未开始当用户多次秒杀同一商品会提示用户重复秒杀当秒杀日期过期或者秒杀商品的库存为零会提示用户秒杀结束。 【秒杀系统业务分析 在秒杀系统当中有两个核心的表:秒杀商品(kill_product)与秒杀明细(kill_item),具体的逻辑是一个用户秒杀商品的库存减一,秒杀明细的记录增加一条。这两步作是处于同一事务之中。 当秒杀日期尚未达到会提示用户秒杀尚...
摘要:与的关系是什么是官方提出的持久化规范。它为开发人员提供了一种对象关联映射工具来管理应用中的关系数据。他的出现主要是为了简化现有的持久化开发工作和整合技术,结束现在,,等框架各自为营的局面。定义了在对数据库中的对象处理查询和事务运行时的的。 导读: 在上篇文章中对Spring MVC常用的一些注解做了简要的说明,在这篇文章中主要对Spring Data JPA 做一个简要的说明,并附有一...
阅读 2380·2021-11-12 10:34
阅读 1465·2019-08-29 16:15
阅读 2678·2019-08-29 15:17
阅读 1334·2019-08-23 17:09
阅读 389·2019-08-23 11:37
阅读 2451·2019-08-23 10:39
阅读 468·2019-08-22 16:43
阅读 3107·2019-08-22 14:53