使用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域对象还具有许多我想用来过滤的属性。我认为如果这些属性都是字符串，那么我可以将它们添加为@RequestParams，并添加spring-data-jpa方法以通过这些进行查询。例如，我要添加一个方法findByLastNameLikeAndFirstNameLikeAndShipNameLike。

但是，当需要过滤外键时，我不知道该怎么办。因此，我Travel的period属性是Period域对象的外键，我需要将其作为下拉菜单供用户选择Period。

我想做的是，当时间段为null时，我要检索由lastName过滤的所有行程；当时间段不为null时，我要检索由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？我的旅行不仅具有期间，还具有需要使用下拉列表过滤的其他属性！如你所知，当我需要使用更多下拉菜单时，复杂度将成倍增加，因为需要考虑所有组合:(

接替Deinum先生的出色回答，在实际实施之后，我想提出一些评论，以确保问题/答案的完整性：

1. 除了实施之外，JpaSpecificationExecutor你应该实施JpaSpecificationExecutor 避免类型检查警告。

2. 请看一下kostja对这个问题的出色回答。 真正的动态JPA CriteriaBuilder， 因为如果你想拥有正确的过滤器，则需要实现它。

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

4. 重用该Travel对象是不可能的，因为它包含了我需要搜索使用的其他各种对象（也包含其他对象）Like-而是使用了一个TravelSearch包含需要搜索的字段的对象。

这是我实现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;
}

Answer 1

对于初学者，你应该停止使用@RequestParam并将所有搜索字段放在一个对象中（也许为此使用Travel对象）。然后，你可以使用2个选项来动态构建查询

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

使用 JpaSpecificationExecutor

首先添加JpaSpecificationExecutor到你的TravelRepository这会给你一个findAll(Specification)方法，你可以删除自定义finder方法。

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

然后，你可以在存储库中创建一个使用的方法，该方法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)方法，你可以删除自定义finder方法。

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