API 패키지 새로 구성
화면에 구성되어지는 정보와 API로 제공되는 정보는 서로 다르다 때문에 패키지를 두개로 나누는 경우가 많다.
회원 등록 API
V1 엔티티를 Request Body에 직접 매핑
•
V1 엔티티를 Request Body에 직접 매핑
◦
문제점
▪
엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
▪
엔티티에 API 검증을 위한 로직이 들어간다. (@NotEmpty 등등)
▪
실무에서는 회원 엔티티를 위한 API가 다양하게 만들어지는데, 한 엔티티에 각각의 API를 위한모든 요청 요구사항을 담기는 어렵다.
▪
엔티티가 변경되면 API 스펙이 변한다.→ 엔티티를 손대서 API 스팩이 변경하면서 사이드 이팩트가 발생 한다.
→ 해결방법 : API 요청 스펙에 맞추어 별도의 DTO를 파라미터로 받는다.
V2 엔티티 대신에 DTO를 RequestBody에 매핑
@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
@AllArgsConstructor
static class CreateMemberResponse {
private Long id;
}
Java
복사
•
CreateMemberRequest 를 Member 엔티티 대신에 RequestBody와 매핑한다.
•
엔티티와 프레젠테이션 계층을 위한 로직을 분리할 수 있다.
•
엔티티와 API 스펙을 명확하게 분리할 수 있다.
•
엔티티가 변해도 API 스펙이 변하지 않는다.
회원 수정 API
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;
@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;
}
}
Java
복사
회원 수정도 DTO를 요청 파라미터에 매핑
public class MemberService {
private final MemberRepository memberRepository;
@Transactional
public void update(Long id, String name) {
Member member = memberRepository.findOne(id);
member.setName(name);
}
}
Java
복사
업데이트 같은 경우 가급적 변경감지를 사용해야된다.
업데이트후 멤버를 반환 해도 되는데 애매해지는 것이 있다.
커맨드(변경성 업데이트)랑 쿼리(조회하는 쿼리)를 철저하게 분리하는게 좋다.
→ MemberService의 update를 리턴 받지않고 업데이트
→ Member findMember = memberService.findOne(id);로 다시조회
회원 조회 API
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;
@GetMapping("/api/v1/members")
public List<Member> membersV1() {
return memberService.findMembers();
}
@GetMapping("/api/v2/members")
public Result memberV2() {
List<Member> findMembers = memberService.findMembers();
List<MemberDto> memberDtos = findMembers.stream()
.map(m -> new MemberDto(m.getName()))
.collect(Collectors.toList());
return new Result(memberDtos);
}
@Data
@AllArgsConstructor
static class MemberDto {
private String name;
}
@Data
@AllArgsConstructor
static class Result<T> {
private T data;
}
}
Java
복사
@GetMapping("/api/v1/members")
public List<Member> membersV1() {
return memberService.findMembers();
}
Java
복사
조회 V1 : 응답 값으로 엔티티를 직접 외부에 노출한
•
문제점
◦
엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
◦
기본적으로 엔티티의 모든 값이 노출된다.
◦
응답 스펙을 맞추기 위해 로직이 추가된다. (@JsonIgnore, 별도의 뷰 로직 등등)
◦
실무에서는 같은 엔티티에 대해 API가 용도에 따라 다양하게 만들어지는데, 한 엔티티에 각각의
API를 위한 프레젠테이션 응답 로직을 담기는 어렵다.
◦
엔티티가 변경되면 API 스펙이 변한다.
◦
추가로 컬렉션을 직접 반환하면 항후 API 스펙을 변경하기 어렵다.(별도의 Result 클래스 생성으로
해결)
•
결론
◦
API 응답 스펙에 맞추어 별도의 DTO를 반환한다.
엔티티를 외부에 노출하지 마세요!
실무에서는 member 엔티티의 데이터가 필요한 API가 계속 증가하게 된다. 어떤 API는 name 필드가
필요하지만, 어떤 API는 name 필드가 필요없을 수 있다. 결론적으로 엔티티 대신에 API 스펙에 맞는
별도의 DTO를 노출해야 한다.
@GetMapping("/api/v2/members")
public Result memberV2() {
List<Member> findMembers = memberService.findMembers();
List<MemberDto> memberDtos = findMembers.stream()
.map(m -> new MemberDto(m.getName()))
.collect(Collectors.toList());
return new Result(memberDtos);
}
Java
복사
회원조회 V2: 응답 값으로 엔티티가 아닌 별도의 DTO 사용
•
엔티티를 DTO로 변환해서 반환한다.
•
엔티티가 변해도 API 스펙이 변경되지 않는다.
•
추가로 Result 클래스로 컬렉션을 감싸서 향후 필요한 필드를 추가할 수 있다.