12.1 스프링 데이터 JPA 소개

스프링 데이터 JPA 는 스프링 프레임워크에서 JPA 를 편리하게 사용할 수 있도록 지원하는 프로젝트
하는 일이 비슷한, 지루하게 반복되는 CRUD 를 처리하기 위한 공통 인터페이스를 제공
인터페이스만 작성하면 실행 시점에 스프링 데이터 JPA 가 구현 객체를 동적으로 생성해서 주입
따라서 데이터 접근 계층(DAO)을 개발할 때 구현 클래스 없이 인터페이스 작성만으로 개발 완료할 수 있다

12.1.1 스프링 데이터 프로젝트

12.2 스프링 데이터 JPA 설정

필요 라이브러리

// https://mvnrepository.com/artifact/org.springframework.data/spring-data-jpa
implementation 'org.springframework.data:spring-data-jpa:3.0.0'

// https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-data-jpa
implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.0.0'

"Starter for using Spring Data JPA with Hibernate".

환경설정

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

@EnableJpaRepositories 의 basePackages 값으로 리포지토리를 검색할 패키지 위치를 명시
Spring boot 를 사용하게 되면 @EnableAutoConfiguration 에 의해 자동으로 설정된다
스프링 데이터 JPA 는 애플리케이션 실행시 basePackage 에 있는 리포지토리 인터페이스 들을 찾고,
해당 인터페이스를 구현한 클래스를 동적으로 생성한다음 스프링 빈으로 등록한다

12.3 공통 인터페이스 기능

public interface JpaRepository<T, ID extends Serializable> 
                                                                    extends PagingAndSortingRepository<T, ID> {
    ...
}

public interface MemberRepository extends JpaRepository<Member, Long> {
    Member findByUsername(String username);
}

스프링 데이터 JPA 는 간단한 CRUD 기능을 공통으로 처리하는 JpaRepository 인터페이스를 제공

JpaRepository 인터페이스는 JPA 에 특화된 기능을 추가로 제공
- save(S): 새로운 엔티티(ID 값이 없을 때)는 저장, 기존 엔티티(ID 값이 있을 때)는 수정
- delete(T): 엔티티 하나를 삭제 (EntityManager.remove() 호출)
- findOne(ID): 엔티티 하나를 조회 (EntityManager.find() 호출)
- getOne(ID): 엔티티를 프록시로 조회 (EntityManager.getReference() 호출)
- findAll(…): 모든 엔티티 조회. 정렬이나 페이징 조건 추가 가능

12.4 쿼리 메소드 기능

12.4.1 메소드 이름으로 쿼리 생성

인터페이스에 메소드만 선언하면 해당 메소드 이름으로 JPQL 쿼리를 생성해서 실행하는 기능
https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#repository-query-keywords
엔티티의 필드명이 변경되면 인터페이스에 정의한 메소드 이름도 변경해야함

12.4.2 JPA NamedQuery

@Entity 
@NamedQuery(
    name=”Member.findByUsername”,
    query=”select m Member m where m.username = :username”) 
public class Member {
    ...
}

public interface MemberRepository extends JpaRepository<Member, Long> {
    List<Member> findByUsername(@Param("username") String username);
}

쿼리에 이름을 부여해서 사용하는 방법
{도메인 클래스}.{메소드 이름} 형식의 Named 쿼리를 스프링 데이터 JPA 가 찾아서 실행한다

12.4.3 @Query, 리포지토리 메소드에 쿼리 정의

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

    @Query(value = "SELECT * FROM MEMBER WHERE age = ?0", nativeQuery = true)
    Member findByAge(Integer age);
}

@Query 어노테이션을 사용하여 실행할 메소드에 정적 쿼리를 직접 작성
가독성과 유지보수를 위해 이름 기반 파라미터 바인딩을 사용하자

12.4.5 벌크성 수정 쿼리

@Modifying(clearAutomatically = true)
@Query("update Product p set p.price = p.price * 1.1 where p.stockAmount < :stockAmount")
int bulkPriceUp(@Param("stockAmount") String stockAmount);

@Modifying 어노테이션 사용하여 벌크성 수정, 삭제 쿼리 생성
clearAutomatically = true 설정으로 벌크성 쿼리를 실행하고 나서 영속성 컨텍스트를 초기화 가능

12.4.7 페이징과 정렬

public interface MemberRepository extends JpaRepository<Member, Long> {
    // Page 사용. count 쿼리 호출
    Page<Member> findByNameStartingWith(String name, Pageable pageable);

    // count 쿼리 호출 안함
    List<Member> findByNameEndingWith(String name, Pageable pageable);
}

PageRequest pageRequest = new PageRequest(0, 10, new Sort(Direction.DESC, "name"));
Page<Member> result = memberRepository.findByNameStartingWith("김", pageRequest);

List<Member> members = result.getContent(); // 조회된 데이터
int totalPages = result.getTotalPages(); // 전체 페이지 수
boolean hasNextPage = result.hasNextPage(); // 다음 페이지 존재 여부

Page 를 사용하면 스프링 데이터 JPA 는 검색된 전체 데이터 건수를 조회하는 count 쿼리를 추가로 호출함
Page 를 사용하는 클라이언트는 PageRequest 객체를 사용

12.5 명세(Specification)

JPA Criteria 가 사용된 개념인데, QueryDSL 사용으로 대체할 수 있어보여 생략함

12.6 사용자 정의 리포지토리 구현

public interface MemberRepositoryCustom {
    public List<Member> findMemberCustom();
}

public interface MemberRepositoryCustomImpl implements MemberRepositoryCustom {

    @Override
    public List<Member> findMemberCustom() {
        ...
    }
}

필요한 메소드를 직접 구현해야할 경우 사용
인터페이스 이름은 자유롭게 지으면 되지만, 구현체 클래스 이름은 {인터페이스 이름} + Impl 로 지어야함
(그래야 스프링 데이터 JPA 가 사용자 정의 구현 클래스로 인식함)

12.7 Web 확장

스프링 데이터 프로젝트가 제공하는 스프링 MVC 에서 편리하게 사용할 수 있는 기능
- 도메인 클래스 컨버터
- 페이징 & 정렬

12.7.1 설정

@Configuration
@EnableWebMvc
@EnableSpringDataWebSupport
public class WebAppConfig {
    ...
}

Web 확장 기능을 활성화하기 위해선 @EnableSpringDataWebSupport 를 사용하여 SpringDataWebConfiguration 을 스프링 빈으로 등록하면 된다
설정시 도메인 클래스 컨버터와 페이징&정렬 을 위한 HandlerMethodArgumentResolver 가 스프링 빈으로 등록된다

12.7.2 도메인 클래스 컨버터 기능

HTTP 파라미터로 넘어온 엔티티의 아이디로 엔티티 객체를 찾아서 바인딩해주는 역할

@Controller
public class MemberController {

    @RequsetMapping("member/memberUpdateForm")
    public String memberUpdateForm(@RequestParam("id") Member member, Model model) {
        ...
    }
}

@RequestParam("id") Member member : HTTP 요청으로 id 를 받지만 도메인 클래스 컨버터가 Member 객체로 변환하여 전달
도메인 클래스 컨버터는 해당 엔티티 관련 리포지토리를 사용해서 조회한 결과를 전달한다
도메인 클래스 컨버터를 통해 넘어온 엔티티를 컨트롤러에서 직접 수정해도 DB 에는 반영되지 않는다
- OSIV 관련 내용(13장)

12.7.3 페이징과 정렬 기능

HandlerMethodArgumentResolver 사용
- 페이징 : PageableHandlerMethodArgumentResolver
- 정렬 : SortHandlerMethodArgumentResolver

GET {...}/members?page0&size=20&sort=name,desc&sort=address.city

@RequestMapping(value = "/members", method = RequestMethod.GET)
public String list(@PageableDefault(size = 12, sort = "name") Pageable pageable, ...) {
    Page<Member> page = memberService.findMembers(pageable);
    ...
}

Pageable 은 page=0, size=20 이 디폴트 셋팅
@PageableDefault(size = 12, sort = "name") 를 Pageable 앞에 사용하여 기본값을 변경할 수 있다
별 다른 값을 주지 않고 @PageableDefault 만 사용한다면 page=0, size=10

GET {...}/members?members_page=0&order_page=1

public String list(
    @Qualifier("member") Pageable memberPageable,
    @Qualifier("order") Pageable orderPageable, ...
){...}

사용해야할 페이징 정보가 둘 이상이면 @Qualifier 어노테이션으로 접두사를 사용해 구분

12.8 스프링 데이터 JPA 가 사용하는 구현체

스프링 데이터 JPA 가 제공하는 공통 인터페이스는 SimpleJpaRepository 가 구현한다.

@Repository
@Transactional(readOnly = true)
public class SimpleJpaRepository<T, ID> implements JpaRepositoryImplementation<T, ID> {
    @Transactional
    @Override
    public <S extends T> S save(S entity) {
        ...
    }
}

@Repository : JPA 예외를 스프링이 추상화한 예외로 변환
@Transactional : JPA 의 모든 변경(등록, 수정, 삭제)은 트랜잭션 안에서 이루어져야 하는데, 변경을 수행하는 메소드에 트랜잭션 처리를 위해 사용. 전파되므로 서비스 계층에서 사용시 리포지토리까지 적용됨.
@Transactional(readOnly = true) : 조회는 데이터 변경이 발생x. readOnly = true 옵션으로 플러시를 생략해서 약간의 성능 향상

12.10 스프링 데이터 JPA 와 QueryDSL 통합

스프링 데이터 JPA 는 아래 2가지 방법으로 QueryDSL 을 지원
- QueryDslPredicateExecutor
- QueryDslRepositorySupport
QueryDslRepositorySupport 가 실무 레벨에 적합

12.10.1 QueryDslPredicateExecutor

public interface ItemRepository 
    extends JpaRepository<Item, Long>, QueryDslPredicateExecutor<Item> {
}

QueryDslPredicateExecutor 는 기능에 한계가 있음(join, fetch 등 사용 불가)

12.10.2 QueryDslRepositorySupport

public interface CustomOrderRepository {
    public List<Order> search(OrderSearch orderSearch);
}

public class OrderRespositoryImpl extends QueryDslRepositorySupport
implements CustomOrderRepository {

    public OrderRepositoryImpl() {
        super(Order.class);
    }

    @Override
    public List<Order> search(OrderSearch orderSearch) {
        QOrder order = QOrder.order;
        QMember member = QMember.member;

        JPQLQuery query = from(order);

        if (StringUtils.hasText(orderSearch.getMemberName())) {
            query.leftJoin(order.member, member)
                .where(member.name.contains(orderSearch.getMemberName()));
        }

        if (orderSearch.getOrderStatus() != null) {
            query.where(order.status.eq(orderSearch.getOrderStatus()));
        }

        return query.list(order);
    }
}

tonykang22 / study

[JPA] 12장. 스프링 데이터 JPA #155

12.1 스프링 데이터 JPA 소개

12.1.1 스프링 데이터 프로젝트

12.2 스프링 데이터 JPA 설정

필요 라이브러리

환경설정

12.3 공통 인터페이스 기능

12.4 쿼리 메소드 기능

12.4.1 메소드 이름으로 쿼리 생성

12.4.2 JPA NamedQuery

12.4.3 @Query, 리포지토리 메소드에 쿼리 정의

12.4.5 벌크성 수정 쿼리

12.4.7 페이징과 정렬

12.5 명세(Specification)

12.6 사용자 정의 리포지토리 구현

12.7 Web 확장

12.7.1 설정

12.7.2 도메인 클래스 컨버터 기능

12.7.3 페이징과 정렬 기능

12.8 스프링 데이터 JPA 가 사용하는 구현체

12.10 스프링 데이터 JPA 와 QueryDSL 통합

12.10.1 QueryDslPredicateExecutor

12.10.2 QueryDslRepositorySupport