Spring Data repository with empty IN clause.

The problem I’ve stabled upon started with a spring data repository like this:

public interface SampleRepository extends CrudRepository<Sample, Integer>{
    @Query("select s from Sample s where s.id in :ids")
    List<Sample> queryIn(@Param("ids") List<Integer> ids);
}

Actual query was of course more complicated that this. Complex enough to justify not using a query method. The problem emerges when you run this method with an empty collection as argument:

repository.queryIn(Collections.emptyList());

The result is database dependent. There no problem on H2, but on HSQLDB (and also at least on MSSQL) you get:

Caused by: org.hsqldb.HsqlException: unexpected token: )
	at org.hsqldb.error.Error.parseError(Unknown Source)
	at org.hsqldb.ParserBase.unexpectedToken(Unknown Source)
	...

Syntax error in generated SQL query? How come? Lets first look at how in clause is handled by hibernate. Starting with a query that is run with a non-empty list parameter

repository.queryIn(Arrays.asList(1, 2, 3));

the SQL generated by hibernate looks something like this

select
    sample0_.id as id1_0_,
    sample0_.name as name2_0_ 
from
    sample sample0_ 
where
    sample0_.id in (
        ? , ? , ?
    )

Turns out that hibernate can’t pass an array directly to the in clause. It has to create a sql parameter for every entry in the collection.
Aha, so when the collection passed to the query is empty, the SQL becomes:

select
    sample0_.id as id1_0_,
    sample0_.name as name2_0_ 
from
    sample sample0_ 
where
    sample0_.id in ()

Here is where the syntax error comes in. The SQL standard does require at least one value expression between the parenthesis. So the closing bracket ), right after (, causes HSQLDB’s SQL parser to throw a syntax error. Quite rightly though.

Solutions

First of all, let me point out, that a corresponding find..In() query method works fine for an empty parameter:

public interface SampleRepository extends CrudRepository<Sample, Integer>{
    List<Sample> findByIdIn(List<Integer> ids);
}

So the following test passes:

@Test
public void findByIdIn() {
    List<Sample> result = repository.findByIdIn(Collections.emptyList());
    assertThat(result, empty());
}

But what to do, when the query is complex or would yeld a ridiculously long query method name like

findByProduct_Category_EmployeeResponsible_Departament_Location_CityIn(
   List<City> cities
)

A custom @Query won’t work, but there’s another option. JPA Criteria API. This is whatSpring Data JPA is actually using under the hood to generate JPA queries from query methods.

The bridge between Criteria API and Spring Data repositories is called Specifications. First thing is to make your repository implement JpaSpecificationExecutor<T>:

public interface SampleRepository extends 
    CrudRepository<Sample, Integer>, 
    JpaSpecificationExecutor<Sample>  {
    
    // ...
    
}

Now you can call findAll(Specification<T>) method on your repository:

repository.findAll(new Specification<Sample>() {
    @Override
    public Predicate toPredicate(Root<Sample> root, 
        CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
        // ....
    }
})

Great! You get a place, where you can dynamically create any WHERE clause using Criteria API.

The criteria corresponding to SQL’s

WHERE id IN (1,2,3)

is

root.get("id").in(1,2,3);
//or 
List<Integer> ids = Arrays.asList(1,2,3);
root.get("id").in(ids);

It’s worth noting here, that most of the Criteria API tutorials use the type-safe generatedMetamodel classes. But it might be an overkill to set up persistence provider’s annotation processor just to handle a few queries. Most of your queries will probably be handled fine by Spring Data Query methods. Fortunately there’s an option to use string’s instead of Metamodel properties, like in the example above.

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다.
어린이용이며, 설치가 필요없는 브라우저 게임입니다.
https://s1004games.com

Just using root.get("id").in(ids) will not save you from the possible SQL syntax error when ids are empty. But as the query is created dynamically, you have full control whether to include the in() statement or not. To mimic the spring’s standard find...In() behaviour use this predicate:

@Override
public Predicate toPredicate(Root<Sample> root, 
        CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
    if (ids.isEmpty()) {
        return criteriaBuilder.disjunction();
    } else {
        return root.get("id").in(ids);
    }
}

The mystic disjunction() is a simple clause that is always FALSE. The exact javadocstates:

Create a disjunction (with zero disjuncts). A disjunction with zero disjuncts is false.

All right. It’s a working solution, but it can be made less verbose when using Java 8. First step is the replace the anonymous class with a lambda:

findAll((root, criteriaQuery, criteriaBuilder) -> {
    if (ids.isEmpty()) {
        return criteriaBuilder.conjunction()
    } else {
        return root.get("id").in(ids);
    }
});

In this exact case it may be tempting to even use the conditional (?:) operator, so that the brackets ({}) and return can be omitted:

findAll((root, criteriaQuery, criteriaBuilder) ->
    ids.isEmpty() ? criteriaBuilder.conjunction() : root.get("id").in(ids)
);

The other thing is, that it would be nice to have this method available directly on the repository, not in some service class. Here, next new Java 8 feature come in handy - interface default methods.

import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
import org.springframework.data.repository.CrudRepository;

import java.util.List;

public interface SampleRepository extends CrudRepository<Sample, Integer>,
    JpaSpecificationExecutor<Sample> {
  
  // ...
 
  default List<Sample> findIn(List<Integer> ids) {
    return findAll((root, criteriaQuery, criteriaBuilder) ->
      ids.isEmpty() 
        ? criteriaBuilder.conjunction() 
        : root.get("id").in(ids)
    );
  }
}

New you can call this custom query method like any other repository method:


@Test
public void nonEmptySpecIn() {
    List<Integer> ids = Arrays.asList(1, 2, 3);
    List<Sample> result = repository.findIn(ids);
    
    assertThat(
        result.stream()
            .map(sample -> sample.id)
            .collect(toList()),
        equalTo(ids)
    );
}

Select all on empty IN

Common case with IN clauses is when you have a search filter like:

Select categories:
[x] Home & Garden
[ ] Beauty, Health & Food
[ ] Sport & Outdoors

In this case, when the selected categories collection is empty, you want this filter to be ignored.
Having a predicate creation method, this change becomes trivial;

default List<Sample> findIn(List<Integer> ids) {
    return findAll((root, criteriaQuery, criteriaBuilder) -> {
        if (ids.isEmpty()) {
            return null; // or criteriaBuilder.conjunction()
        } else {
            return root.get("id").in(ids);
        }
    });
}

As for the null here. The toPredicate() documentation says that you are not allowed to return it here. But it turn out that spring data handles it rather correctly. I’ve placed apull request to update the javadoc.

The complete sample code used in this article in available on github.

 

[출처] https://rzymek.github.io/post/jpa-empty-in/

 

 

 

본 웹사이트는 광고를 포함하고 있습니다.
광고 클릭에서 발생하는 수익금은 모두 웹사이트 서버의 유지 및 관리, 그리고 기술 콘텐츠 향상을 위해 쓰여집니다.
번호 제목 글쓴이 날짜 조회 수
284 Demonstrates CellEditors : Table « SWT JFace Eclipse « Java file 졸리운_곰 2019.06.16 38
283 Demonstrates TableViewers : Table « SWT JFace Eclipse « Java file 졸리운_곰 2019.06.16 60
282 Java and JMX - Building Manageable Systems secret 졸리운_곰 2019.05.26 0
281 Single_Sourcing_RAP_RCP_en.pdf file 졸리운_곰 2019.05.15 27
280 Rich client platform 설명 및 배우기 참고 졸리운_곰 2019.05.15 89
279 Rich Ajax Platform, Part 1: 소개 file 졸리운_곰 2019.05.15 127
278 또 하나의 크로스 플랫폼: Eclipse RAP file 졸리운_곰 2019.05.15 143
277 Eclipse 4 RCP 튜토리얼(완료) file 졸리운_곰 2019.05.14 682
276 [JPA] 쿼리메서드 : 쿼리 연습 조회(findBy..) , 페이징처리 졸리운_곰 2019.03.24 1614
275 스프링 데이터 JPA 레퍼런스 번역 file 졸리운_곰 2019.03.24 1013
274 JPA 개념, class05 JPA 환경설정 졸리운_곰 2019.03.24 53
273 [자바코드] 고유값인 UUID, GUID 생성하기 졸리운_곰 2019.02.27 248
272 [JPA] 복합키 졸리운_곰 2019.02.26 40
271 Spring Batch Multithreading Example file 졸리운_곰 2019.01.31 77
270 Spring batch를 Parallel로 돌려보자 졸리운_곰 2019.01.31 88
269 [GC] 강제로 GC시키기Java 메모리 full 발생시 강제로 GC 시키기 졸리운_곰 2019.01.22 224
268 Java Map 반복(Iteration)시키는 3가지 방법 졸리운_곰 2019.01.01 65
267 jpa muli row select result is same row repeat Java 자바 Jpa에서 멀티 로우 반환시 같은값이 반복 file 졸리운_곰 2019.01.01 153
266 [자바] 리스트를 순회하는 방법 졸리운_곰 2018.12.31 67
265 SpringBoot JPA 예제 졸리운_곰 2018.12.31 55
대표 김성준 주소 : 경기 용인 분당수지 U타워 등록번호 : 142-07-27414
통신판매업 신고 : 제2012-용인수지-0185호 출판업 신고 : 수지구청 제 123호 개인정보보호최고책임자 : 김성준 sjkim70@stechstar.com
대표전화 : 010-4589-2193 [fax] 02-6280-1294 COPYRIGHT(C) stechstar.com ALL RIGHTS RESERVED