web-dev-qa-db-ja.com

spring-data-jpaおよびspring-mvcを使用したデータベース行のフィルタリング

データアクセスに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;
}

これは正常に機能します。ユーザーは、Travelsをフィルタリングするために使用できるlastName入力ボックスを持つフォームを持っています。

LastName以外にも、Travelドメインオブジェクトには、フィルタリングする属性が多くあります。これらの属性がすべて文字列の場合、@RequestParamsとして追加し、spring-data-jpaメソッドを追加してこれらのクエリを実行できると思います。たとえば、メソッドfindByLastNameLikeAndFirstNameLikeAndShipNameLikeを追加します。

ただし、外部キーをフィルタリングする必要がある場合、どうすればよいのかわかりません。したがって、Travelにはperiodドメインオブジェクトへの外部キーであるPeriod属性があります。これは、ユーザーがPeriodを選択するためのドロップダウンとして必要です。

期間がnullの場合、lastNameでフィルター処理されたすべての旅行を取得し、期間がnullでない場合、lastNameでフィルター処理されたこの期間のすべての旅行を取得します。

リポジトリに2つのメソッドを実装し、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を使用してこれを行う方法withoutはありますか？私の旅行には期間だけでなく、ドロップダウンを使用してフィルタリングする必要がある他の属性もあります!!理解できるように、より多くのドロップダウンを使用する必要がある場合、すべての組み合わせを考慮する必要があるため、複雑さが指数関数的に増加します:(

更新03/12/13：M. Deinumの優れた回答に続き、実際に実装した後、質問/回答者の完全性についてコメントを提供したいと思います。

  1. JpaSpecificationExecutorを実装する代わりに、JpaSpecificationExecutor<Travel>を実装して、型チェックの警告を回避する必要があります。

  2. この質問に対するkostjaの優れた回答をご覧ください 本当に動的なJPA CriteriaBuilder 正しいフィルターが必要な場合はwillこれを実装する必要があるためです。

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

私が助けたことを願っています！

javaspringspring-mvcspring-dataspring-data-jpa
44
Serafeim

まず、_@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 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)メソッドが提供され、カスタム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);
    }
}
_

this bog post も参照してください。

62
M. Deinum