使用spring-data-jpa和spring-mvc过滤数据库行

Question

我有一个使用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的优秀答案并实际实施之后，我想提供一些评论以完整地回答问题/答案：

1. 实现JpaSpecificationExecutor<Travel>而不是实现JpaSpecificationExecutor可以避免类型检查警告。

2. 请查看kostja对此问题的优秀答案Really dynamic JPA CriteriaBuilder，因为如果您想要正确的过滤器，则将需要实现它。

3. 我能找到的Criteria API最好的文档是http://www.ibm.com/developerworks/library/j-typesafejpa/。这是一个相当长的读物，但我强烈推荐它-阅读后，我对Root和CriteriaBuilder的大部分问题都得到了回答 :)

4. 无法重复使用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;
}

希望我有所帮助！

- Serafeim

---

你是如何将TravelSearch中的属性转换为List<Predicate>的？能否分享一下你的代码？谢谢。 - priyank

Travel_, Candidact_等对象是由Hibernate自动创建的元模型，它们可以帮助您构建查询。更多信息请参见：https://docs.jboss.org/hibernate/jpamodelgen/1.0/reference/en-US/html_single/#whatisit - Serafeim

你是正确的，这些元模型是自动生成的。您需要像这里所述( http://hibernate.org/orm/tooling/) 添加 hibernate-jpamodelgen 依赖项到您的 pom.xml 文件中。我已经很多年没有使用过它了（当时我在使用 eclipse），但我IRC认为当您添加依赖时，元模型类将自动生成。然后，您将能够将这些元模型作为查询的依赖项使用。 - Serafeim

我不确定为什么元模型类没有被生成，但自己添加它并不是一个好主意，因为这违反了元模型类的整体目的！元模型类的名称可能可以更改为其他名称，例如TravelMETA，但我不知道如何更改！最后，元模型需要对您的查询进行静态检查，即在编译时进行检查，而不是编写可能导致运行时错误的HSQL。 - Serafeim

欢迎@AndreyM.Stepanov，我很高兴你解决了问题。至于你的另一个问题，是的，我发现Django比Spring更舒适和直观。它没有那么多魔法（文档也很好，源代码易于访问），使您始终知道出了什么问题！此外，有大量的内置功能（模板、认证、权限、管理、表单、表格、ORM）可以“轻松使用”；虽然您也可以在Spring中使用这些，但是将所有这些与您的应用程序正确集成是一项痛苦而困难的任务。 - Serafeim

Answer 1

首先，您应该停止使用@RequestParam，将所有搜索字段放入一个对象中（可能可以重用Travel对象）。然后，您有两个选项可用于动态构建查询：

1. 使用JpaSpecificationExecutor编写Specification
2. 使用QueryDslPredicateExecutor和QueryDSL编写谓词。

使用JpaSpecificationExecutor

首先在TravelRepository中添加JpaSpecificationExecutor，这将为您提供一个findAll(Specification)方法，并且您可以删除自定义的查找器方法。

public interface TravelRepository extends JpaRepository<Travel, Long>, JpaSpecificationExecutor<Travel> {}

你可以在你的仓库(repository)中创建一个方法，该方法使用规约(Specification)来构建查询。具体实现可以参考Spring Data JPA文档。

你只需要创建一个实现了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);
    }
}

请参考这篇博客文章。

- M. Deinum

---

另一个问题：您知道在哪里可以找到有关如何实现TravelSpecification的“toPredicate”方法的一些好信息（或API）吗？谢谢！ - Serafeim

JPA文档，假设您使用Hibernate，请查看Hibernate文档。Criteria API来自JPA，因此可能会有一些相关的教程。 - M. Deinum

一个伟大的项目，例如specification-arg-resolver可以被使用。阅读博客文章。 - rmalviya