使用spring-data-jpa和spring-mvc過濾數據庫行

Question

我有一個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輸入框的表單，該表單可用於過濾Travels。

除了lastName之外，我的Travel域對象還有很多我想用來過濾的屬性。 我認為，如果這些屬性都是字符串，那么我可以將它們添加為@RequestParam並添加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嗎？ 我的旅行不僅具有期間，還具有需要使用下拉列表過濾的其他屬性！ 如您所知，當我需要使用更多的下拉菜單時，復雜度將成倍增加，因為需要考慮所有組合:(

2013年3月12日更新 ： 接替Deinum先生的出色回答，在實際實施之后，我想提出一些評論，以確保問題/答案的完整性：

1. 代替實現JpaSpecificationExecutor您應該實現JpaSpecificationExecutor<Travel>以避免類型檢查警告。

2. 請看一下kostja對這個問題的出色回答。 真正的動態JPA CriteriaBuilder，因為如果您想擁有正確的過濾器， 則需要實現這一點。

3. 我可以找到的有關Criteria API的最佳文檔是http://www.ibm.com/developerworks/library/j-typesafejpa/ 。 這是一篇相當長的讀物，但我完全推薦它-閱讀后，我對Root和CriteriaBuilder的大部分問題都得到了回答:)

4. 重用Travel對象是不可能的，因為它包含我需要使用Like搜索的其他各種對象（也包含其他對象）-相反，我使用了TravelSearch對象，其中包含需要搜索的字段。

2015年10月5日更新 ：按照@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的方法，該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);
    }
}

另請參閱此沼澤帖子 。