JPA 2 - 회원 조회 API

회원 조회 API

회원조회 V1: 응답 값으로 엔티티를 직접 외부에 노출

@GetMapping("/api/v1/members")
public List<Member> membersV1() {
    return memberService.findMembers();
}

• 문제점
  • 엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
  • 기본적으로 엔티티의 모든 값이 노출된다.
  • 응답 스펙을 맞추기 위해 로직이 추가된다. (@JsonIgnore, 별도의 뷰 로직 등등)
    • 예 : 회원 정보에 대한 내용만 원하는데, Member 엔티티에는 orders에 대한 정보도 있기 때문에 주문 내역이 있으면 주문 내역도 응답해서 주문 내역에 대한 정보는 응답하지 않도록 한 경우
      • 다른 API에서는 주문 내역만 응답을 원할 때는 곤란해진다.
  • 실무에서는 같은 엔티티에 대해 API가 용도에 따라 다양하게 만들어지는데, 한 엔티티에 각각의 API를 위한 프레젠테이션 응답 로직을 담기는 어렵다.
  • 엔티티가 변경되면 API 스펙이 변한다.
    • name -> username
  • 추가로 컬렉션을 직접 반환하면 항후 API 스펙을 변경하기 어렵다.(별도의 Result 클래스 생성으로 해결)
• 결론
  • API 응답 스펙에 맞추어 별도의 DTO를 반환한다.

엔티티를 외부에 노출하지 말자. 실무에서는 member 엔티티의 데이터가 필요한 API가 계속 증가하게 된다. 어떤 API는 name 필드가 필요하지만, 어떤 API는 name 필드가 필요없을 수 있다. 결론적으로 엔티티 대신에 API 스펙에 맞는 별도의 DTO를 노출해야 한다.

회원조회 V2: 응답 값으로 엔티티가 아닌 별도의 DTO 사용

    @GetMapping("/api/v2/members")
    public Result membersV2() {
        List<Member> findMembers = memberService.findMembers();

        // findMembers 중 이름만 빼서 MemberDto에 넣어줌.
        List<MemberDto> collect = findMembers.stream()
                .map(m -> new MemberDto(m.getName()))
                .collect(Collectors.toList());

        return new Result(collect);
    }

    @Data
    @AllArgsConstructor
    static class Result<T> { // 제네릭 타입
        private T data;
    }
    @Data
    @AllArgsConstructor
    static class MemberDto {
        private String name;
    }

• 엔티티를 DTO로 변환해서 반환한다.
• 엔티티가 변해도 API 스펙이 변경되지 않는다.
• 추가로 Result 클래스로 컬렉션을 감싸서 향후 필요한 필드를 추가할 수 있다.

스펙 변경 요구로 인해서 count 필드 추가

@GetMapping("/api/v2/members")
public Result membersV2() {
    List<Member> findMembers = memberService.findMembers();

    // findMembers 중 이름만 빼서 MemberDto에 넣어줌.
    List<MemberDto> collect = findMembers.stream()
            .map(m -> new MemberDto(m.getName()))
            .collect(Collectors.toList());

    return new Result(collect.size(), collect);
}

@Data
@AllArgsConstructor
static class Result<T> { // 제네릭 타입
    private int count;
    private T data;
}

인프런 김영한 지식공유자님 강의 - 실전! 스프링 부트와 JPA 활용2 - API 개발과 성능 최적화