Фильтрация строк базы данных с помощью 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, мой объект домена Travel
имеет намного больше атрибутов, по которым я хотел бы фильтровать. Я думаю, что если бы эти атрибуты были всеми строками, я мог бы добавить их как @RequestParam
и добавить к ним метод spring -data-jpa. Например, я бы добавил метод findByLastNameLikeAndFirstNameLikeAndShipNameLike
.
Однако я не знаю, как это сделать, когда мне нужно фильтровать внешние ключи. Таким образом, мой Travel
имеет атрибут period
, который является внешним ключом для объекта домена period
, который должен иметь его в качестве раскрывающегося списка для выбора пользователем period
.
То, что я хочу сделать, это когда нулевой период. Я хочу получить все проходы, отфильтрованные последним именем, и когда период не равен нулю. Я хочу получить все перемещения за этот период, отфильтрованные последним именем.
Я знаю, что это можно сделать, если я реализую два метода в моем репозитории и использую 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
? My Travel имеет не только период, но и другие атрибуты, которые необходимо фильтровать с помощью выпадающих меню! Как вы можете понять, сложность будет экспоненциально увеличиваться, когда мне нужно использовать больше выпадающих списков, потому что все комбинации должны быть учтены: (
Обновление 03/12/13: Продолжая от М. Дейнума отличный ответ, и после его фактического осуществления я хотел бы дать несколько комментариев для полноты вопроса /asnwer:
-
Вместо реализации JpaSpecificationExecutor
вы должны реализовать JpaSpecificationExecutor<Travel>
, чтобы избежать предупреждений проверки типов.
-
Пожалуйста, взгляните на костя отличный ответ на этот вопрос
Действительно динамический JPA CriteriaBuilder
так как вам нужно будет реализовать это, если вы хотите иметь правильные фильтры.
-
Лучшей документацией, которую я смог найти для API критериев, было http://www.ibm.com/developerworks/library/j-typesafejpa/. Это довольно длинное чтение, но я его полностью рекомендую - после прочтения этого ответа на большинство моих вопросов для Root и CriteriaBuilder ответили:)
-
Повторное использование объекта 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;
}
Надеюсь, я помог!
Ответы
Ответ 1
Для начала вам следует прекратить использование @RequestParam
и поместить все поля поиска в объект (возможно, повторно использовать объект Travel для этого). Затем у вас есть 2 варианта, которые вы могли бы использовать для динамического построения запроса
- Используйте
JpaSpecificationExecutor
и напишите a Specification
- Используйте
QueryDslPredicateExecutor
и используйте QueryDSL для записи предиката.
Используя JpaSpecificationExecutor
Сначала добавьте JpaSpecificationExecutor
к вашему TravelRepository
, это даст вам метод findAll(Specification)
, и вы сможете удалить свои настраиваемые методы поиска.
public interface TravelRepository extends JpaRepository<Travel, Long>, JpaSpecificationExecutor<Travel> {}
Затем вы можете создать метод в своем репозитории, который использует Specification
, который в основном создает запрос. Для этого см. Spring Data JPA .
Единственное, что вам нужно сделать, это создать класс, который реализует Specification
и который строит запрос на основе доступных полей. Запрос создается с использованием API-интерфейса API JPA.
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);
}
}
См. также этот болотный стол.