스프링 DB 2편 - 데이터 접근 활용 기술

목록보기

스프링 db 2편(데이터 접근 활용 기술)(2) 스프링 데이터 jpa

2023년 03월 20일

0. 스프링 데이터 JPA 소개 / 기능

제공되는 ppt 파일 (SpringDataJPA_ppt) 참고

1. 스프링 데이터 JPA 주요 기능

수많은 편리한 기능을 제공하지만 가장 대표적인 기능은 다음과 같다.

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

공통 인터페이스 기능

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

JpaRepository 사용법

```
public interface ItemRepository extends JpaRepository<Item, Long> {}
```
- JpaRepository 인터페이스를 인터페이스 상속 받고, 제네릭에 관리할 <엔티티, 엔티티ID> 를 주면 된다.
- 그러면 JpaRepository 가 제공하는 기본 CRUD 기능을 모두 사용할 수 있다.
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)
        .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

JPQL 직접 사용하기

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

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);
}

스프링 데이터 JPA는 JPA를 편리하게 사용하도록 도와주는 도구이다. 따라서 JPA 자체를 잘 이해하는 것이 가장 중요하다.

2. 스프링 데이터 JPA 적용1

build.gradle

```
//JPA, 스프링 데이터 JPA 추가
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
```
- 그런데 이미 앞에서 JPA를 설정하면서 spring-boot-starter-data-jpa 라이브러리를 넣어주었다.
- 여기에는 JPA , 하이버네이트, 스프링 데이터 JPA( spring-data-jpa ), 그리고 스프링 JDBC 관련 기능도 모두 포함되어 있다.

SpringDataJpaItemRepository (스프링 데이터 JPA 적용)

package hello.itemservice.repository.jpa;
  
import hello.itemservice.domain.Item;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
  
import javax.persistence.criteria.CriteriaBuilder;
import java.util.List;
  
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")
    //ibatis 말고 springframework.data.repository.query.Param; 로 import
    List<Item> findItems(@Param("itemName") String itemName, @Param("price") Integer price);
}
  

스프링 데이터 JPA가 제공하는 JpaRepository 인터페이스를 인터페이스 상속 받으면 기본적인 CRUD 기능을 사용할 수 있다.

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

모든 데이터 조회 / 이름 조회 / 가격 조회 / 이름 + 가격 조회
동적 쿼리를 사용하면 좋겠지만, 스프링 데이터 JPA는 동적 쿼리에 약하다. 이번에는 직접 4가지 상황을 스프링 데이터 JPA로 구현해보자

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("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);
```
- 쿼리를 직접 실행하려면 @Query 애노테이션을 사용하면 된다.
- 메서드 이름으로 쿼리를 실행할 때는 파라미터를 순서대로 입력하면 되지만, 쿼리를 직접 실행할 때는 파라미터를 명시적으로 바인딩 해야 한다.
- 파라미터 바인딩은 @Param(“itemName”) 애노테이션을 사용하고, 애노테이션의 값에 파라미터 이름을 주면 된다.

주의 : @Query 를 import 할 때 ibatis 말고 springframework.data.repository.query.Param; 으로 import 해야 한다.

3. 스프링 데이터 JPA 적용2

JpaItemRepositoryV2

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.transaction.annotation.Transactional;
import org.springframework.util.StringUtils;
  
import java.util.List;
import java.util.Optional;
  
@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.findItems("%"+itemName+"%", maxPrice);
        } else if(StringUtils.hasText(itemName)){
            return repository.findByItemNameLike("%"+itemName+"%");
        } else if (maxPrice != null) {
            return repository.findByPriceLessThanEqual(maxPrice);
        } else {
            return repository.findAll();
        }
    }
}

findAll()

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

의존관계와 구조

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

새로운 리포지토리(어댑터 역할) 만들기

여기서는 JpaItemRepositoryV2 가 ItemRepository 와 SpringDataJpaItemRepository 사이를 맞추기 위한 어댑터 처럼 사용된다.

클래스 의존관계

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

런타임 객체 의존 관계

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

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

SpringDataJpaConfig

package hello.itemservice.config;
  
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.jpa.JpaItemRepositoryV1;
import hello.itemservice.repository.jpa.JpaItemRepositoryV2;
import hello.itemservice.repository.jpa.SpringDataJpaItemRepository;
import hello.itemservice.service.ItemService;
import hello.itemservice.service.ItemServiceV1;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
  
import javax.persistence.EntityManager;
  
@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(SpringDataJpaConfig.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {}

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

테스트 및 앱 실행

아래 버그만 고치면 특 x

하이버네이트 버그

하이버네이트 5.6.6 ~ 5.6.7 을 사용하면 Like 문장을 사용할 때 다음 예외가 발생한다.
- java.lang.IllegalArgumentException: Parameter value [\] did not match expected type [java.lang.String (n/a)]
스프링 부트 2.6.5 버전은 문제가 되는 하이버네이트 5.6.7을 사용한다.
build.gradle에 다음을 추가해서 하이버네이트 버전을 문제가 없는 5.6.5.Final 로 맞추자.
ext["hibernate.version"] = "5.6.5.Final"
- core 라서 gradle 에 바로 추가하면 된다.

MismatchedTokenException

antlr.MismatchedTokenException: expecting IDENT, found ':'
...
antlr.NoViableAltException: unexpected token: itemName
...
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'itemController' defined in file [C:\Users\kimhobeen\IdeaProjects\inflearn\스프링 DB 2\itemservice-db\out\production\classes\hello\itemservice\web\ItemController.class]: Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'hello.itemservice.config.SpringDataJpaConfig': Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'springDataJpaItemRepository' defined in hello.itemservice.repository.jpa.SpringDataJpaItemRepository defined in @EnableJpaRepositories declared on JpaRepositoriesRegistrar.EnableJpaRepositoriesConfiguration: Invocation of init method failed; nested exception is org.springframework.data.repository.query.QueryCreationException: Could not create query for public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)! Reason: Validation failed for query for method public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)!; nested exception is java.lang.IllegalArgumentException: Validation failed for query for method public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)!
...
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'springDataJpaItemRepository' defined in hello.itemservice.repository.jpa.SpringDataJpaItemRepository defined in @EnableJpaRepositories declared on JpaRepositoriesRegistrar.EnableJpaRepositoriesConfiguration: Invocation of init method failed; nested exception is org.springframework.data.repository.query.QueryCreationException: Could not create query for public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)! Reason: Validation failed for query for method public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)!; nested exception is java.lang.IllegalArgumentException: Validation failed for query for method public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)!
...
Caused by: org.springframework.data.repository.query.QueryCreationException: Could not create query for public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)! Reason: Validation failed for query for method public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)!; nested exception is java.lang.IllegalArgumentException: Validation failed for query for method public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)!
...
Caused by: java.lang.IllegalArgumentException: Validation failed for query for method public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems(java.lang.String,java.lang.Integer)!
...
Caused by: java.lang.IllegalArgumentException: org.hibernate.hql.internal.ast.QuerySyntaxException: expecting IDENT, found ':' near line 1, column 70 [select i from hello.itemservice.domain.Item i where i.itemName like ::itemName and i.price <= :price]

일단 핵심 에러 클래스가 ItemServiceApplication.run 으로 나와서 찾을 순 없었다.
root cause 를 따라가보면 알 수 있다. (물론 찾고 나서 보니 보이는 거 같긴 하다)
1. antlr.MismatchedTokenException: expecting IDENT, found ‘:’ … antlr.NoViableAltException: unexpected token: itemName
  
  -> 어딘가 itemName 이나 : 가 잘못적힌 듯하다.(여기서 뒤져서 찾긴 했다)
2. UnsatisfiedDependencyException: Error creating bean with name ‘itemController’
  
  -> 의존이 잘못되어 itemController 를 못만들었다. 그 이유는,
3. BeanCreationException: Error creating bean with name ‘springDataJpaItemRepository’
  
  -> springDataJpaItemRepository 을 스프링빈으로 못만들었다. 그 이유는,
4. QueryCreationException: Could not create query for public abstract java.util.List hello.itemservice.repository.jpa.SpringDataJpaItemRepository.findItems
  
  -> findItems 에서 쿼리를 못만들었다. 그 이유는,
5. IllegalArgumentException
  
  -> 이상한거 써서 그래
6. Caused by: java.lang.IllegalArgumentException: org.hibernate.hql.internal.ast.QuerySyntaxException: expecting IDENT, found ‘:’ near line 1, column 70 [select i from hello.itemservice.domain.Item i where i.itemName like ::itemName and i.price <= :price]
  
  -> 바로 여기서 ‘:’ 를 이상하게 썼다.
읽으려고 하니 생각보다 읽히고, 친절한 느낌이다.

Twitter Facebook LinkedIn

스프링 db 2편(데이터 접근 활용 기술)(2) 스프링 데이터 jpa

0. 스프링 데이터 JPA 소개 / 기능

1. 스프링 데이터 JPA 주요 기능

공통 인터페이스 기능

JpaRepository 사용법

쿼리 메서드 기능

순수 JPA 리포지토리

스프링 데이터 JPA

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

JPQL 직접 사용하기

2. 스프링 데이터 JPA 적용1

build.gradle

SpringDataJpaItemRepository (스프링 데이터 JPA 적용)

findAll()

findByItemNameLike()

findByPriceLessThanEqual()

findByItemNameLikeAndPriceLessThanEqual()

findItems()

3. 스프링 데이터 JPA 적용2

JpaItemRepositoryV2

findAll()

의존관계와 구조

새로운 리포지토리(어댑터 역할) 만들기

클래스 의존관계

런타임 객체 의존 관계

SpringDataJpaConfig

ItemServiceApplication - 변경

테스트 및 앱 실행

하이버네이트 버그

MismatchedTokenException

공유하기

댓글남기기

참고

[Spring Batch] SpringBatch 필요한 Reader 만들기

[EKS] EKS 에서 DNS resolve 에러

[Kafka] 카프카 스트림즈로 집계하기

[Kafka] 도커에서 카프카 접근하기