[SpringDB] #6. 스프링 데이터 JPA

bien·2024년 1월 9일

spring_db_2

springDB2

목록 보기

2/2

소개1: 등장이유

스프링
- 트랜잭션 관리 & 빈 컨테이너 기술
- 현재 EJB 컨테이너 대체
- 단순하고 편리
하이버네이트
- EJB 엔티티빈 기술을 대체 (EJB ORM)
- JPA(Java Persistence API)라는 새로운 표준 정의

JPA가 널리 사용되는 이유
- 실제 실무에서 활용되는 오픈 소스를 기반으로 한 표준
  - 실무의 복잡성 다룸 + 정제(표준)
스프링 데이터 JPA 장점
- CRUD + 쿼리
- 동일한 인터페이스
- 페이징 처리 제공
- 메서드 이름으로 쿼리 생성
- 스프링 MVC에서 id 값만 넘겨도 도메인 클래스로 바인딩
Spring Data만 알면 되나요?
- 자바를 모르고 스프링을 사용하는 것과 같음
- 해당 기술을 아는 사람이 편하게 사용하려고 쓰는 것

소개2: 기능

data access 기술의 발전

순수 JDBC

JDBC를 사용하여 데이터베이스에 연결하고 쿼리를 수행하는 방식
직접 SQL을 작성하여 데이터베이스 조작

Spring JdbcTemplate

JDBC의 복잡성을 줄이고 반복적인 작업 단순화.
SQL 쿼리를 실행하고 결과를 처리하기 위한 다양한 메서드와 유틸리티를 제공.

Spring + JPA(Java Persistence API)

Spring 프레임워크의 지원을 받아 JPA를 사용하여 객체 관계 매핑을 수행
객체와 데이터베이스 레코드 간의 매핑 및 데이터 액세스 관리

Spring + Spring Data + JPA

Spring Data JPA를 활용하여 더 높은 수준의 데이터 엑세스 추상화 및 자동화
JPA 기반의 리포지토리 인터페이스를 통한 CRUD 기능 제공과 데이터베이스 엑시스 관련 기능의 자동화

Spring Data JPA

JpaRepository 인터페이스

<S extends T> S save(S entity)
void delete(Id i)
Optional<T> findById(Id id)
Iterable<T> findAll()
long count()
etc...

인터페이스를 구현한 클래스는?

🤔 어떻게 인터페이스 만으로 작동을 하지? 구현체는??

동적 프럭시 기술이 interface에 대한 구현체를 자동으로 생성해준다.

메서드 이름으로 퀘리 생성

JpaRepository 인터페이스를 제공하지만, 이것 만으로는 부족할 수 있다. 그런 경우를 대비하여 '메서드 이름으로 쿼리 생성' 기능을 제공한다.

public interface MemberRepository extends Repository<Member, Long> {
	List<User> findByEmailAndName(String email, String name);
}

이렇게 메서드 이름을 작성하면, 알아서 메서드 이름을 분석하여 JPQL을 만들어준다!

생성된 JPQL

SELECT m FROM Member m
WHERE m.email = ?1
	and m.name = ?2

@Query

인터페이스에 쿼리작성 가능

public interface UserRepository extends JpaRepository<User, Long> {
	@Query("select u form User u where u.emailAddress = ?1")
    User findByEmailAddress(String emailAddress);
}

바로 JPQL을 직접 작성할 수 있는 기능 제공.

JPA 네이티브 쿼리 지원

public iinterface UserRepository extends JpaRepository<User, Long> {
	@Query(value = "SELECT * FROM USERS WHERE EMAIL_ADDRESS = ?0", nativeQuery = true)
    User findByEmailAddress(String emailAddress);
}

바로 nativeQuery를 작성할 방법도 같이 제공

@Modifying

수정 쿼리도 직접 정의 가능

@Modifying(clearAutomatically = true)
@Query("update User u set u.firstname = ?1 where u.lastname =?2")
int setFixedFirstnamefor(String firstname, String lastname);

백엔드 주요 프레임워크

장점

코딩량 (반복되는 코드 작성 감소)
도매인 클래스를 중요하게 다룸
비지니스 로직 이해 쉬움
더 많은 테스트 케이스 작성 가능.

JPA 도입 전 이해를 확인하기 위한 테스트

영속성 컨텍스트 이해
변경 감지
언제 영속성 컨텍스트가 플레시 되는가
연관관계 매핑중에 mappedBy(inverse) 이해
JPQL 한계 인식

주요 기능

스프링 데이터 JPA는 JPA를 편리하게 사용할 수 있도록 도와주는 라이브러리이다. 수많은 유용한 기능 중 대표적인 기능은 '공통 인퍼테이스 기능', '쿼리 메서드 기능'이다.

공통 인터페이스 기능

JpaRepository 인터페이스를 통해서 기본적인 CRUD 기능을 제공한다.
공통화 가능한 기능이 거의 모두 포함되어 있다.
CrudRepository에서 fineOne() -> findById()로 변경되었다.
머릿속으로 쉽게 연상 가능한 메서드들은 거의 제공하고 있다.

JpaRepository 사용법

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

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

(ctrl + N) *2번. 후 JpaRepository 검색으로 해당 클래스를 조회할 수 있다.

스프링 데이터 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 andm.age > :age"
    		 .setParameter("username", username)
             .setParameter("age", age)
             .getResultList();
}

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

스프링 데이터 JPA

public interface MemberRepsitory extends JpaRepository<Member, Long> {
	List<Member> findByUsernameAndGreaterThan(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

쿼리 메서드 필터 조건
스프링 데이터 JPA 공식 문서 참고

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.querymethods.query-creation

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#repositories.limitquery-result

JPQL 직접 사용하기

pblic interface SpringDataJpaItemRepostiroy extends JpaRepostory<Item,Long> {
	
    // 쿼리 메서드 기능
    List<Item> findByItemNameLike(String itemName);
    
    // 쿼리 직접 실행
    @Query("select i from Item i where i.itemName like :itemName add i.price <= :price")
    List<Item> findItems(@Param("itemNames") String itemName, @Param("price") Integer price);

}

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

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

적용 1단계

1. 설정

build.gradle

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

JPA, 하이버네이트, 스프링 데이터 JPA(spring-data-jpa) 그리고 스프링 JDBC 관련 기능도 모두 포함되어 있다.

2. 스프링 데이터 JPA 적용

SpringDataJpaItemRepository

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 java.util.List;

public interface SpringDataJpaItemRepository extends JpaRepository<Item, Long> {

    List<Item> findByItemNameLike(String itemName);
    List<Item> findByPriceLessThanEqual(Integer price);

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

    // 쿼리 직접 실행
    @Query("select i from 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가지 상황을 스프링 데이터 JAP로 구현해보자. 그리고 이 문제는 이후에 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") 애노테이션을 사용하고, 애노테이션의 값에 파라미터 이름을 주면 된다.

적용2

기존 의존관계 유지

JpaItemRepository2

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

의존관계와 구조

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는 동적 쿼리 기능에 대한 지원이 매우 약하다. 이 부분은 이후에 Querysdsl을 사용해서 개선해보자.

설정 및 적용

SpringDataJpaconfig

package hello.itemservice.config;

import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.jpa.JpaItemRepository;
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.beans.factory.annotation.Required;
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(JpaConfig.class)
@Import(SpringDataJpaConfig.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {}

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

예외 변환

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

주의! 하이버네이트 버그
하이버네이트 5.6.6~5.6.7을 사용하면 Like 문장을 사용할 때 다음 예외가 발생한다.
java.lang.IllegalArgumentException: Parameter value [\] did not match expected type 
[java.lang.String (n/a)]
build.gradle에 다음을 추가해서 하이버네이트 버전을 문제가 없는 5.6.5.Final로 맞추자.

Reference

[인프런:김영한]스프링 DB 2편 - 데이터 접근 활용 기술

bien

Good Luck!

이전 포스트

[SpringDB] #6. 스프링 데이터 JPA

springDB2

소개1: 등장이유

소개2: 기능

data access 기술의 발전

순수 JDBC

Spring JdbcTemplate

Spring + JPA(Java Persistence API)

Spring + Spring Data + JPA

Spring Data JPA

JpaRepository 인터페이스

인터페이스를 구현한 클래스는?

메서드 이름으로 퀘리 생성

@Query

@Modifying

백엔드 주요 프레임워크

장점

JPA 도입 전 이해를 확인하기 위한 테스트

주요 기능

공통 인터페이스 기능

JpaRepository 사용법

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

쿼리 메서드 기능

순수 JPA 리포지토리

스프링 데이터 JPA

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

JPQL 직접 사용하기

적용 1단계

1. 설정

build.gradle

2. 스프링 데이터 JPA 적용

SpringDataJpaItemRepository

findAll()

findByItemNameLike()

findByPriceLessThanEqual()

findByItemNameLikeAndPriceLessThanEqual()

findItems()

적용2

기존 의존관계 유지

JpaItemRepository2

의존관계와 구조

클래스 의존 관계

런타임 객체 의존 관계

기능

save()

update()

findById()

findAll()

설정 및 적용

SpringDataJpaconfig

ItemServiceApplication 변경

예외 변환

Reference

[SpringDB] #5. JPA

0개의 댓글