[스프링 DB 2편] #6. 스프링 데이터 JPA

[YONGHYNG]

스프링 JPA

• JpaRepository 인터페이스 통해 기본적인 CRUD 기능 제공
• 공통화 가능한 기능이 모두 포함
• CrudRepository에서 findOne() -> findById() 로 변경

사용법

public interfacce ItemRepository extends JpaRepository<Item, Long>{}

• JpaRepository 인터페이스 상속 받고, 제네릭에 관리할 <엔티티, 엔티티ID> 주면 됨
• JpaRepository가 제공하는 CRUD 기능 모두 사용 가능

스프링 데이터가 JPA가 구현 클래스 대신 생성

• JpaRepository 인터페이스만 상속받으면 스프링 데이터 JPA가 프록시 기술을 사용, 구현 클래스를 만들어 줌
• 만든 구현 클래스의 인스턴스를 만들어서 스프링 빈으로 등록
• 즉, 개발자는 구현 클래스 없이 인터페이스만 만들면 기본 CRUD 기능 사용 가능

쿼리 메서드 기능

• 스프링 데이터 JPA는 인터페이스에 메서드만 적어두면, 메서드 이름을 분석해 쿼리를 자동으로 만들고 실행해주는 기능 제공

순수 JPA 리포지토리

public List<Member> findByUsernameAndAgeGreaterThan(String username, int age){
                  return em.createQuery("select m from Member m where m.username = :username and m.age > :age")
                  .setParameter("username", username)
                  .setParameter("age", age)
}

스프링 데이터 JPA

public interface MemberRepository extends JpaRepository<Member, Long> {
         List<Member> findByUsernameAndAgeGreaterThan(String username, int age);
}

• 스프링 데이터 JPA는 메서드 이름을 분석, 필요한 JPQL 만들고 실행해줌, JPQL은 JPA가 SQL로 번역해서 실행

규칙

• 조회 : find..By, read...By, query...By, get...By, 식별하기 위한 내용(설명)이 들어가도 됨
• COUNT : count..By 반환타입 long
• EXISTS : exists...By 반환타입 boolean
• 삭제 : delete...By, remove...By 반환타입 long
• DISTINCT : findDistinct, findMemberDistinctBy
• LIMIT : findFirst3 ,findFirst, findTop, findTop3

JPQL 직접 사용하기

public interface SpringDataJpaItemRepository extends JpaRepository<Item, Long> {
       
           //쿼리 메서드 기능
           List<Item> findByItemNameLike(String itemName);

          //쿼리 직접 실행
         @Query("select i from Item i where i.itemName like :itemName and i.price <= :price")
         List<Item> findItems(@Parma("itemName") String itemName, @Param("price") Integer price);
}

• 쿼리 메서드 기능 대신에 직접 JPQL을 사용하고 싶을 때 @query와 함께 JPQL 작성하면 됨, 이때는 메서드 이름 실행 규칙 무시 됨
• 참고 : 스프링 데이터 JPA는 JPQL 뿐 아니라 JPA 네이티브 쿼리 기능도 지원, JPQL 대신에 SQL 직접 작성 가능

스프링 데이터 JPA 적용

package hello.itemservice.repository.jpa;
import hello.itemservice.domain.Item;
import org.apache.ibatis.annotations.Param;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;

import java.util.List;

public interface SpringDataJpaItemRepository extends JpaRepository<Item, Long> {

    List<Item> findByItemNameLike(String itemName);

    List<Item> findByPriceLessThanEqual(Integer price);

    //쿼리 메서드(아래 메서드와 같은 기능 수행)
    List<Item> findItemNameLikeAndPriceLessThanEqual(String itemName, Integer price);

    //쿼리 직접 실행
    @Query("select i from Item i where i.itemName like :itemName and i.price <= :price")
    List<Item> findItems(@Param("itemName") String itemName, @Param("price") Integer price);
}

• 스프링 데이터 JPA가 제공하는 JpaRepository 인터페이스를 인터페이스 상속 받으면 기본적인 CRUD 기능 사용
• 그런데 이름으로 검색하거나, 가격으로 검색하는 기능은 공통으로 제공할 수 있는 기능 아님
• 따라서 쿼리 메서드 기능 사용하거나 직접 @query 사용해서 직접 쿼리 실행
• JPA는 동적 쿼리에 약함

findAll()

• JpaRepository 공통 인터페이스 제공하는 기능
• 모든 Item 조회
• select i from Item i 쿼리 실행

findByItemNameLike()

• 이름 조건만 검색했을 때 사용하는 쿼리 메서드
• select i from Item i where i.name like ?

findByPriceLessThanEqual()

• 가격 조건만 검색했을 때 사용하는 쿼리 메서드
• select i from Item i where i.price <= ?

findByItemNameLikeandPriceLessThanEqual()

• 이름과 가격 조건을 검색했을 때 사용하는 쿼리 메서드
• select i from Item i where i.itemName like ? and i.price <= ?

findItems()

• 메서드 일므으로 쿼리를 실행하는 기능은 간단하면 매우 유용함, 복잡하면 JPQL 쿼리를 작성하는게 좋음
• 쿼리를 직접 실행하려면 @query 애노테이션 사용하면 됨
• 메서드 이름으로 쿼리를 실행할 때는 파라미터를 순서대로 입력하면 되지만, 쿼리를 실행할 때는 파라미터를 명시적으로 바인딩 해야함
• 파라미터 바인딩은 @Param("itemName") 애노테이션 사용, 애노테이션의 값에 파라미터 이름 주면 됨
• 메서드 이름으로 쿼리를 실행하는 기능은 다음과 같은 단점 있음
• 조건이 많아짐 메서드 이름이 길어짐, 조인 같은 복잡한 조건을 사용할 수 없음

스프링 데이터 JPA 적용2

package hello.itemservice.repository.jpa;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Repository;
import org.springframework.util.StringUtils;

import javax.transaction.Transactional;
import java.util.List;
import java.util.Optional;

@Repository
@Transactional //DB 작업 안전하게 처리해주는 도구 전부 취소 or 전부 저장
@RequiredArgsConstructor //Lombok을 사용 final이 붙은 필드를 자동으로 초기화하는 생성자 생성, 여기서 SpringDataJpaItemRepository 생성자 주입
public class JpaItemRepositoryV2 implements ItemRepository {

    /**
     * SpringDataJapItemRepository
     * Spring Data JPA에서 제공하는 리포지토리 인터페이스를 확장한 커스텀 인터페이스
     * 이 레포지토리는 Item 엔티티에 대해 JPA 기반 CRUD 추가 쿼리 실행함
     * */
    private final SpringDataJpaItemRepository repository;

    @Override
    public Item save(Item item) { //상품 저장
        return repository.save(item);
    }

    @Override
    /**
     * ItemUpdateDto - 상품 업데이트 정보 담는 DTO
     * 필드 : itemName, price, quantity
     * */
    public void update(Long itemId, ItemUpdateDto updateParam) { //상품 수정
        Item findItem = repository.findById(itemId).orElseThrow();
        findItem.setItemName(updateParam.getItemName());
        findItem.setPrice(updateParam.getPrice());
        findItem.setQuantity(updateParam.getQuantity());
    }

    @Override
    public Optional<Item> findById(Long id) {
        return repository.findById(id);
    }

    @Override
    /**
     * ItemSearchCond - 검색 조건 담는 DTO(Data Transfer Object)
     * 필드 : itemName(상품명), maxPrice(최대 가격)
     * */
    public List<Item> findAll(ItemSearchCond cond) { //모든 데이터 조회, 이름 조회, 가격 조회, 이름 + 가격 조회

        String itemName = cond.getItemName();
        Integer maxPrice = cond.getMaxPrice();

        if (StringUtils.hasText(itemName) && maxPrice != null) {
            return repository.findItems("%" + itemName + "%", maxPrice);
        } else if (StringUtils.hasText(itemName)) {
            return repository.findByItemNameLike("%" + itemName + "%");
        } else if (maxPrice != null) {
            return repository.findByPriceLessThanEqual(maxPrice);
        } else {
            return repository.findAll();
        }
    }
}

의존관계와 구조

• ItemService는 ItemRepository에 의존하기 때문, ItemService에서 SpringDataJpaItemRepository 그대로 사용할 수 없음
• 물론 ItemService가 SpringDataJpaItemRepository를 직접 사용하도록 코드를 고치면 됨, 우리는 ItemService 코드의 변경없이 ItemService가 ItemRepository에 대한 의존을 유지하면서 DI를 통해 구현 기술을 변경하고 싶음

클래스 의존 관계

• JpaItemRepositoryV2는 ItemRepository 구현, SpringDataJpaItemRepository 사용

런타임 객체 의존 관계

• 중간에서 JpaItemRepostiory가 어댑터 역할을 해준 덕분에 ItemService가 사용하는 ItemRepository 인터페이스를 그대로 유지할 수 있고 클라이언트인 ItemService의 코드를 변경하지 않아도 됨

기능 설명

save()

• repository.save(item)
• 스프링 데이터 JPA가 제공하는 save() 호출

update()

• 스프링 데이터 JPA가 제공하는 findById() 메서드 사용해 엔티티 찾음, 그리고 데이터 수정
• 트랜잭션이 커밋될 때 변경 내용이 데이터베이스에 반영

findById()

• repository.findById(itemId)
• 스프링 데이터 JPA가 제공하는 findById() 메서드 사용 엔티티 찾음

findAll()

• 모든 데이터 조회, 이름 조회, 가격 조회, 이름 + 가격 조회
• 조건에 부합할 때 findByItemNameLikeAndPriceLessThanEqual() 사용하고, repository.findItems() 사용해도 됨

[YuDeokRin]

오.. 정리 잘하신거같아요... 읽어보는데 쑥쑥 읽힙니다.