Spring Data JPA에서 findAll 메소드의 반환 타입 : List vs Optional

Spring Data JPA를 사용할 때, 모든 엔티티를 조회하는 findeAll 메소드를 자주 사용하게 되는데요.
이때, 반환 타입을 어떻게 설정해야 할까요?
List를 사용해야할 지 아니면 Optional을 사용해야할지 헷갈리 때가 있는데요.
이번에는 위와 같은 내용에 대해 알아보겠습니다!

 

---

findAll 메소드의 변환 타입

Spring Data JPA에서 findAll 메소드는 모든 엔티티를 조회합니다. findAll 메소드를 호출하면 데이터베이스에서 해당 엔티티 타입의 모든 레코드를 가져와 리스트로 변환합니다.

다음은 JpaRepository를 상속받는 리포지토리 인터페이스의 예제입니다.

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
import java.util.List;

@Repository
public interface MyEntityRepository extends JpaRepository<MyEntity, Long> {
    List<MyEntity> findAll();
}

위 코드에서 볼 수 있듯이, findAll 메소드는 List<MyEntity>를 반환합니다. 이는 finadAll 메소드가 항상 리스트를 반환하기 때문입니다.
만약 엔티티가 하나도 없다면, 빈 리스트를 반환합니다.

 

왜 Optional이 아닌 List인가?

optional은 주로 단일 엔티티를 조회할 때 사용합니다. 예를 들어, findById 메소드는 특정 ID에 해당하는 엔티티가 존재할 수 도 있고 존재하지 않을 수도 있기 때문에 Optional을 반환합니다.

Optinal<MyEntity> findById(Long id);

반면에, findAll 메소드는 모든 엔티티를 조회합니다. 결과가 없을 때 빈 리스트를 반환하기 때문에 Optional로 감싸지 않습니다.
Optional은 주로 값이 없을 수 있는 상황에서 NullPointerException을 방지하고 의도를 명확히 하기 위해 사용됩니다.
findAll 메소드의 경우 빈 리스트를 반환하는 것이 자연스럽과 일관된 방식입니다.

 

findAll 메소드 사용하기

다음은 서비스 계층에서 findAll 메소드를 사용하는 예제입니다.

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

import java.util.List;

@Service
public class MyEntityService {

    @Autowired
    private MyEntityRepository myEntityRepository;

    public List<MyEntity> getAllEntities() {
        return myEntityRepository.findAll();
    }
}

위 코드에서 getAllEntities 메소드는 리포지토리의 findAll 메소드를 호출하여 모든 엔티티를 리스트로 반환합니다.
이 리스트는 비어 있을 수도 있고, 여러 엔티티를 포함하고 있을 수도 있습니다.

 

결론

Spirng Data JPA에서 findAll 메소드를 사용할 때는 반환 타입을 List로 설정해야 합니다.
findAll 메소드는 빈 리스트를 반환 할 수 있기 때문에 Optional을 사용할 필요가 없습니다.
반면에, 단일 엔티티를 조회할 때는 Optional을 사용하여 존재하지 않을 수 있는 엔티티를 처리할 수 있습니다.

 

reference

https://github.com/spring-projects/spring-data-jpa

GitHub - spring-projects/spring-data-jpa: Simplifies the development of creating a JPA-based data access layer.

 

---

이 포스트가 도움이 되셨으면 좋겠습니다! 추가적인 질문이나 주제가 있다면 언제든지 댓글로 남겨주세요 :)