Spring Data JPA - JpaRepository

Spring Data JPA(Spring Data Java Persistence API)

JpaRepository

JpaRepository는 Spring Data JPA에서 제공하는 가장 일반적이고 유용한 인터페이스 중 하나로, 데이터베이스 접근을 간소화하고 반복적인 CRUD 작업을 줄이는 데 목적이 있습니다. JpaRepository는 CrudRepository와 PagingAndSortingRepository를 상속받아 더 풍부한 기능을 제공합니다. 이 인터페이스를 사용하면 개발자는 복잡한 데이터 접근 코드를 직접 작성하지 않고도 JPA를 활용하여 데이터베이스와 상호작용할 수 있습니다.

• JpaRepository는 높은 추상화 수준을 제공하고 CRUD 작업을 매우 간단하게 처리할 수 있어, 단순 데이터 접근 로직을 빠르게 구현하고 싶은 경우에 적합합니다.
• EntityManager는 더 낮은 수준의 JPA API를 제공하여, 영속성 컨텍스트와 트랜잭션의 직접적 제어가 필요한 복잡한 비즈니스 로직에서 유용하게 사용할 수 있습니다.
• 각 접근 방식의 장단점을 잘 이해하고 상황에 맞게 적절하게 사용하는 것이 중요합니다. 간단한 CRUD와 일반적인 비즈니스 로직은 JpaRepository를 사용하고, 세밀한 영속성 관리와 복잡한 트랜잭션 처리에는 EntityManager를 사용하는 것이 좋습니다.

주요 특징 및 사용법

JpaRepository는 Spring Data JPA가 제공하는 기본적인 CRUD (Create, Read, Update, Delete) 및 페이징/정렬 기능을 모두 포함하고 있습니다. 아래는 JpaRepository의 주요 특징을 설명한 내용입니다.

기본적인 JpaRepository 인터페이스의 사용

JpaRepository를 사용하기 위해서는 엔티티(Entity) 클래스와 기본 키 타입을 명시하는 인터페이스를 정의해야 합니다. Spring Data JPA는 해당 인터페이스의 구현체를 자동으로 생성해 주므로, 데이터 접근 로직을 쉽게 관리할 수 있습니다.

예를 들어, User 엔티티를 데이터베이스에 저장하고, 조회하고, 업데이트하고, 삭제하려고 할 때는 다음과 같이 작성할 수 있습니다.

import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {
    // 필요한 경우 커스텀 메소드를 추가할 수 있습니다.
}

위 예시에서:

• User는 엔티티 클래스입니다.
• Long은 기본 키 타입입니다.

Spring Data JPA는 이 인터페이스에 대한 구현체를 자동으로 생성하고, Spring 컨텍스트에서 사용할 수 있도록 빈으로 등록해 줍니다.

기본 CRUD 메소드

JpaRepository는 기본적으로 다음과 같은 CRUD 메소드를 제공합니다:

1. save(S entity):
   • 엔티티를 저장합니다. 이미 존재하는 엔티티의 경우 업데이트, 새 엔티티의 경우 삽입 동작을 수행합니다.
   • User savedUser = userRepository.save(user);
2. findById(ID id):
   • 주어진 ID에 해당하는 엔티티를 조회합니다.

     Optional<User> user = userRepository.findById(1L);

3. findAll():
   • 모든 엔티티를 조회합니다.

     List<User> users = userRepository.findAll();

4. deleteById(ID id):
   • 주어진 ID를 가진 엔티티를 삭제합니다.

     userRepository.deleteById(1L);

5. count():
   • 저장된 엔티티의 총 개수를 반환합니다.

     long userCount = userRepository.count();

페이징 및 정렬 기능

JpaRepository는 페이징 및 정렬 기능을 제공합니다. 이러한 기능은 대량의 데이터를 다룰 때 성능을 개선하고 UI에서 데이터를 효율적으로 표시하는 데 유용합니다.

• 페이징을 위해 Pageable 인터페이스를 사용합니다.위의 예는 첫 번째 페이지에서 10개의 사용자를 반환합니다.
• Page<User> usersPage = userRepository.findAll(PageRequest.of(0, 10));
• 정렬을 위해 Sort 객체를 사용합니다.위의 예는 사용자들을 lastName 기준으로 오름차순으로 정렬하여 반환합니다.
• List<User> users = userRepository.findAll(Sort.by("lastName").ascending());

메소드 이름 기반 쿼리

JpaRepository는 메소드 이름을 기반으로 쿼리를 자동으로 생성할 수 있는 쿼리 메소드 기능을 제공합니다. 이는 쿼리 작성 없이 간단한 검색 조건을 통해 데이터를 쉽게 조회할 수 있게 합니다.

 

예를 들어, 사용자의 username으로 데이터를 검색하려면 다음과 같이 작성할 수 있습니다.

List<User> findByUsername(String username);

이 메소드는 SQL 쿼리를 작성할 필요 없이 username 필드 값을 기준으로 검색을 수행합니다. 추가적으로 여러 조건을 결합할 수도 있습니다.

List<User> findByUsernameAndEmail(String username, String email);

이 경우 username과 email이 모두 일치하는 엔티티를 찾습니다.

@Query 어노테이션 사용

복잡한 쿼리가 필요한 경우 @Query 어노테이션을 사용하여 JPQL(Java Persistence Query Language)이나 네이티브 SQL을 사용할 수 있습니다.

@Query("SELECT u FROM User u WHERE u.age > :age")
List<User> findUsersOlderThan(@Param("age") int age);

이 예는 age 값보다 큰 User들을 조회하는 JPQL 쿼리입니다. @Param을 사용하여 파라미터를 전달할 수 있습니다.

기본적으로 제공되는 인터페이스들

Spring Data JPA는 여러 계층의 인터페이스를 제공하여 다양한 기능을 지원합니다.

1. Repository<T, ID>: 모든 CRUD 인터페이스의 기본 인터페이스입니다. 가장 기본적인 기능을 제공하며, 직접 사용되지 않고 상속만 됩니다.
2. CrudRepository<T, ID>: 기본적인 CRUD 기능을 제공합니다.
3. PagingAndSortingRepository<T, ID>: 페이징 및 정렬을 포함한 기능을 제공합니다.
4. JpaRepository<T, ID>: CrudRepository와 PagingAndSortingRepository를 확장하여 JPA와 관련된 추가 기능을 제공합니다.

사용 예시

아래는 User 엔티티에 대해 JpaRepository를 활용한 서비스 클래스 예시입니다.

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    public List<User> getAllUsers() {
        return userRepository.findAll();
    }

    public User getUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }

    public void saveUser(User user) {
        userRepository.save(user);
    }

    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }

    public List<User> findUsersByUsername(String username) {
        return userRepository.findByUsername(username);
    }
}

위의 UserService 클래스는 JpaRepository를 활용하여 기본적인 CRUD 작업을 처리합니다. 이러한 방식을 통해 데이터 접근 로직을 쉽게 구현할 수 있으며, 복잡한 쿼리가 필요한 경우에는 커스텀 메소드를 정의하여 사용할 수 있습니다.

장점

• 간결함: 데이터 접근 로직을 거의 작성하지 않아도 되므로 코드가 매우 간결해집니다.
• 자동 구현: 인터페이스만 정의하면 Spring Data JPA가 구현체를 자동으로 생성해 주므로 개발자는 비즈니스 로직에 집중할 수 있습니다.
• 유연성: 메소드 이름을 기반으로 한 자동 쿼리 생성은 코드를 직관적이고 유연하게 만듭니다.
• 페이징과 정렬 지원: 대용량 데이터 처리 시 페이징과 정렬 기능이 손쉽게 지원됩니다.

단점

• 복잡한 쿼리 제한: 메소드 이름으로 쿼리를 자동 생성할 때 너무 복잡한 조건이 들어가면 메소드 이름이 길어지고 가독성이 떨어집니다. 이 경우 @Query 어노테이션이나 명시적인 쿼리 작성을 고려해야 합니다.
• 추상화의 한계: 모든 복잡한 데이터 작업을 추상화된 메소드로 처리하는 것은 어렵기 때문에, 특정 요구 사항을 위해서는 여전히 JPQL이나 네이티브 쿼리가 필요할 수 있습니다.

JpaRepository는 Spring Data JPA에서 데이터 접근 레이어를 빠르고 쉽게 개발하기 위한 매우 강력한 도구입니다. 기본적인 CRUD 작업과 페이징/정렬을 쉽게 처리할 수 있도록 해주며, 개발자는 데이터 접근 로직을 최대한 간결하게 유지하면서도 필요한 경우 복잡한 쿼리와 고급 기능을 구현할 수 있습니다.

728x90

---

JpaRespository Vs. EntityManager

JpaRepository와 EntityManager는 모두 JPA를 사용하여 데이터베이스와 상호작용하는 방식이지만, 그 사용 방법과 목적, 그리고 추상화 수준이 다릅니다. 각각의 장단점과 사용하는 상황을 비교하여 설명해 보겠습니다.

 

1. JpaRepository vs EntityManager 개요

• JpaRepository: Spring Data JPA에서 제공하는 고수준의 데이터 접근 추상화 인터페이스입니다. 기본적인 CRUD 작업과 데이터 접근을 매우 간결하게 구현할 수 있도록 도와줍니다.
• EntityManager: JPA의 핵심 인터페이스로, 영속성 컨텍스트를 관리하고 엔티티의 생명주기 관리, 쿼리 실행 등 세부적인 데이터베이스 상호작용을 수행합니다. EntityManager는 더 낮은 수준의 접근 방식을 제공합니다.

2. 기능 및 사용 용도

• JpaRepository:
  • JpaRepository는 반복적인 CRUD 작업과 단순한 데이터 접근 로직을 매우 빠르고 간편하게 처리할 수 있도록 설계되었습니다.
  • 페이징과 정렬을 위한 PagingAndSortingRepository 기능을 기본으로 제공하며, 쉽게 페이징된 데이터를 가져올 수 있습니다.
  • 데이터 접근 계층의 구현체를 자동으로 생성해 주므로, 개발자는 코드의 비즈니스 로직에 집중할 수 있습니다.
  • 기본적인 CRUD 외에도 메소드 이름을 이용한 조건 쿼리나 @Query 어노테이션을 통한 JPQL 쿼리를 지원합니다.
• EntityManager:
  • EntityManager는 엔티티의 생명주기(영속, 비영속, 준영속, 삭제)를 직접적으로 관리합니다. 따라서 엔티티를 보다 정밀하게 제어하고, 영속성 컨텍스트에 대한 제어가 필요할 때 주로 사용됩니다.
  • 더 복잡한 쿼리나 커스텀 데이터베이스 작업이 필요할 때, 또는 영속성 컨텍스트의 직접적인 조작이 필요할 때 사용됩니다.
  • persist(), merge(), remove() 등 메소드를 사용하여 엔티티의 상태를 직접 변경하거나 관리할 수 있습니다.
  • 트랜잭션 처리와 영속성 컨텍스트의 명시적인 관리를 가능하게 하며, 더 복잡한 트랜잭션 제어가 필요한 경우 적합합니다.

3. 코드 작성량 및 유지보수

• JpaRepository:
  • 코드 작성량이 매우 적으며, 대부분의 데이터 접근 로직은 인터페이스 정의만으로 끝납니다. Spring Data JPA는 인터페이스의 구현을 자동으로 생성해 주기 때문에 코드 유지보수가 간편합니다.
  • 인터페이스 기반으로 데이터 접근 계층을 구성하므로 유지보수가 쉽고 코드가 직관적입니다.
  • 일반적인 CRUD 및 간단한 쿼리를 위한 코드를 간소화하고, 이를 통해 개발 생산성을 높일 수 있습니다.
• EntityManager:
  • 모든 동작을 명시적으로 작성해야 하므로 코드 작성량이 증가합니다. 영속성 컨텍스트와 트랜잭션 제어가 필요할 때 코드를 세밀하게 작성해야 하며, 이는 유지보수의 복잡성을 증가시킬 수 있습니다.
  • 명시적인 트랜잭션 처리가 필요하거나 영속성 상태를 조정해야 하는 복잡한 시나리오에서 더 적합합니다.
  • JPA의 세부 기능과 엔티티의 라이프사이클을 명확하게 이해하고 있어야 하며, 복잡한 비즈니스 로직 구현 시 적절한 제어가 가능합니다.

4. 트랜잭션 관리

• JpaRepository:
  • Spring Data JPA에서 @Transactional 어노테이션을 이용해 트랜잭션 관리가 자동으로 이루어집니다.
  • CRUD 작업이 대부분 자동으로 트랜잭션에 포함되므로, 트랜잭션 제어에 대해 별도의 신경을 쓸 필요가 없습니다.
  • 일반적으로 간단한 비즈니스 로직과 CRUD 작업에서는 JpaRepository의 트랜잭션 처리가 충분합니다.
• EntityManager:
  • 직접 트랜잭션을 제어할 수 있어 트랜잭션 경계를 명확히 정의하거나, 여러 엔티티에 대한 복잡한 조작을 관리할 수 있습니다.
  • EntityManager는 트랜잭션이 시작되었는지, 종료되었는지에 대한 세부 제어가 가능하므로 트랜잭션이 중요한 로직을 구현할 때 유용합니다.

5. 특정 사용 시나리오

• JpaRepository 사용이 적합한 경우:
  • 기본적인 CRUD 작업과 페이징, 정렬 기능을 간편하게 사용하고 싶을 때.
  • 데이터를 단순히 조회하고, 저장하고, 업데이트하고, 삭제하는 작업이 주된 작업일 때.
  • 데이터 접근 계층의 반복적인 코드를 줄이고, 비즈니스 로직에 더 집중하고 싶을 때.
  • 메소드 이름을 통한 조건 쿼리 사용으로 빠르게 개발하고 싶을 때.
• EntityManager 사용이 적합한 경우:
  • 복잡한 커스텀 쿼리가 필요하거나 JPQL 또는 네이티브 쿼리를 직접 작성해야 할 때.
  • 영속성 컨텍스트의 제어가 필요하고, 엔티티의 상태 변화를 명시적으로 관리해야 할 때.
  • 여러 데이터 소스나 분산 트랜잭션이 필요한 복잡한 비즈니스 로직을 처리해야 할 때.
  • 특정 엔티티에 대한 미세한 영속성 관리가 필요하거나, 직접적인 상태 제어(persist, detach, merge 등)가 필요한 경우.