Spring Data JPA - Zapytania Natywne

Zapytanie grupujące jako Native Query

public interface ItemRepository extends JpaRepository<Item, Long> {

    @Query(value = "select ac.name, count(aci.items_id) from appa_categories_items aci "
            + "inner join appa_categories ac on ac.id=aci.categories_id "
            + "group by aci.categories_id", nativeQuery = true)
    List<Object[]> findAppaItemsNumberByCategory();
}

• Parametry wykorzystywane w tekście zapytania poprzedzamy dwukropkiem, np.: :lastName
• Domyślnie parametry metody są przyporządkowane do parametrów z treści zapytania na podstawie kolejności miejsc, więc możemy NIE oznaczać parametrów metody za pomocą adnotacji @Param. Takie podejście bywa jednak problematyczne, w przypadku ewentualnych zmian w metodzie w przyszłości, szczególnie w przypadku refactoringu.
• Stosujemy adnotację @Param, aby przyporządkować parametry metody do parametrów z treści zapytania na podstawie nazwy przekazanej do adnotacji. Nazwa musi zgadzać się z nazwą użytą w treści zapytania (po dwukropku). Nie jest wtedy wymagana zgodność co do kolejności parametrów.
• W przypadku gdy chcemy dodać do zapytania opcje stronicowania Pageable lub sortowania Sort, dodajemy te typy na ostatniej pozycji wśród parametrów metody. Tutaj jedna uwaga. W przypadku użycia interfejsu do stronicowania w ramach zapytań natywnych, jesteśmy zobowiązani do podania zapytania zliczającego w ramach adnotacji @Query:

  public interface UserRepository extends JpaRepository<Item, Long> {
  
      @Query(value = "select * from users where lastName = :lastName /*#pageable*/ "
      		+ "order by lastName",
      countQuery = "select count(*) from users where lastName = :lastName",
      nativeQuery = true)
      Page findByLastname(String lastName, Pageable pageable);
  }
  
  

  Na koniec tego wątku musimy wspomnieć o bardzo ważnej rzeczy, która może się wydawać niejasna patrząc na powyższe zapytanie. Dotyczy ona zwrotu /*#pageable*/, który został dodany do zapytania jako workaround, aby takie zapytanie w ogóle zadziałało. Okazuje się bowiem, że Spring Data JPA przed wersją 2.x posiada błąd, który skutkuje tym, że podając w metodzie jako parametr interfejs Pageable nie jesteśmy w stanie takiego zapytania w ogóle uruchomić. Otrzymujemy błąd:

  Caused by: org.springframework.data.jpa.repository.query.
                                              InvalidJpaQueryMethodException:
  Cannot use native queries with dynamic sorting and/or pagination in method
      public abstract org.springframework.data.domain.Page
      com.javappa.startappa.appaimport.repository.UserRepository
      .findByLastname(java.lang.String,org.springframework.data.domain.Pageable)
      at org.springframework.data.jpa.repository.query.NativeJpaQuery.
      (NativeJpaQuery.java:55)
      at org.springframework.data.jpa.repository.query.JpaQueryFactory.
          fromMethodWithQueryString(JpaQueryFactory.java:72)
      at org.springframework.data.jpa.repository.query.JpaQueryFactory.
          fromQueryAnnotation(JpaQueryFactory.java:53)
  

  Jest to o tyle nielogiczne, że w oficjalnej dokumentacji Springa jest napisane, że o ile dynamiczne sortowanie nie jest wspierane, o tyle można użyć natywnych zapytań do paginacji poprzez podanie własnego zapytania COUNT oraz dodanie Pageable jako parametru metody. Okazuje się jednak, że z powodu błędnie zaimplementowanego kodu klasy NativeJpaQuery wymagane jest dodatkowo posiadanie wspomnianego tekstu w treści zapytania:

  public NativeJpaQuery(JpaQueryMethod method, EntityManager em, String queryString, 
      EvaluationContextProvider evaluationContextProvider,
                                                  SpelExpressionParser parser) {
     super(method, em, queryString, evaluationContextProvider, parser);
     JpaParameters parameters = method.getParameters();
     boolean hasPagingOrSortingParameter = parameters.hasPageableParameter() 
                      || parameters.hasSortParameter();
     boolean containsPageableOrSortInQueryExpression =
                                                  queryString.contains("#pageable")
                                                      || queryString.contains("#sort");
  
     if(hasPagingOrSortingParameter && !containsPageableOrSortInQueryExpression) {
         throw new InvalidJpaQueryMethodException("Cannot use native queries
                          with dynamic sorting and/or pagination in method " + method);
     }
  }
  

  Powyższy błąd został naprawiony przez programistów Springa dopiero w wersji 2.0.4 w marcu 2018 roku.

Zapytanie typu UPDATE lub DELETE

Autor: Jarek Klimas

Data: 03 stycznia 2024

Labele: Backend, Podstawowy, Java

Czy informacje, które otrzymałeś, były pomocne?
Jeśli tak, zapraszam Cię do podarowania mi kawy.

[TEORIA i PRAKTYKA]  Strefa doładowania wiedzy

W tej strefie znajdziesz wszystko co niezbędne, aby komfortowo uczyć się Hibernate'a. Doskonale opisany kod nie zawiera zbędnych komplikacji, tylko samą esencję w postaci praktycznych przykładów. Tutaj odnajdziesz wszystko co jest istotne w danym temacie. Otrzymujesz pakiet złożony z kilku projektów wraz z obszernym wytłumaczeniem kodu.

Hibernate w Springu - Materiały