1. JpaRepository와 상속 관계

• Repository

  • 역할: 마커 인터페이스로서, 실제 구현이 없습니다.
  • 사용 예:

  public interface MyRepository extends Repository<MyEntity, Long> {}
  

• CrudRepository

  • 역할: CRUD(Create, Read, Update, Delete) 기능을 제공합니다.
  • 메소드 예시: save(), findById(), findAll(), deleteById()
  • 사용 예:

  public interface MyCrudRepository extends CrudRepository<MyEntity, Long> {}
  

• PagingAndSortingRepository

  • 역할: 페이징 및 정렬 기능을 추가로 제공합니다.
  • 메소드 예시: findAll(Pageable pageable), findAll(Sort sort)
  • 사용 예:

  public interface MyPagingAndSortingRepository extends PagingAndSortingRepository<MyEntity, Long> {}
  

• ListCrudRepository, ListPagingAndSortingRepository

  • 역할: List 컬렉션에 특화된 CRUD 및 페이징/정렬 기능을 제공합니다.
  • 사용 예:

  public interface MyListCrudRepository extends ListCrudRepository<MyEntity, Long> {}
  

• QueryByExampleExecutor

  • 역할: Example 쿼리를 수행할 수 있는 메서드를 제공합니다.
  • 메소드 예시: findOne(Example<S> example), findAll(Example<S> example)
  • 사용 예:

  public interface MyQueryByExampleExecutor extends QueryByExampleExecutor<MyEntity> {}
  

2. 어노테이션에 대한 설명

• @NoRepositoryBean

  • 의미:
    • @NoRepositoryBean 어노테이션은 Spring Data JPA에서 특별한 용도로 사용된다.
    • 이 어노테이션은 인터페이스가 Spring Data JPA에 의해 자동으로 빈으로 등록되는 것을 방지하는 역할을 한다. 이해를 돕기 위해 예시 코드와 그림을 제공한다.
  • 예시 코드

  // BaseRepository.java
  @NoRepositoryBean
  public interface BaseRepository<T, ID extends Serializable> extends JpaRepository<T, ID> {
      // 공통으로 사용할 메서드 정의
  }
  
  // UserRepository.java
  @Repository
  public interface UserRepository extends BaseRepository<User, Long> {
      // User 도메인에 특화된 메서드 정의
  }
  
  

  • 설명

    1. BaseRepository 인터페이스에는 공통으로 사용할 메서드를 정의한다.
    2. @NoRepositoryBean 어노테이션을 BaseRepository에 붙여, 이 인터페이스가 빈으로 등록되지 않도록 한다.
    3. UserRepository는 BaseRepository를 상속받아 사용한다.
    4. UserRepository에는 @Repository 어노테이션이 붙어 있으므로, 이 인터페이스만 Spring 컨테이너에 빈으로 등록된다.

  • 그림 설명

    BaseRepository (Not a Bean)
            ^
            |
            |
   UserRepository (Bean)
  
  

  • 이렇게 하면 BaseRepository는 빈으로 등록되지 않고, UserRepository만 빈으로 등록되어 사용된다. 이를 통해 공통 로직을 재사용하면서도, Spring Data JPA의 자동 구성을 유지할 수 있다.
  • 주석 및 JavaDoc 예시

  /**
   * 공통 레포지토리 인터페이스
   * @NoRepositoryBean 어노테이션을 사용하여 빈으로 등록되지 않게 함
   */
  @NoRepositoryBean
  public interface BaseRepository<T, ID extends Serializable> extends JpaRepository<T, ID> {
      // ...
  }
  
  

• 이렇게 @NoRepositoryBean을 사용하면, 공통 로직을 가진 부모 레포지토리와 실제로 빈으로 등록되어야 하는 자식 레포지토리를 명확하게 구분할 수 있다.

• @Indexed

  • 의미: 이 어노테이션은 해당 엔터티가 검색 인덱스에 포함되어야 함을 나타냅니다.
  • 역할: 검색 성능을 향상시키기 위해 사용됩니다. 이 어노테이션을 사용하면, 해당 엔터티는 검색 인덱스에 추가되어 빠른 검색이 가능합니다.
  • 사용 예시: 검색이 빈번하게 발생하는 엔터티에 적용합니다.

  @Entity
  @Indexed
  public class MyEntity {
      // 필드와 메서드 정의
  }
  

• 다이어그램의 연결 관계

  • **@NoRepositoryBean**은 **Repository**와 **QueryByExampleExecutor**를 제외한 모든 인터페이스에 점선으로 연결되어 있다. 이는 이 어노테이션을 이러한 인터페이스에 적용할 수 있음을 의미한다.
  • **@Indexed**는 **Repository<T, ID>**에 점선으로 연결되어 있다. 이는 이 어노테이션을 레포지토리가 관리하는 엔티티에 적용할 수 있음을 의미한다.

3. JpaRepository의 구조와 동작 원리를 다이어그램으로 표현