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

Question

我有一个使用 spring-data-jpa 进行数据访问的 spring-mvc 项目。我有一个名为 Travel 的域对象我想让最终用户对其应用许多过滤器。

为此，我实现了以下 Controller :

@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 的表单输入框，可用于过滤游记。

除了姓氏之外，我的 Travel域对象有更多我想过滤的属性。我认为如果这些属性都是字符串，那么我可以将它们添加为 @RequestParam s 并添加一个 spring-data-jpa 方法来查询这些。例如，我会添加一个方法 findByLastNameLikeAndFirstNameLikeAndShipNameLike .

但是，当我需要过滤外键时，我不知道该怎么做。所以我的Travel有一个 period作为 Period 的外键的属性域对象，我需要将其作为下拉列表供用户选择 Period .

我想要做的是，当时间段为空时，我想检索由 lastName 过滤的所有旅行，当时间段不为空时，我想检索由 lastName 过滤的这段时间的所有旅行。

我知道如果我在我的存储库中实现两个方法并使用 if 就可以做到这一点。到我的 Controller :

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 ?我的旅行不仅有时间段，还有其他需要使用下拉列表过滤的属性!正如您所理解的，当我需要使用更多下拉菜单时，复杂性会成倍增加，因为需要考虑所有组合:(

2013 年 3 月 12 日更新:继续 M. Deinum 的出色回答，在实际实现之后，我想提供一些意见以确保问题/答案的完整性:

1. 而不是实现 JpaSpecificationExecutor你应该执行JpaSpecificationExecutor<Travel>以避免类型检查警告。

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

希望我能帮上忙!

Answer 1

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

1. 使用 JpaSpecificationExecutor 并编写一个 Specification
2. 使用 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.
    }
}

最后你需要修改你的 Controller 以使用新的 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);
    }
}

另见 this bog post .