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

我有一个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 之外,我的域对象还有很多属性可供我筛选。我认为,如果这些属性都是字符串,那么我可以将它们添加为s,并添加一个spring-data-jpa方法来查询这些属性。例如,我会添加一个方法。Travel@RequestParamfindByLastNameLikeAndFirstNameLikeAndShipNameLike

但是,我不知道当我需要过滤外键时,我该怎么做。因此,我有一个属性是域对象的外键,我需要将其作为下拉列表,以便用户选择.TravelperiodPeriodPeriod

我想做的是,当周期为空时,我想检索按姓氏过滤的所有行程,当句点不为空时,我想检索按姓氏过滤的此时间段的所有行程。

我知道,如果我在我的存储库中实现两个方法并使用一个到我的控制器,这可以完成: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. 与其实现,不如实现以避免类型检查警告。JpaSpecificationExecutorJpaSpecificationExecutor<Travel>

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

  3. 我能找到的关于标准API的最好的文档是 http://www.ibm.com/developerworks/library/j-typesafejpa/。这是一个相当长的阅读,但我完全推荐它 - 阅读后,我对Root和CriteriaBuilder的大多数问题都得到了:)

  4. 重用该对象是不可能的,因为它包含各种其他对象(也包含其他对象),我需要使用这些对象进行搜索 - 相反,我使用了一个包含我需要搜索的字段的对象。TravelLikeTravelSearch

2015 年 5 月 10 日更新:根据 @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;
}

希望我有帮助!


答案 1

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

  1. 使用 并编写JpaSpecificationExecutorSpecification
  2. 使用 并使用 QueryDSL 编写谓词。QueryDslPredicateExecutor

JpaSpecificationExecutor

首先添加 您的这将为您提供一个方法,您可以删除自定义查找器方法。JpaSpecificationExecutorTravelRepositoryfindAll(Specification)

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

然后,您可以在存储库中创建一个方法,该方法使用基本上构建查询的方法。请参阅Spring Data JPA文档Specification

您唯一需要做的就是创建一个类,该类根据可用的字段实现并构建查询。该查询是使用 JPA 条件 API 链接构建的。Specification

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

首先添加 您的这将为您提供一个方法,您可以删除自定义查找器方法。QueryDslPredicateExecutorTravelRepositoryfindAll(Predicate)

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

接下来,您将实现一个服务方法,该方法将使用该对象通过 QueryDSL 生成谓词。Travel

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

另请参阅此沼泽帖子


答案 2

推荐