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

Posted 2023-02-26

【中文标题】使用 spring-data-jpa 和 spring-mvc 过滤数据库行

【英文标题】：Filtering database rows with spring-data-jpa and spring-mvc

【发布时间】：2013-12-15 08:26:59

【问题描述】：

我有一个使用 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 输入框的表单，可用于过滤游记。

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

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

我想要做的是，当时间段为空时，我想检索由 lastName 过滤的所有旅行，当时间段不为空时，我想检索由 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 日更新：继续 M. Deinum 的出色回答，在实际实施之后，我想提供一些 cmets 以确保问题/答案的完整性：

您应该实现JpaSpecificationExecutor<Travel>，而不是实现JpaSpecificationExecutor，以避免出现类型检查警告。

请查看 kostja 对此问题的出色回答 Really dynamic JPA CriteriaBuilder 因为如果您想拥有正确的过滤器，您将需要实现这一点。

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

无法重用 Travel 对象，因为它包含我需要使用 Like 搜索的各种其他对象（也包含其他对象） - 相反，我使用了包含我需要搜索的字段。

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;

希望我能帮上忙！

【问题讨论】：

您如何将 TravelSearch 中的属性转换为 List。你能分享你的代码吗？谢谢。

Travel_、Candidact_ 等对象是由 hibernate 自动创建的元模型，可帮助您构建查询。更多信息：docs.jboss.org/hibernate/jpamodelgen/1.0/reference/en-US/…

您是正确的，因为这些元模型是自动生成的。您需要将 hibernate-jpamodelgen 依赖项添加到您的 pom.xml 中，如下所述：hibernate.org/orm/tooling。自从我上次使用它已经有很多年了（当时我正在使用 eclipse）但是当你添加依赖项时，IIRC 元模型类将由它们自己自动生成。然后，您就可以将这些元模型用作查询的依赖项。

我不确定为什么不生成元模型类，但是自己添加它不是一个好主意，因为这超出了元模型类的全部目的！元模型类的名称可能可以更改为其他名称，例如 TravelMETA，但我不知道如何！最后，元模型需要对您的查询进行静态检查，也就是说，不要编写可能在运行时导致错误的 hsql，而是在编译时进行检查。

欢迎您@AndreyM.Stepanov 很高兴您解决了您的问题。至于你的另一个问题，是的，我发现 Django 比 Spring 更舒适、更直接。魔力要少得多（而且文档很棒，源代码也很容易访问），让您始终知道哪里出了问题！此外，还有大量包含电池的东西（模板、身份验证、权限、管理、表单、表格、ORM）“正常工作”；你也可以在 Spring 中拥有这些，但将所有这些与你的应用程序正确集成是一个痛苦而艰难的过程。

【参考方案1】：

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

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

最后你需要修改你的控制器以使用新的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。

【讨论】：

另一个问题：你知道我应该在哪里找到一些关于如何实现 TravelSpecification 的“toPredicate”方法的好信息（或 API）吗？谢谢！

JPA 文档并假设您使用休眠检查休眠文档。 Criteria API 来自 JPA，因此可能有一些教程。

可以使用specification-arg-resolver这样的大项目。阅读博客post。