[Spring Data JPA] 스프링 데이터 JPA

Spring Data JPA란?

스프링 프레임워크에서 JPA를 편리하게 사용할 수 있도록 지원하는 프로젝트입니다.

 

주 기능

- CRUD 처리를 위한 공통 인터페이스를 제공

- Repository 계층에 구현 클래스 없이 인터페이스만 작성하면  실행 시점에 스프링 데이터 JPA가 구현 객체를 동적으로 생성 및 주입

- 공통 메소드는 스프링 데이터 JPA가 제공하는  org.springframework.date.jpa.repository.JpaRepository 인터페이스에

  count, delete, deleteAll, deleteAll, deleteById, existsById, findById, save 등이 구현되어 있습니다.

 

사용 방법

build.gradle에 의존관계 추가 

implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

리포지토리 계층을 인터페이스로 선언하고 JpaRepository를 상속받습니다.

 

- JpaRepository.interface

public interface JpaRepository<T, ID> extends PagingAndSortingRepository<T, ID>, QueryByExampleExecutor<T> {

    @Override
    List<T> findAll();

    @Override
    List<T> findAll(Sort sort);

    @Override
    List<T> findAllById(Iterable<ID> ids);

    @Override
    <S extends T> List<S> saveAll(Iterable<S> entities);

    void flush();

    <S extends T> S saveAndFlush(S entity);

    <S extends T> List<S> saveAllAndFlush(Iterable<S> entities);

    @Deprecated
    default void deleteInBatch(Iterable<T> entities){deleteAllInBatch(entities);}

    void deleteAllInBatch(Iterable<T> entities);

    void deleteAllByIdInBatch(Iterable<ID> ids);

    void deleteAllInBatch();

    @Deprecated
    T getOne(ID id);

    T getById(ID id);

    @Override
    <S extends T> List<S> findAll(Example<S> example);

    @Override
    <S extends T> List<S> findAll(Example<S> example, Sort sort);
}

 

- JpaRepository 인터페이스를 상속받고, 제네릭에 관리할 <엔티티, 엔티티ID>를 주면 됩니다.

 

---

공통 인터페이스 기능

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

이렇게 JpaRepository 인터페이스만 상속받아도 Spring Data JPA가 프록시 기술을 사용해서 구현 클래스를 만들고 스프링 빈으로 등록해주기 때문에 개발자는 구현 클래스 없이 인터페이스만 만들면 기본 CRUD 기능을 사용할 수 있습니다.

---

쿼리 메소드 기능 

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

// 쿼리 메소드
List<Item> findByItemNameLikeAndPriceLessThanEqual(String itemName, Integer price);

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

- 조회 : find..By, read..By, query..By, get..By

- Row 수 COUNT : count..By ( return type : long )

- 존재 여부 : Exist : exists...By ( return type : boolean )

- 삭제 : delete...By, remove...By ( return type : boolean - 삭제된 row 수 )

- 중복없는 Row 수 Distinct : ex) findDistinct, findMemberDistinctBy 

-LIMIT : findFirst3, findFirst, findTop, findTop3

 

공식 문서 참조

Spring Data JPA - Reference Documentation

Distinct	findDistinctByLastnameAndFirstname	select distinct …​ where x.lastname = ?1 and x.firstname = ?2
And	findByLastnameAndFirstname	… where x.lastname = ?1 and x.firstname = ?2
Or	findByLastnameOrFirstname	… where x.lastname = ?1 or x.firstname = ?2
Is, Equals	findByFirstname,findByFirstnameIs,findByFirstnameEquals	… where x.firstname = ?1
Between	findByStartDateBetween	… where x.startDate between ?1 and ?2
LessThan	findByAgeLessThan	… where x.age < ?1
LessThanEqual	findByAgeLessThanEqual	… where x.age <= ?1
GreaterThan	findByAgeGreaterThan	… where x.age > ?1
GreaterThanEqual	findByAgeGreaterThanEqual	… where x.age >= ?1
After	findByStartDateAfter	… where x.startDate > ?1
Before	findByStartDateBefore	… where x.startDate < ?1
IsNull, Null	findByAge(Is)Null	… where x.age is null
IsNotNull, NotNull	findByAge(Is)NotNull	… where x.age not null
Like	findByFirstnameLike	… where x.firstname like ?1
NotLike	findByFirstnameNotLike	… where x.firstname not like ?1
StartingWith	findByFirstnameStartingWith	… where x.firstname like ?1 (parameter bound with appended %)
EndingWith	findByFirstnameEndingWith	… where x.firstname like ?1 (parameter bound with prepended %)
Containing	findByFirstnameContaining	… where x.firstname like ?1 (parameter bound wrapped in %)
OrderBy	findByAgeOrderByLastnameDesc	… where x.age = ?1 order by x.lastname desc
Not	findByLastnameNot	… where x.lastname <> ?1
In	findByAgeIn(Collection<Age> ages)	… where x.age in ?1
NotIn	findByAgeNotIn(Collection<Age> ages)	… where x.age not in ?1
True	findByActiveTrue()	… where x.active = true
False	findByActiveFalse()	… where x.active = false
IgnoreCase	findByFirstnameIgnoreCase	… where UPPER(x.firstname) = UPPER(?1)

 

쿼리 메소드 기능을 사용하지 않고 직접 JPQL을 사용하고 싶을 때는 @Query 에 직접 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 를 사용하면 메소드 이름으로 실행하는 규칙이 무시됩니다.

JPQL이 아닌 SQL을 작성하는 네이티브 쿼리 기능을 사용하려면 nativeQuery = true 옵션 추가 (@Param 사용하지 않을 경우 바인딩이 0부터 시작)

 

---

페이징 기능

스프링 데이터 JPA는 쿼리 메소드에 페이징과 정렬 기능을 제공합니다.

 

- org.springframework.data.domain.Sort : 정렬 기능

- org.springframework.data.domain.Pageable : 페이징 기능(내부에 Sort 포함)

 

public interface SpringDataJpaItemRepository extends JpaRepository<Item,Long> {
	List<Item> findByItemNameStartingWith(String itemName, Pageable pageable);

파라미터에 Pageable을 사용하면 반환타입으로 List나 Page를 사용할 수 있습니다.

> 반환 타입이 Page인 경우 스프링 데이터 JPA는 페이징 기능을 제공하기 위해 검색된 전체 데이터 건수를 조회하는 count쿼리를  추가로 호출합니다.

> 반환 타입이 List인 경우에는 count 쿼리를 호출하지 않습니다.

 

페이징 조건, 정렬 조건은 PageRequest를 통해 설정할 수 있습니다.

public List<Item> findByItemNameStartingWithName01(String itemName)
{
    Sort sort = Sort.by("itemName").descending();
    PageRequest pageable = PageRequest.of(0,10, sort);
    List<Item> result = repository.findByItemNameStartingWith("Name01", (Pageable) pageable);
    return result;
}

---

Spring Data JPA 적용

JpaRepository 인터페이스를 상속받으면 기본적인 CRUD 기능들은 구현되어 있기 때문에, 개발자가 원하는 기능을 추가적으로 쿼리메소드를 사용하며 구현해주면됩니다.

 

1. findByItemNameLike(String itemName) : itemName만을 사용해 검색했을 때 사용하는 쿼리 메소드

List<Item> findByItemNameLike(String itemName);

실행되는 JPQL 쿼리 

select i from Item i where i.name like itemName

2. findByPriceLessThanEqual() : price만을 사용해 검색했을 때 사용하는 쿼리 메소드

List<Item> findByPriceLessThanEqual(Integer price);

실행되는 JPQL 쿼리

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

 

3. findByItemNameLikeAndPriceLessThanEqual() : itemName과 price를 사용해 검색했을 때 사용하는 쿼리 메소드

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

조건이 많으면 메소드 이름이 길어지기 때문에 복잡해지는 경우 직접 JPQL 쿼리를 작성하는 것이 좋습니다.

@Query(value = "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);

@Param을 통해 이름 기반 파라미터 바인딩 사용

@Param을 사용하지 않으면 위치 기반 파라미터 바인딩이 사용되는데, 코드의 가독성과 유지보수를 위해 이름 기반 파라미터를 사용합시다.

 

JpaItemRepositoryV2

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

    // 프록시로 자동주입됩니다.
    private final SpringDataJpaItemRepository repository;

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

 

클래스 의존관계

 

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

• JpaRepository 에 구현되어 있는 CRUD 기능과 메소드 쿼리를 이용해 리포지토리 계층 구현

findAll() 메소드의 동적 쿼리 부분은 상황에 따라 각각 스프링 데이터 JPA의 메소드를 호출해서 상당히 비효율적인데, 이 후 Querydsl을 사용하면 깔끔하게 개선이 가능합니다. 이 부분은 이후에 Querydsl을 이용해 개선하도록 하겠습니다.

 

+ Config 설정

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

 

+ 예외 변환

마찬가지로 스프링 데이터 JPA도 예외 추상화 변환을 지원합니다. 스프링 데이터 JPA는 프록시에서 예외변환을 처리해주어 @Repository에 관계없이 예외가 변환됩니다.

 

<정리>

스프링 데이터 JPA는 Querydsl과 더불어 실무에서 기본으로 선택하는 기술입니다. JPA와 스프링 데이터 JPA는 공부할 양이 많기 때문에 이번 포스팅에서는 대략적인 사용법을 알아보았고, 이 이후에 자세하게 알아보도록 하겠습니다.

---

<참고자료>

Spring Data JPA - Reference Documentation

 

스프링 DB 2편 - 데이터 접근 활용 기술 - 인프런 | 강의

 

[Spring + JPA] Spring Data JPA 란? (1)