我有一个spring-mvc项目,它使用spring-data-jpa进行数据访问。我有一个名为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
。
我想要做的是当句点为空时我想要检索由lastName过滤的所有旅行,当句点不为空时我想要检索由lastName过滤的这段时间的所有旅行。
我知道如果我在我的存储库中实现两个方法并使用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的优秀答案开始,在实际实施之后,我想就问题的完整性提供一些意见/ asnwer:
您应该实施JpaSpecificationExecutor
而不是实施JpaSpecificationExecutor<Travel>
,以避免类型检查警告。
请看看kostja对这个问题的出色回答 Really dynamic JPA CriteriaBuilder 因为如果你想拥有正确的过滤器,将需要实现这一点。
我能够为Criteria API找到的最佳文档是http://www.ibm.com/developerworks/library/j-typesafejpa/。这是一个相当长的阅读,但我完全推荐它 - 在阅读之后,我对Root和CriteriaBuilder的大部分问题都得到了回答:)
重用Travel
对象是不可能的,因为它包含我需要使用Like
搜索的各种其他对象(也包含其他对象) - 而是使用了{{1包含我需要搜索的字段的对象。
更新10/05/15 :根据@ priyank的要求,以下是我实施TravelSearch对象的方式:
TravelSearch
TravelSpecification使用了这个对象(大多数代码都是特定于域的,但我将其留在那里作为例子):
public class TravelSearch {
private String lastName;
private School school;
private Period period;
private String companyName;
private TravelTypeEnum travelType;
private TravelStatusEnum travelStatus;
// Setters + Getters
}
最后,这是我的搜索方法:
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()]));
}
}
希望我帮忙!
答案 0 :(得分:58)
对于初学者,您应该停止使用@RequestParam
并将所有搜索字段放在一个对象中(可能会重复使用Travel对象)。然后,您有2个选项可用于动态构建查询
JpaSpecificationExecutor
并撰写Specification
QueryDslPredicateExecutor
并使用QueryDSL编写谓词。JpaSpecificationExecutor
首先将JpaSpecificationExecutor
添加到TravelRepository
这将为您提供findAll(Specification)
方法,您可以删除自定义查找程序方法。
public interface TravelRepository extends JpaRepository<Travel, Long>, JpaSpecificationExecutor<Travel> {}
然后,您可以在存储库中创建一个方法,该方法使用基本构建查询的Specification
。请参阅Spring Data JPA documentation。
您唯一需要做的就是创建一个实现Specification
的类,并根据可用的字段构建查询。该查询是使用JPA Criteria API链接构建的。
public class TravelSpecification implements Specification<Travel> {
private final Travel criteria;
public TravelSpecification(Travel criteria) {
this.criteria=criteria;
}
public Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder builder) {
// create query/predicate here.
}
}
最后你需要修改你的控制器以使用新的findAll
方法(我冒昧地清理它)。
@RequestMapping("/search")
public String search(@ModelAttribute Travel search, Pageable pageable, Model model) {
Specification<Travel> spec = new TravelSpecification(search);
Page<Travel> travels = travelRep.findAll(spec, pageable);
model.addObject("page", new PageWrapper(travels, "/search"));
return "travels/list";
}
QueryDslPredicateExecutor
首先将QueryDslPredicateExecutor
添加到TravelRepository
这将为您提供findAll(Predicate)
方法,您可以删除自定义查找程序方法。
public interface TravelRepository extends JpaRepository<Travel, Long>, QueryDslPredicateExecutor<Travel> {}
接下来,您将实现一个服务方法,该方法将使用Travel
对象使用QueryDSL构建谓词。
@Service
@Transactional
public class TravelService {
private final TravelRepository travels;
public TravelService(TravelRepository travels) {
this.travels=travels;
}
public Iterable<Travel> search(Travel criteria) {
BooleanExpression predicate = QTravel.travel...
return travels.findAll(predicate);
}
}