[Spring DB] 데이터 접근 기술 - 스프링 데이터 JPA

목차

• 스프링 데이터 JPA 주요 기능
• 스프링 데이터 JPA 적용1
• 스프링 데이터 JPA 적용2

 

스프링 데이터 JPA 주요 기능

1. 공통 인터페이스 기능
2. 쿼리 메서드 기능

 

1️⃣ 공통 인터페이스 기능

• JpaRepository 인터페이스를 통해서 기본적인 CRUD 기능 제공한다.
• 공통화 가능한 기능이 거의 모두 포함되어 있다.
• CrudRepository 에서 fineOne() ➔ findById() 로 변경되었다.

 

JpaRepository 사용법

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

• JpaRepository 인터페이스를 인터페이스 상속 받고, 제네릭에 관리할 <엔티티, 엔티티ID> 를 주면 된다.
• 그러면 JpaRepository 가 제공하는 기본 CRUD 기능을 모두 사용할 수 있다.

 

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

• JpaRepository 인터페이스만 상속받으면 스프링 데이터 JPA가 프록시 기술을 사용해서 구현 클래스를 만들어준다. 
• 그리고 만든 구현 클래스의 인스턴스를 만들어서 스프링 빈으로 등록한다.
• 따라서 개발자는 구현 클래스 없이 인터페이스만 만들면 기본 CRUD 기능을 사용할 수 있다.

 

 

2️⃣ 쿼리 메서드 기능

스프링 데이터 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) .getResultList();
}

• 순수 JPA를 사용하면 직접 JPQL을 작성하고, 파라미터도 직접 바인딩 해야 한다.

 

스프링 데이터 JPA

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

• 스프링 데이터 JPA는 메서드 이름을 분석해서 필요한 JPQL을 만들고 실행해준다.
• 물론 JPQL은 JPA가 SQL로 번역해서 실행한다.
• 물론 그냥 아무 이름이나 사용하는 것은 아니고 다음과 같은 규칙을 따라야 한다.

 

 

스프링 데이터 JPA가 제공하는 쿼리 메소드 기능 

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

 

 

쿼리 메소드 필터 조건

Repository query keywords :: Spring Data JPA

• 스프링 데이터 JPA 공식 문서 참고

 

 

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(@Param("itemName") String itemName, @Param("price") Integer price);
}

• 쿼리 메서드 기능 대신에 직접 JPQL을 사용하고 싶을 때는 @Query 와 함께 JPQL을 작성하면 된다. 
• 이때는 메서드 이름으로 실행하는 규칙은 무시된다.
• 참고로 스프링 데이터 JPA는 JPQL 뿐만 아니라 JPA의 네이티브 쿼리 기능도 지원하는데, JPQL 대신에 SQL을 직접 작성할 수 있다.

---

스프링 데이터 JPA 적용1

설정

 

build.gradle 추가

//JPA, 스프링 데이터 JPA 추가
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

• 스프링 데이터 JPA는 spring-boot-starter-data-jpa 라이브러리를 넣어주면 된다

 

스프링 데이터 JPA 적용

 

SpringDataJpaItemRepository

public interface SpringDataJpaItemRepository extends JpaRepository<Item, Long> {

    List<Item> findByItemNameLike(String itemName);

    List<Item> findByPriceLessThanEqual(Integer price);

    //쿼리 메서드 (아래 메서드와 같은 기능 수행)
    List<Item> findByItemNameLikeAndPriceLessThanEqual(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 를 사용해서 직접 쿼리를 실행하면 된다.

 

여기서는 데이터를 조건에 따라 4가지로 분류해서 검색한다.

• 모든 데이터 조회
• 이름 조회
• 가격 조회
• 이름 + 가격 조회

동적 쿼리를 사용하면 좋겠지만, 스프링 데이터 JPA는 동적 쿼리에 약하다. 

이번에는 직접 4가지 상황을 스프링 데이터 JPA로 구현해보자.
그리고 이 문제는 이후에 Querydsl에서 동적 쿼리로 깔끔하게 해결하겠다.

 

참고

• 스프링 데이터 JPA도 Example 이라는 기능으로 약간의 동적 쿼리를 지원하지만, 실무에서 사용하기는 기능이 빈약하다. 
• 실무에서 JPQL 동적 쿼리는 Querydsl을 사용하는 것이 좋다.

 

findAll()

• 코드에는 보이지 않지만 JpaRepository 공통 인터페이스가 제공하는 기능이다.
• 모든 Item 을 조회한다.
• 다음과 같은 JPQL이 실행된다.

select i from Item i

 

findByItemNameLike()

• 이름 조건만 검색했을 때 사용하는 쿼리 메서드이다.
• 다음과 같은 JPQL이 실행된다.

select i from Item i where i.name like ?

 

findByPriceLessThanEqual()

• 가격 조건만 검색했을 때 사용하는 쿼리 메서드이다.
• 다음과 같은 JPQL이 실행된다.

select i from Item i where i.price <= ?

 

findByItemNameLikeAndPriceLessThanEqual()

• 이름과 가격 조건을 검색했을 때 사용하는 쿼리 메서드이다.
• 다음과 같은 JPQL이 실행된다.

select i from Item i where i.itemName like ? and i.price <= ?

 

findItems()

메서드 이름으로 쿼리를 실행하는 기능은 다음과 같은 단점이 있다.

1. 조건이 많으면 메서드 이름이 너무 길어진다.
2. 조인 같은 복잡한 조건을 사용할 수 없다.

메서드 이름으로 쿼리를 실행하는 기능은 간단한 경우에는 매우 유용하지만, 복잡해지면 직접 JPQL 쿼리를 작성하는 것이 좋다. 쿼리를 직접 실행하려면 @Query 애노테이션을 사용하면 된다. 메서드 이름으로 쿼리를 실행할 때는 파라미터를 순서대로 입력하면 되지만, 쿼리를 직접 실행할 때는 파라미터를 명시적으로 바인딩 해야 한다. 파라미터 바인딩은@Param("itemName") 애노테이션을 사용하고, 애노테이션의 값에 파라미터 이름을 주면 된다.

---

스프링 데이터 JPA 적용2

JpaItemRepositoryV2

@Repository
@Transactional
@RequiredArgsConstructor
public class JpaItemRepositoryV2 implements ItemRepository {

    private final SpringDataJpaItemRepository repository;

    @Override
    public Item save(Item item) {
        return repository.save(item);
    }

    @Override
    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
    public List<Item> findAll(ItemSearchCond cond) {
        String itemName = cond.getItemName();
        Integer maxPrice = cond.getMaxPrice();

        // 실무에선 동적쿼리로 만듬
        if (StringUtils.hasText(itemName) && maxPrice != null) {
            //return repository.findByItemNameLikeAndPriceLessThanEqual(itemName, maxPrice);
            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 사이를 맞추기 위한 어댑터 처럼 사용된다.

 

 

클래스 의존 관계

• JpaItemRepositoryV2 는 ItemRepository 를 구현한다. 그리고 SpringDataJpaItemRepository 를 사용한다.

 

 

런타임 객체 의존 관계

 

• 런타임의 객체 의존관계는 다음과 같이 동작한다.
• itemService ➔ jpaItemRepositoryV2 ➔ springDataJpaItemRepository(프록시 객체)

 

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

 

 

 

다음으로 기능에 대해서 알아보자.

 

save()

repository.save(item)

 

• 스프링 데이터 JPA가 제공하는 save() 를 호출한다.

 

update()

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

 

findById()

repository.findById(itemId)

 

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

 

findAll()

데이터를 조건에 따라 4가지의 경우의 수로 분류해서 검색한다.

• 모든 데이터 조회
• 이름 조회
• 가격 조회
• 이름 + 가격 조회

모든 조건에 부합할 때는 findByItemNameLikeAndPriceLessThanEqual() 를 사용해도 되고, repository.findItems() 를 사용해도 된다. 그런데 보는 것 처럼 조건이 2개만 되어도 이름이 너무 길어지는 단점이 있다. 따라서 스프링 데이터 JPA가 제공하는 메서드 이름으로 쿼리를 자동으로 만들어주는 기능과 @Query 로 직접 쿼리를 작성하는 기능 중에 적절한 선택이 필요하다.추가로 코드를 잘 보면 동적 쿼리가 아니라 상황에 따라 각각 스프링 데이터 JPA의 메서드를 호출해서 상당히 비효율적인 코드인 것을 알 수 있다. 앞서 이야기했듯이 스프링 데이터 JPA는 동적 쿼리 기능에 대한 지원이 매우 약하다. 이 부분은 이후에 Querydsl을 사용해서 개선해보자. 기능을 모두 개발했으니, 설정하고 실행해보자.

 

 

SpringDataJpaConfig

@Configuration
@RequiredArgsConstructor
public class SpringDataJpaConfig {

    private final SpringDataJpaItemRepository springDataJpaItemRepository;

    @Bean
    public ItemService itemService() {
        return new ItemServiceV1(itemRepository());
    }

    @Bean
    public ItemRepository itemRepository() {
        return new JpaItemRepositoryV2(springDataJpaItemRepository);
    }
}

• SpringDataJpaItemRepository 는 스프링 데이터 JPA가 프록시 기술로 만들어주고 스프링 빈으로도 등록해준다.

 

 

ItemServiceApplication - 변경

//@Import(JpaConfig.class)
@Import(SpringDataJpaConfig.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {}

• SpringDataJpaConfig 를 사용하도록 변경했다.

 

테스트를 실행하자

@Slf4j
@SpringBootTest
@Transactional
class ItemRepositoryTest {

    private static final Logger log = LoggerFactory.getLogger(ItemRepositoryTest.class);

    @Autowired
    ItemRepository itemRepository;

    /*@Autowired
    PlatformTransactionManager transactionManager;
    TransactionStatus status;

    @BeforeEach
    void beforeEach() {
        // 트랜잭션 시작
        status = transactionManager.getTransaction(new DefaultTransactionDefinition());
    }*/

    @AfterEach
    void afterEach() {
        //MemoryItemRepository 의 경우 제한적으로 사용
        if (itemRepository instanceof MemoryItemRepository) {
            ((MemoryItemRepository) itemRepository).clearStore();
        }
        // 트랜잭션 롤백
        // transactionManager.rollback(status);
    }

    @Test
    void save() {
        //given
        Item item = new Item("itemA", 10000, 10);

        //when
        Item savedItem = itemRepository.save(item);

        //then
        Item findItem = itemRepository.findById(item.getId()).get();
        log.info("itemId: {}", item.getId());
        assertThat(findItem).isEqualTo(savedItem);
    }

    @Test
    void updateItem() {
        //given
        Item item = new Item("item1", 10000, 10);
        Item savedItem = itemRepository.save(item);
        Long itemId = savedItem.getId();

        //when
        ItemUpdateDto updateParam = new ItemUpdateDto("item2", 20000, 30);
        itemRepository.update(itemId, updateParam);

        //then
        Item findItem = itemRepository.findById(itemId).get();
        assertThat(findItem.getItemName()).isEqualTo(updateParam.getItemName());
        assertThat(findItem.getPrice()).isEqualTo(updateParam.getPrice());
        assertThat(findItem.getQuantity()).isEqualTo(updateParam.getQuantity());
    }

    @Test
    void findItems() {
        //given
        Item item1 = new Item("itemA-1", 10000, 10);
        Item item2 = new Item("itemA-2", 20000, 20);
        Item item3 = new Item("itemB-1", 30000, 30);

        log.info("repository={}", itemRepository.getClass()); // 예외 변환을 해주는 Proxy
        itemRepository.save(item1);
        itemRepository.save(item2);
        itemRepository.save(item3);

        //둘 다 없음 검증
        test(null, null, item1, item2, item3);
        test("", null, item1, item2, item3);

        //itemName 검증
        test("itemA", null, item1, item2);
        test("temA", null, item1, item2);
        test("itemB", null, item3);

        //maxPrice 검증
        test(null, 10000, item1);

        //둘 다 있음 검증
        test("itemA", 10000, item1);
    }

    void test(String itemName, Integer maxPrice, Item... items) {
        List<Item> result = itemRepository.findAll(new ItemSearchCond(itemName, maxPrice));
        assertThat(result).containsExactly(items);
    }
}

• 먼저 ItemRepositoryTest 를 통해서 리포지토리가 정상 동작하는지 확인해보자.
• 테스트가 모두 성공해야 한다.

 

애플리케이션을 실행하자

• ItemServiceApplication 를 실행해서 애플리케이션이 정상 동작하는지 확인해보자.

 

 

예외 변환

• 스프링 데이터 JPA도 스프링 예외 추상화를 지원한다. 
• 스프링 데이터 JPA가 만들어주는 프록시에서 이미 예외 변환을 처리하기 때문에, @Repository 와 관계없이 예외가 변환된다. (JPA는 @Repository가 필요함.)

 

 

주의! - 하이버네이트 버그

• 하이버네이트 5.6.6 ~ 5.6.7 을 사용하면 Like 문장을 사용할 때 다음 예외가 발생한다.
• 스프링 부트 2.6.5 버전은 문제가 되는 하이버네이트 5.6.7을 사용한다.

java.lang.IllegalArgumentException: Parameter value [\] did not match expected

• type [java.lang.String (n/a)]build.gradle에 다음을 추가해서 하이버네이트 버전을 문제가 없는 5.6.5.Final 로 맞추자.
• ext["hibernate.version"] = "5.6.5.Final"

 

정리

• 스프링 데이터 JPA의 대표적인 기능을 알아보았다.
• 스프링 데이터 JPA는 이 외에도 정말 수 많은 편리한 기능을 제공한다. 
• 심지어 우리가 어렵게 사용하는 페이징을 위한 기능들도 제공한다. 
• 스프링 데이터 JPA는 단순히 편리함을 넘어서 많은 개발자들이 똑같은 코드로 중복 개발하는 부분을 개선해준다.