티스토리 뷰
레포지토리 인터페이스를 만들기
인터페이스 선언 방법과, 기본적인 CRUD 기능을 자동으로 제공받기 위한 JpaRepository 상속 구조를 이해한다.
JpaRepository의 역할과 계층 구조 이해
JpaRepository의 상속 계층(Repository → CrudRepository → PagingAndSortingRepository → JpaRepository)과 각 인터페이스의 역할을 이해한다.
스프링이 레포지토리 구현체를 자동으로 생성하는 개념 이해
스프링이 JpaRepository 인터페이스의 구현체를 런타임 시에 자동으로 생성하여 제공하는 방식에 대해 설명할 수 있다.
PostRepository
package com.example.demo._domain.blog.repository;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
import com.example.demo._domain.blog.entity.Article;
// C R U D
// @Repository <-- 생략 가능
// JpaRepository<T, ID> -> T는 엔티티 클래스, ID는 PK의 데이터 타입
public interface PostRepository extends JpaRepository<Article, Integer> {
// 기본적인 CRUD 기능을 자동으로 제공한다.
// 필요하다면 우리가 만들어 놓은 곳에 추가적인 쿼리나 메서드 정의 가능하다.
}
JpaRepository<T, ID>
첫 번째 타입 (Article) - T
- 엔티티 클래스를 넣어야 합니다. 이 클래스는 데이터베이스의 테이블과 연결되며, 데이터를 저장하거나 조회할 때 사용됩니다.
- 예를 들어, Article은 데이터베이스의 article 테이블과 연결되는 클래스입니다.
두 번째 타입 (Integer) - ID
- 해당 엔티티의 기본 키(Primary Key)의 데이터 타입을 넣습니다. 즉, 엔티티 클래스의 기본 키 필드(고유 ID)가 어떤 타입인지 지정합니다.
- 여기서는 Integer 타입의 기본 키(예: id 필드)가 있다고 가정합니다.
@Repository 어노테이션 생략 가능한 이유
@Repository 어노테이션은 Spring 에서 데이터 액세스 계층을 나타내는 데 사용됩니다.
PostRepository 인터페이스는 JpaRepository를 상속하고 있고, JpaRepository는 내부적으로 @Repository 어노테이션을 포함하고 있습니다. 즉, Spring Data JPA는 이 인터페이스를 스캔하고, 필요할 경우 이를 빈으로 등록할 때 자동으로 @Repository를 처리합니다.
따라서, PostRepository에 명시적으로 @Repository를 추가하지 않아도 Spring이 이를 인식하고 처리하므로 생략이 가능합니다.
레포지토리(Repository)
데이터베이스와 엔티티(데이터 클래스) 사이에서 데이터를 저장하고, 불러오고, 수정하고, 삭제하는 역할을 하는 도구
예를 들어, "사용자" 데이터를 저장하고 싶다면, 레포지토리를 사용하여 "사용자"를 데이터베이스에 저장할 수 있습니다. 또는 저장된 "사용자" 데이터를 레포지토리를 통해 불러오거나 삭제할 수 있습니다.
JpaRepository
스프링에서 제공하며, 우리가 따로 SQL(데이터베이스 쿼리)을 작성하지 않아도
데이터베이스와 쉽게 연결할 수 있도록 해주는 도구
우리가 자주 사용하는 기본 기능들을 미리 만들어 놓은 것입니다.
예를 들어, 데이터 저장, 조회, 수정, 삭제 같은 작업을 쉽게 할 수 있게 도와줍니다.
장점
- 간편한 사용: 복잡한 SQL을 쓰지 않고, 데이터를 쉽게 저장, 조회, 수정, 삭제할 수 있습니다.
- 확장 가능: 기본 기능 외에도 복잡한 쿼리나 검색 조건이 필요할 때는 쉽게 추가할 수 있습니다.
JpaRepository 계층 구조
JpaRepository 계층 구조
- Repository (최상위 인터페이스)
- Repository<T, ID>는 가장 상위에 있는 마커 인터페이스로, 이 인터페이스 자체에는 메서드가 정의되어 있지 않지만 스프링 데이터에서 모든 레포지토리 인터페이스의 루트가 됩니다.
- 모든 스프링 데이터 JPA 레포지토리는 이 인터페이스를 상속받고 있습니다.
- CrudRepository (기본 CRUD 기능 제공)
- CrudRepository<T, ID>는 CRUD(Create, Read, Update, Delete) 작업을 위한 기본 메서드를 제공하는 인터페이스입니다. 여기에 정의된 메서드는 아래와 같습니다:
- save(S entity) – 데이터를 저장 또는 업데이트
- findById(ID id) – 기본 키로 데이터를 조회
- findAll() – 모든 데이터를 조회
- deleteById(ID id) – 기본 키로 데이터를 삭제
- count() – 전체 데이터의 수를 반환
- CrudRepository<T, ID>는 CRUD(Create, Read, Update, Delete) 작업을 위한 기본 메서드를 제공하는 인터페이스입니다. 여기에 정의된 메서드는 아래와 같습니다:
- PagingAndSortingRepository (페이징 및 정렬 기능 추가)
- PagingAndSortingRepository<T, ID>는 페이징(Pagination)과 정렬(Sorting) 기능을 추가로 제공합니다. 이 인터페이스는 CrudRepository를 확장하며, 페이징과 정렬에 관련된 메서드가 추가됩니다:
- findAll(Sort sort) – 데이터를 특정 정렬 기준으로 조회
- findAll(Pageable pageable) – 데이터를 페이지 단위로 조회
- PagingAndSortingRepository<T, ID>는 페이징(Pagination)과 정렬(Sorting) 기능을 추가로 제공합니다. 이 인터페이스는 CrudRepository를 확장하며, 페이징과 정렬에 관련된 메서드가 추가됩니다:
- JpaRepository (추가 JPA 관련 기능 제공)
- JpaRepository<T, ID>는 PagingAndSortingRepository를 확장하며, JPA와 관련된 추가 기능을 제공합니다. 예를 들어, 배치 저장, 플러시(flush), 데이터 삭제와 같은 JPA에서 자주 사용하는 기능이 추가됩니다:
- flush() – 영속성 컨텍스트의 변경 내용을 데이터베이스에 반영
- saveAllAndFlush(Iterable<S> entities) – 여러 엔티티를 저장하고 바로 플러시
- deleteAllInBatch() – 데이터를 일괄 삭제
- JpaRepository<T, ID>는 PagingAndSortingRepository를 확장하며, JPA와 관련된 추가 기능을 제공합니다. 예를 들어, 배치 저장, 플러시(flush), 데이터 삭제와 같은 JPA에서 자주 사용하는 기능이 추가됩니다:
마커 인터페이스
아무 메서드도 가지지 않는 인터페이스
단순히 특정 클래스가 해당 인터페이스를 구현했는지를 표시하기 위한 역할을 합니다.
인터페이스에 아무런 기능이나 행동을 정의하지 않으면서, 그 인터페이스를 구현한 클래스가 특정 속성이나 능력을 가지고 있음을 나타냅니다.
동작 원리 (구현체는 스프링이 자동 생성)
PostRepository 인터페이스는 스프링 데이터 JPA에서 제공하는 JpaRepository를 상속받는 인터페이스입니다.
이 경우, 따로 구현 클래스를 작성하지 않아도 스프링이 자동으로 구현체를 생성해 주고, 필요한 기능을 제공하게 됩니다.
즉, 기본적인 CRUD(Create, Read, Update, Delete) 작업을 스프링이 자동으로 처리해 줍니다.
JpaRepository 인터페이스를 상속 받으면 스프링은 자동으로 레포지토리의 구현체를 생성합니다.
스프링이 런타임 시에 동적으로 이 인터페이스의 구현 클래스를 만들어주고, 이를 스프링의 빈(Bean)으로 등록합니다.
그러면 이 레포지토리를 서비스나 컨트롤러에서 주입받아(DI) 사용할 수 있습니다.
CRUD 예시 코드
@Service
public class TempService {
@Autowired
private TempRepository tempRepository; // 의존성 주입
public void createPost(Article article) {
tempRepository.save(article); // 기본적인 저장 기능 사용
}
public Article getPost(Integer id) {
return tempRepository.findById(id).orElse(null); // 기본적인 조회 기능 사용
}
public void deletePost(Integer id) {
tempRepository.deleteById(id); // 기본적인 삭제 기능 사용
}
}
'JPA' 카테고리의 다른 글
글 목록 조회 API 만들기 (0) | 2024.10.02 |
---|---|
블로그 서비스, 컨트롤러 만들기 (0) | 2024.10.02 |
블로그 엔티티 만들기 (0) | 2024.10.01 |
블로그 프로젝트 만들기 (4) | 2024.10.01 |
단방향, 양방향 매핑 (0) | 2024.09.30 |