[Spring Data JPA] - 쿼리 메소드 기능

 

 

 

 

 

 

쿼리 메소드

스프링 데이터 JPA가 제공하는 쿼리 메소드 기능은 대표적으로 다음과 같습니다.

• 메소드의 이름으로 쿼리 생성
• @Query를 사용해서 리파지토리 인터페이스에 쿼리를 직접 정의

 

 

 

 

 

 

 

 

 

 

 

 

메소드 이름으로 쿼리 생성

Optional<Member> findByUsername(String username);

 

위의 예시처럼 메서드의 이름만 설정함으로써 쿼리를 자동으로 생성할 수 있습니다.

 

중요한 것은 해당 필드가 엔티티에 존재해야 하며, 필드명과 메서드 이름이 반드시 일치해야 한다는 것입니다.

 

그렇지 않는다면 애플리케이션 로딩 시점에 예외가 발생합니다.

 

 

 

 

 

 

 

 

 

 

 

 

술어

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#appendix.query.method.subject

Spring Data JPA - Reference Documentation

위 사이트에서 find, exist 등의 사용 가능한 subject keyword를 확인할 수 있습니다.

 

 

 

 

 

 

 

 

 

 

필터링 조건

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation

Spring Data JPA - Reference Documentation

위 사이트에서 가능한 필터 조건들과 사용법을 알 수 있습니다.

 

 

추가로 해당 기능으로 쿼리를 생성하는 경우 파라미터에 @Param을 사용하지 않아도 됩니다.

 

 

 

 

 

 

 

 

 

결과 개수 제한

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#repositories.limit-query-result

Spring Data JPA - Reference Documentation

User findFirstByOrderByLastnameAsc();

User findTopByOrderByAgeDesc();

Page<User> queryFirst10ByLastname(String lastname, Pageable pageable);

Slice<User> findTop3ByLastname(String lastname, Pageable pageable);

List<User> findFirst10ByLastname(String lastname, Sort sort);

List<User> findTop10ByLastname(String lastname, Pageable pageable);

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

@Query

인터페이스 메서드가 실행할 JPQL을 작성할 수 있도록 하는 어노테이션입니다.

 

 

다음와 같이 사용합니다.

public interface MemberRepository extends JpaRepository<Member, Long> {

    @Query("select  m from  Member  m where m.username =: username and m.age = :age")
    List<Member> findUser(@Param("username") String username, @Param("age") int age);
}

 

위와 같이 메소드 위에 실행할 쿼리를 바로 작성할 수 있습니다.

 

메소드 이름으로 쿼리는 생성하는 방법은 파라미터가 늘어날수록 이름이 길어진다는 단점이 있습니다.

그러나 해당 기능을 사용하면 메소드 이름을 간략하게 설정할 수 있습니다.

 

@Query를 사용하는 경우 @Param을 통해 파라미터 바인딩을 진행해 주어야 합니다.

 

 

 

 

 

 

 

특정 값 조회하기

public interface MemberRepository extends JpaRepository<Member,Long> {

    @Query("select m.username from  Member  m")
    List<Member> findUsernames();
}

 

 

 

 

 

DTO 바로 조회하기

public interface MemberRepository extends JpaRepository<Member,Long> {

    @Query("select new study.datajpa.dto.MemberDto(m.id, m.username, m.age) from  Member  m")
    List<Member> findUserDtos();
}

 

 

 

 

IN절 사용하기

public interface MemberRepository extends JpaRepository<Member,Long> {

    @Query("select m from  Member m where m.username in :names")
    List<Member> findUsernames(@Param("names") List<String> names );
}

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Reference

실전! 스프링 데이터 JPA - 인프런 | 강의