我有一个使用spring-data-jpa进行数据访问的spring-mvc项目。我有一个名为Travel
的领域对象,我希望允许最终用户对其应用多个过滤器。
为此,我已经实现了以下控制器:
@Autowired
private TravelRepository travelRep;
@RequestMapping("/search")
public ModelAndView search(
@RequestParam(required= false, defaultValue="") String lastName,
Pageable pageable) {
ModelAndView mav = new ModelAndView("travels/list");
Page<Travel> travels = travelRep.findByLastNameLike("%"+lastName+"%", pageable);
PageWrapper<Travel> page = new PageWrapper<Travel>(travels, "/search");
mav.addObject("page", page);
mav.addObject("lastName", lastName);
return mav;
}
这很好用:用户有一个表单,其中包含一个lastName
输入框,可用于过滤旅行。
除了lastName之外,我的Travel
领域对象还有很多属性,我想通过这些属性进行过滤。我认为,如果这些属性都是字符串,那么我可以将它们添加为@RequestParam
,并添加一个spring-data-jpa方法来查询它们。例如,我会添加一个方法findByLastNameLikeAndFirstNameLikeAndShipNameLike
。
然而,当我需要过滤外键时,我不知道该怎么做。因此,我的Travel
有一个period
属性,它是指向Period
领域对象的外键,我需要将其作为下拉菜单供用户选择Period
。
我想做的是当期间为null时,我想检索所有按姓氏过滤的旅行,当期间不为null时,我想检索所有按期间过滤的旅行,同时按姓氏过滤。
我知道如果在我的存储库中实现两个方法并在我的控制器中使用if
,这可以完成:
public ModelAndView search(
@RequestParam(required= false, defaultValue="") String lastName,
@RequestParam(required= false, defaultValue=null) Period period,
Pageable pageable) {
ModelAndView mav = new ModelAndView("travels/list");
Page travels = null;
if(period==null) {
travels = travelRep.findByLastNameLike("%"+lastName+"%", pageable);
} else {
travels = travelRep.findByPeriodAndLastNameLike(period,"%"+lastName+"%", pageable);
}
mav.addObject("page", page);
mav.addObject("period", period);
mav.addObject("lastName", lastName);
return mav;
}
有没有一种方法可以在不使用if
的情况下完成这个操作?我的旅行计划不仅有时间段,还有其他需要使用下拉菜单过滤的属性!!正如您所理解的那样,当我需要使用更多的下拉菜单时,复杂度会呈指数增长,因为所有组合都需要考虑 :(
更新03/12/13:继续M.Deinum的优秀答案并实际实施之后,我想提供一些评论以完整地回答问题/答案:
实现
JpaSpecificationExecutor<Travel>
而不是实现JpaSpecificationExecutor
可以避免类型检查警告。请查看kostja对此问题的优秀答案Really dynamic JPA CriteriaBuilder,因为如果您想要正确的过滤器,则将需要实现它。
我能找到的Criteria API最好的文档是http://www.ibm.com/developerworks/library/j-typesafejpa/。这是一个相当长的读物,但我强烈推荐它-阅读后,我对Root和CriteriaBuilder的大部分问题都得到了回答 :)
无法重复使用
Travel
对象,因为它包含各种其他对象(还包含其他对象),我需要使用Like
搜索它们-而是使用包含我需要搜索的字段的TravelSearch
对象。
更新10/05/15:根据@priyank的请求,这是我如何实现TravelSearch对象:
public class TravelSearch {
private String lastName;
private School school;
private Period period;
private String companyName;
private TravelTypeEnum travelType;
private TravelStatusEnum travelStatus;
// Setters + Getters
}
这个对象被TravelSpecification使用(大部分代码都是特定于领域的,但我将其留在那里作为示例):
public class TravelSpecification implements Specification<Travel> {
private TravelSearch criteria;
public TravelSpecification(TravelSearch ts) {
criteria= ts;
}
@Override
public Predicate toPredicate(Root<Travel> root, CriteriaQuery<?> query,
CriteriaBuilder cb) {
Join<Travel, Candidacy> o = root.join(Travel_.candidacy);
Path<Candidacy> candidacy = root.get(Travel_.candidacy);
Path<Student> student = candidacy.get(Candidacy_.student);
Path<String> lastName = student.get(Student_.lastName);
Path<School> school = student.get(Student_.school);
Path<Period> period = candidacy.get(Candidacy_.period);
Path<TravelStatusEnum> travelStatus = root.get(Travel_.travelStatus);
Path<TravelTypeEnum> travelType = root.get(Travel_.travelType);
Path<Company> company = root.get(Travel_.company);
Path<String> companyName = company.get(Company_.name);
final List<Predicate> predicates = new ArrayList<Predicate>();
if(criteria.getSchool()!=null) {
predicates.add(cb.equal(school, criteria.getSchool()));
}
if(criteria.getCompanyName()!=null) {
predicates.add(cb.like(companyName, "%"+criteria.getCompanyName()+"%"));
}
if(criteria.getPeriod()!=null) {
predicates.add(cb.equal(period, criteria.getPeriod()));
}
if(criteria.getTravelStatus()!=null) {
predicates.add(cb.equal(travelStatus, criteria.getTravelStatus()));
}
if(criteria.getTravelType()!=null) {
predicates.add(cb.equal(travelType, criteria.getTravelType()));
}
if(criteria.getLastName()!=null ) {
predicates.add(cb.like(lastName, "%"+criteria.getLastName()+"%"));
}
return cb.and(predicates.toArray(new Predicate[predicates.size()]));
}
}
最后,这是我的搜索方法:
@RequestMapping("/search")
public ModelAndView search(
@ModelAttribute TravelSearch travelSearch,
Pageable pageable) {
ModelAndView mav = new ModelAndView("travels/list");
TravelSpecification tspec = new TravelSpecification(travelSearch);
Page<Travel> travels = travelRep.findAll(tspec, pageable);
PageWrapper<Travel> page = new PageWrapper<Travel>(travels, "/search");
mav.addObject(travelSearch);
mav.addObject("page", page);
mav.addObject("schools", schoolRep.findAll() );
mav.addObject("periods", periodRep.findAll() );
mav.addObject("travelTypes", TravelTypeEnum.values());
mav.addObject("travelStatuses", TravelStatusEnum.values());
return mav;
}
希望我有所帮助!
Travel_
,Candidact_
等对象是由Hibernate自动创建的元模型,它们可以帮助您构建查询。更多信息请参见:https://docs.jboss.org/hibernate/jpamodelgen/1.0/reference/en-US/html_single/#whatisit - Serafeim