JPA @Query

@Query

🤔앞서 배웠던 내용만 활용할수있으면 JPA는 쓸수 있다. 하지만 약간의 예외적인 상황에서 Custom해야하는 상황이 생긴다. 그럴때는 @Query를 써보자.

왜? @Query🤔🤔

첫번째 이유로 긴 Query Method의 가독성 문제를 해결해 준다. (JPQL 사용)

• Query Method의 이름의 길이 굉장히 길어질때 사용하면 좋다. 엄청 긴 이름의 쿼리를 한번 만들어보고 Test 해보자.

    // 카테고리가 null이면서 이름은 지정한값으로,createdAt 보다 크거나 같고, updatedAt 보다 크거나 같은 쿼리
    List<Book> findByCategoryIsNullAndNameEqualsAndCreatedAtGreaterThanEqualAndUpdatedAtGreaterThanEqual(String name, LocalDateTime createdAt,LocalDateTime updatedAt);

    @Test
    void queryTest() {
        bookRepository.findAll().forEach(System.out::println);
  
        System.out.println("findByCategoryIsNullAndNameEqualsAndCreatedAtGreaterThanEqualAndUpdatedAtGreaterThanEqual : " +
                bookRepository.findByCategoryIsNullAndNameEqualsAndCreatedAtGreaterThanEqualAndUpdatedAtGreaterThanEqual(
                        "JPA 작은격차 클래스",
                        LocalDateTime.now().minusDays(1L),
                        LocalDateTime.now().minusDays(1L)
                ));

• data.sql에서 동작하는 쿼리는 리스너의 영향을 받지 않는다.

  insert into publisher(`id`,`name`,`created_At`,`updated_At`) value (1, '빠른대학',now(),now());
  insert into book(`id`,`name`,`publisher_id`, `deleted`, `created_At`,`updated_At`) values (2,'Spring Security 작은격차 클래스', 1,false,now(),now());
  insert into book(`id`,`name`,`publisher_id`, `deleted`, `created_At`,`updated_At`) values (3,'SpringBoot 하나인 클래스', 1,true,now(),now());
  insert into book(`id`,`name`,`publisher_id`, `deleted`, `created_At`,`updated_At`) values (1,'JPA 작은격차 클래스', 1,false,now(),now());

• 위와같이 쿼리문에 일일이 추가해줘도 되지만 JPA를 이용해보자.

  @EntityListeners(value = AuditingEntityListener.class)
  public class BaseEntity implements Auditable {
    @CreatedDate
    @Column(columnDefinition = "datetime(6) default now(6) comment '생성시간'", nullable = false, updatable = false)
    private LocalDateTime createdAt;
  
    @LastModifiedDate
    @Column(columnDefinition = "datetime(6) default now(6) comment '수정시간'", nullable = false)
    private LocalDateTime updatedAt;
  }

• columnDefinition을 이용해서 Auto DDL을 생성하는건 현업에서 잘 쓰이지는 않지만 알아두자.

• 위와같이 columnDefinition을 주면 DDL 생성을 할때 아래와 같이 생성된다.

    create table author (
       id bigint not null auto_increment,
        created_at datetime(6) default now(6) comment '생성시간' not null,
        updated_at datetime(6) default now(6) comment '수정시간' not null,

• 엔티티를 위와같이 고치고 Test하면 잘 나올 것이다.

• 자, 길고 긴 method 어떻게 고치냐? 바로 @Query를 이용하자.

    @Query(value = "select b from Book b where name = ?1 and createdAt >= ?2 and updatedAt >= ?3 and category is null")
    List<Book> findByNameRecently(String name, LocalDateTime createdAt,LocalDateTime updatedAt);

    @Test
    void queryTest() {
        System.out.println("findByNameRecently : " +
                bookRepository.findByNameRecently(
                        "JPA 작은격차 클래스",
                        LocalDateTime.now().minusDays(1L),
                        LocalDateTime.now().minusDays(1L)));

• 위에서 사용된 쿼리가 JPQL을 사용하게 된다.

• JPQL의 장점은 다이얼렉트(방언)기능때문에 DB에 맞게 Query를 생성해준다. 그래서 네이티브 쿼리와 차이가 있다. 또한 클래스위에 사용한 @Where 도 적용된다. ?1,?2,?3은 각각의 파라미터를 뜻한다. 하지만 자바에서는 순서에 의존하는 파라미터의 사용은 지양한다. 따라서 @Param을 사용한다.

    @Query(value = "select b from Book b where name = :name and createdAt >= :createdAt and updatedAt >= :updatedAt and category is null")
    List<Book> findByNameRecently(
            @Param("name") String name,
            @Param("createdAt") LocalDateTime createdAt,
            @Param("updatedAt") LocalDateTime updatedAt);

두번째 이유로 Entity에 연결되지않는 쿼리가 가능하다.

• 실제 현업에서 사용하는 Entity에 컬럼은 정말 많다. 그럴때 필요한 컬럼만 추려서 조회할수 있다.
• 실습을 해보자. 먼저 dto패키지를 만들고 BookNameAndCategory 클래스를 만들어주자.

  @Data
  @AllArgsConstructor
  @NoArgsConstructor
  public class BookNameAndCategory {
    private String name;
    private String category;
  }

• 이렇게 하면 구체클래스를 사용하여 Query를 받아올수 있다.

    @Query(value = "select new com.practice.jpa.bookmanager.repository.dto.BookNameAndCategory(b.name, b.category) from Book b")
    List<BookNameAndCategory> findBookNameAndCategory();

• 이렇게 DTO 구체클래스를 이용하여 원하는 컬럼만 사용하여 @Query를 사용할수 있게 되었다.

@Query를 이용한 Paging

    @Query(value = "select new com.practice.jpa.bookmanager.repository.dto.BookNameAndCategory(b.name, b.category) from Book b")
    Page<BookNameAndCategory> findBookNameAndCategory(Pageable pageable);

test

        bookRepository.findBookNameAndCategory(PageRequest.of(1, 1)).forEach(
                bookNameAndCategory -> System.out.println(bookNameAndCategory.getName() + " : " + bookNameAndCategory.getCategory()));

        bookRepository.findBookNameAndCategory(PageRequest.of(0, 1)).forEach(
                bookNameAndCategory -> System.out.println(bookNameAndCategory.getName() + " : " + bookNameAndCategory.getCategory()));