Spring Data JPA

Spring Data JPA는 Spring 프레임워크에서 JPA를 편리하게 사용할 수 있도록 지원하는 모듈이다.

• CRUD를 처리하기 위한 공통 인터페이스를 제공한다.
• Repository를 개발할 때 인터페이스만 작성하면 실행 시점에 Spring Data JPA가 구현 객체를 동적으로 생성해서 주입해준다.

-> 데이터 접근 계층을 개발할 때 구현 클래스 없이 인터페이스만 작성해도 개발을 완료할 수 있다.

📙Spring Data JPA 라이브러리 설정 및 환경설정

• 라이브러리 설정

  <dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-jpa></artifactId>
    <version>1.8.0.RELEASE</version>
  </dependency>

• XML 설정

  <beans>
    ...
    <jpa:repositories base-package="..."/>
  </beans>

• JavaConfig 설정

  @Configuration
  @EnableJpaRepositories(basePackages ="...")
  public class AppConfig{
  }

✏️공통 인터페이스 기능

Spring Data JPA는 간단한 CRUD 기능을 공통으로 처리하는 JpaRepository 인터페이스를 제공한다.
이 인터페이스를 상속 받고, 제네릭에 엔티티 클래스와 엔티티 클래스가 사용하는 식별자 타입을 지정하면 된다.

JpaRepository 인터페이스를 상속받으면 사용할 수 있는 주요 메소드를 알아보자.

• save(S) : 새로운 엔티티는 저장하고 이미 있는 엔티티는 수정한다.
  • 엔티티에 식별자 값이 없으면 새로운 엔티티로 반단해서 EntityManager.persist()를 호출한다.
  • 식별자 값이 있으면 이미 있는 엔티티로 판단해서 EntityManager.merge()를 호출한다.
• delete(T) : 엔티티 하나를 삭제한다.
  • 내부에서 EntityManager.remove()를 호출한다.
• findOne(ID) : 엔티티 하나를 조회한다.
  • 내부에서 EntityManager.find()를 호출한다.
• getOne(ID) : 엔티티를 프록시로 조회한다.
  • 내부에서 EntityManager.getReference()를 호출한다.
• findAll(..) : 모든 엔티티를 조회한다.
  • 정렬이나 페이징 조건을 파라미터로 제공할 수 있다.

📙쿼리 메소드 기능

Spring Data JPA가 제공하는 쿼리 메소드 기능은 크게 3가지가 있다.
1. 메소드 이름으로 쿼리 생성
2. 메소드 이름으로 JPA NamedQuery 호출
3. @Query 어노테이션을 사용해서 Repository 인터페이스에 쿼리 직접 정의

✏️메소드 이름으로 쿼리 생성

• 인터페이스에 정의한 메소드를 실행하면 Spring Data JPA는 메소드 이름을 분석해서 JPQL을 생성하고 실행한다.
  -> 정해진 규칙에 따라서 메소드 이름을 지어야 한다.

• 규칙

  Keyword	Sample	JPQL snippet
  And	findByLastnameAndFirstname	… where x.lastname = ?1 and x.firstname = ?2
  Or	findByLastnameOrFirstname	… where x.lastname = ?1 or x.firstname = ?2
  Is,Equals	findByFirstname,findByFirstnameIs,findByFirstnameEquals	… where x.firstname = 1?
  Between	findByStartDateBetween	… where x.startDate between 1? and ?2
  LessThan	findByAgeLessThan	… where x.age < ?1
  LessThanEqual	findByAgeLessThanEqual	… where x.age ⇐ ?1
  GreaterThan	findByAgeGreaterThan	… where x.age > ?1
  GreaterThanEqual	findByAgeGreaterThanEqual	… where x.age >= ?1
  After	findByStartDateAfter	… where x.startDate > ?1
  Before	findByStartDateBefore	… where x.startDate < ?1
  IsNull	findByAgeIsNull	… where x.age is null
  IsNotNull,NotNull	findByAge(Is)NotNull	… where x.age not null
  Like	findByFirstnameLike	… where x.firstname like ?1
  NotLike	findByFirstnameNotLike	… where x.firstname not like ?1
  StartingWith	findByFirstnameStartingWith	… where x.firstname like ?1 (parameter bound with appended %)
  EndingWith	findByFirstnameEndingWith	… where x.firstname like ?1 (parameter bound with prepended %)
  Containing	findByFirstnameContaining	… where x.firstname like ?1 (parameter bound wrapped in %)
  OrderBy	findByAgeOrderByLastnameDesc	… where x.age = ?1 order by x.lastname desc
  Not	findByLastnameNot	… where x.lastname <> ?1
  In	findByAgeIn(Collection< Age > ages)	… where x.age in ?1
  NotIn	findByAgeNotIn(Collection< Age > age)	… where x.age not in ?1
  True	findByActiveTrue()	… where x.active = true
  False	findByActiveFalse()	… where x.active = false
  IgnoreCase	findByFirstnameIgnoreCase	… where UPPER(x.firstame) = UPPER(?1)

✏️메소드 이름으로 JPA NamedQuery 호출

• 쿼리에 이름을 부여해서 사용하는 방법이다.
• 선언한 "도메인 클래스 + .(dot) + 메소드 이름"으로 Named 쿼리를 찾아서 실행한다.

✏️@Query 어노테이션을 사용해서 Repository 인터페이스에 쿼리 직접 정의

• 실행할 메소드에 정적 쿼리를 직접 작성하므로 이름 없는 Named 쿼리라 할 수 있다.
• JPA Named 쿼리처럼 애플리케이션 실행 시점에 문법 요류를 발견할 수 있다.

public interface MemberRepository extends JpaRepository<Member, Long> {
   @Query("select m from Member m where m.username = ?1")
   Member findByUsername(String username);
}

✏️ 파라미터 바인딩

• 위치 기반 파라미터 바인딩과 이름 기반 파라미터 바인딩을 모두 지원한다.
• 기본값은 위치 기반인데 파라미터 순서로 바인딩한다.
• 이름 기반 파라미터 바인딩을 사용하려면 org.springframework.data.repository.query.Param(파라미터 이름) 어노테이션을 사용하면 된다.

✏️ 벌크성 수정 쿼리

• 벌크성 수정, 삭제 쿼리는 org.springframework.data.jpa.repository.Modifying 어노테이션을 사용하면 된다.
• 벌크성 쿼리를 실행하고 나서 영속성 컨텍스트를 초기화하고 싶으면 @Modifying(clearAutoMatically = true)처럼 clearAutomatically 옵션을 true로 설정하면 된다. (기본값 = false)

✏️반환 타입

Spring Data JPS는 유연한 반환 타입을 지원한다.

• 결과가 한 건 이상이면 컬렉션 인터페이스를 사용한다.

  List<Member> findByName(String name);

• 결과가 단건이면 반환 타입을 지정한다.

  Member findByEmail(String email);

✏️페이징과 정렬

1. 정렬 기능
   • org.springframework.data.domain.Sort
2. 페이징 기능
   • org.springframework.data.domain.Pageable (내부에 Sort 포함)
   • 반환 타입으로 List나 org.springframework.data.domain.Page를 사용할 수 있다.
     • 반환 타입으로 Page를 사용하면 Spring Data JPA는 페이징 기능을 제공하기 위해 검색된 전체 데이터 건수를 조회하는 count 쿼리를 추가로 호출한다.

✏️JPA 쿼리 힌트

• org.springframework.data.jpa.repository.QueryHints 어노테이션을 사용
• JPA 구현체에게 제공하는 힌트이다.
• forCounting 속성 : 반환 타입으로 Page 인터페이스를 적용하면 추가로 호출하는 페이징을 위한 count 쿼리에도 쿼리 힌트를 적용할지를 설정하는 옵션(기본값 = true)

✏️Lock

• org.springframework.data.jpa.repository.Lock 어노테이션을 사용

📙명세

• org.springframework.data.jpa.domain.Specification
• Specification
  • composite 패컨으로 구성되어 있어서 여러 Specification을 조합할 수 있다.
    -> 다양한 검색 조건을 조립해서 새로운 검색조건을 쉽게 만들 수 있다.
• Specifications
  • 명세들을 조립할 수 있도록 도와주는 클래스
  • where(), and(), or(), not() 메소드를 제공

📙사용자 정의 repository 구현

1. 사용자 정의 인터페이스를 작성
2. 사용자 정의 인터페이스를 구현할 클래스를 작성
   • 클래스 이름
     • repository 인터페이스 이름 + Impl (default)
       -> Spring Data JPA가 사용자 정의 구현 클래스로 인식
     • Impl 대신 다른 이름을 붙이고 싶은 경우
       • repository-impl-postfix 속성을 변경

📙Web 확장 기능

Spring MVC에서 사용할 수 있는 편리한 기능을 제공한다.

✏️설정

• Web 확장 기능을 활성화하려면 org.springframework.data.web.config.SpringDataWebConfiguration을 스프링 빈으로 등록하면 된다.
• JavaConfig를 사용하면, org.springframework.data.web.config.EnableSpringDataWebSupport 어노테이션을 사용하면 된다.

✏️도메인 클래스 컨버터 기능

• 도메인 클래스 컨버터는 HTTP 파라미터로 넘어온 엔티티의 아이디로 엔티티 객체를 찾아서 바인딩해준다.
• 도메인 클래스 컨버터는 해당 엔티티와 관련된 repository를 사용해서 엔티티를 찾는다.

✏️페이징과 정렬 기능

1. 페이징 기능
   • PageableHandlerMethodArgumentResolver
   • 요청 파라미터
     • page : 현재 페이지, 0부터 시작
     • size : 한 페이지에 노출할 데이터 건수
     • sort : 정렬 조건을 정의 (ASC | DESC)
   • 사용해야 할 페이징 정보가 둘 이상이면 접두사를 사용해서 구분할 수 있다.
     • @Qualifier 어노테이션을 사용하면 된다.
     • " {접두사명}_"로 구분한다.
   • Pageable의 기본값은 page=0, size=20이다.
     • @PageableDefault 어노테이션을 사용하면 기본값을 변경할 수 있다.
2. 정렬 기능
   • SortHandlerMethodArgumentResolver

📙Spring Data JPA가 사용하는 구현체

• @Repository 적용: JPA 예외를 Spring이 추상화한 예외로 변환한다.
• @Transactional 트랜잭션 사용
  • JPA의 모든 변경은 트랜잭션 안에서 이루어져야 한다.
  • Spring Data JPA가 제공하는 공통 인터페이스를 사용하면 데이터를 변경하는 메소드에 @Transactional로 트랜잭션 처리가 되어 있다.
  • 서비스 계층에서 트랜잭션을 시작하지 않으면 repository에서 트랜잭션을 시작한다.
  • 서비스 계층에서 트랜잭션을 시작했으면 repository도 해당 트랜잭션을 전파받아서 그대로 사용한다.
• @Transactional(readOnly = true)
  • 데이터를 조회하는 메소드에는 readOnly = true 옵션이 적용되어 있다.
  • 데이터를 변경하지 않는 트랜잭션에서 readOnly = true 옵션을 사용하면 플러시를 생략해서 약간의 성능 향상을 얻을 수 있다.
• save() 메소드
  • 저장할 엔티티가 새로운 엔티티면 저장(persist)하고 이미 있는 엔티티면 병합(merge)한다.

📙JPA vs Spring Data JPA

항목	JPA	Spring Data JPA
역할	ORM 표준 인터페이스 제공.	JPA를 추상화하여 더 편리한 데이터 접근 및 관리 기능 제공.
설정	JPA 구현체(Hibernate 등)를 직접 설정해야 함.	Spring Boot와 함께 사용 시, 설정이 간단하고 자동화됨.
사용 방식	EntityManager를 직접 사용.	JpaRepository 등의 리포지토리를 통해 데이터 액세스.
커스텀 쿼리	JPQL 또는 Native Query 작성 필요.	메서드 이름 기반 쿼리 생성, @Query로 간편하게 커스텀 쿼리 작성 가능.
학습 곡선	상대적으로 높음.	초보자도 쉽게 사용할 수 있음.
생산성	기본적인 데이터 처리 코드 작성에 시간 소요.	기본적인 CRUD 기능 자동 제공으로 개발 생산성 향상.