스프링부트와 JPA활용2(API개발과 성능 최적화)1 - API개발 기본

(1) 회원 등록 API

• MemberApiCOntroller - 회원등록

package jpabook.jpashop.api;
import jpabook.jpashop.domain.Member;
import jpabook.jpashop.service.MemberService;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;
import javax.validation.Valid;
import java.util.List;
import java.util.stream.Collectors;

@RestController
@RequiredArgsConstructor
public class MemberApiController {

    private final MemberService memberService;

    /**
     * 회원 가입(생성) API
     */
    @PostMapping("/api/v1/members")
    public CreateMemberResponse saveMemberV1(@RequestBody @Valid Member member) {
        Long id = memberService.join(member);
        return new CreateMemberResponse(id);
    }

    @PostMapping("/api/v2/members")
    public CreateMemberResponse saveMemberV2(@RequestBody @Valid CreateMemberRequest request) {
        Member member = new Member();
        member.setName(request.getName());

        Long id = memberService.join(member);
        return new CreateMemberResponse(id);
    }

    @Data
    static class CreateMemberRequest {
        private String name;
    }

    @Data
    static class CreateMemberResponse {
        private Long id;

        public CreateMemberResponse(Long id) {
            this.id = id;
        }
    }
}

V1 엔티티를 Request Body에 직접 매핑

• 문제점
  : 엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
  : 엔티티에 API 검증을 위한 로직이 들어간다. (@NotEmpty 등등)
  : 실무에서는 회원 엔티티를 위한 API가 다양하게 만들어지는데, 한 엔티티에 각각의 API를 위한 모든 요청 요구사항을 담기는 어렵다.
  : 엔티티가 변경되면 API 스펙이 변한다.
• 결론
  -> API 요청 스펙에 맞추어 별도의 DTO를 파라미터로 받는다

V2 엔티티 대신에 DTO를 RequestBody에 매핑

: CreateMemberRequest 를 Member 엔티티 대신에 RequestBody와 매핑한다.
: 엔티티와 프레젠테이션 계층을 위한 로직을 분리할 수 있다.
: 엔티티와 API 스펙을 명확하게 분리할 수 있다.
: 엔티티가 변해도 API 스펙이 변하지 않는다.

(2) 회원 수정 API

• MemberApiController.java - 회원 수정

    /**
     * 회원 수정 API
     */
    @PutMapping("/api/v2/members/{id}")
    public UpdateMemberResponse updateMemberV2(
            @PathVariable("id") Long id,
            @RequestBody @Valid UpdateMemberRequest request) {

        memberService.update(id, request.getName());
        Member findMember = memberService.findOne(id);
        return new UpdateMemberResponse(findMember.getId(), findMember.getName());

    }

    @Data
    static class UpdateMemberRequest {
        private String name;
    }

    @Data
    @AllArgsConstructor
    static class UpdateMemberResponse {
        private Long id;
        private String name;
    }

회원 수정 API updateMemberV2 은 회원 정보를 부분 업데이트 한다. 여기서는 PUT 방식을 사용

• PUT: 전체 업데이트를 할 때 사용
• PATCH, POIST : 부분 업데이트시 사용

(3) 회원 조회 API

• MemberApiController.java - 회원 조회

package jpabook.jpashop.api;
@RestController
@RequiredArgsConstructor
public class MemberApiController {
 
 private final MemberService memberService;

 //조회 V1: 안 좋은 버전, 모든 엔티티가 노출, 
 @JsonIgnore -> 이건 정말 최악, api가 이거
하나인가! 화면에 종속적이지 마라!

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

    @GetMapping("/api/v2/members")
    public Result membersV2() {
        List<Member> findMembers = memberService.findMembers();
        List<MemberDto> collect = findMembers.stream()
                .map(m -> new MemberDto(m.getName()))
                .collect(Collectors.toList());

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

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

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

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

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