[스프링 활용2] 회원 조회 API

참고 : [실전! 스프링 부트와 JPA 활용2 - API 개발과 성능 최적화] - 김영한

---

application.yml 수정

  jpa:
    hibernate:
      ddl-auto: none 
    properties:
      hibernate:
        format_sql: true

• 한번 넣은 데이터를 계속 사용하기 위해서 ddl-auto : none으로 변경

  회원 데이터 넣기

  
  테스트용 회원을 넣어준다.

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

package jpabook.jpashop.api;
 @RestController
 @RequiredArgsConstructor
 public class MemberApiController {
     private final MemberService memberService;
/**
* 조회 V1: 응답 값으로 엔티티를 직접 외부에 노출한다.
* 문제점
* - 엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
* - 기본적으로 엔티티의 모든 값이 노출된다.
* - 응답 스펙을 맞추기 위해 로직이 추가된다. (@JsonIgnore, 별도의 뷰 로직 등등)
* - 실무에서는 같은 엔티티에 대해 API가 용도에 따라 다양하게 만들어지는데, 한 엔티티에 각각의
API를 위한 프레젠테이션 응답 로직을 담기는 어렵다.
* - 엔티티가 변경되면 API 스펙이 변한다.
* - 추가로 컬렉션을 직접 반환하면 항후 API 스펙을 변경하기 어렵다.(별도의 Result 클래스 생성으
로 해결)
* 결론
* - API 응답 스펙에 맞추어 별도의 DTO를 반환한다.
*/
//조회 V1: 안 좋은 버전, 모든 엔티티가 노출, @JsonIgnore -> 이건 정말 최악, api가 이거 하나 인가! 화면에 종속적이지 마라!
     @GetMapping("/api/v1/members")
     public List<Member> membersV1() {
         return memberService.findMembers();
     }
   }

---

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

@GetMapping("/api/v2/members")
    public Result memberV2(){
        List<Member> findMembers=memberService.findMembers();
        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 클래스로 컬렉션을 감싸서 향후 필요한 필드를 추가할 수 있다.

• 엔티티를 DTO로 변환:

  • memberService.findMembers()를 호출하여 데이터베이스에서 Member 엔티티 목록을 조회
  • 조회된 엔티티 목록을 stream을 사용하여 MemberDto로 변환. 여기서 MemberDto는 엔티티의 필요한 필드만 포함.

• Result 클래스로 컬렉션 감싸기:

  • 변환된 MemberDto 목록을 Result 클래스로 감싸서 반환.
  • Result 클래스는 제네릭을 사용하여 어떤 타입의 데이터도 감쌀 수 있음. 현재는 List를 감싸고 있음.
  • 이렇게 하면 나중에 응답에 추가 필드를 쉽게 추가 가능.

실행결과 Result 객체로 감싸진 MemberDto 목록이 반환된 것을 확인할 수 있다.

주의 ! : 절대 엔티티를 외부에 노출하지 않아야한다. -> DTO 사용하자!