JPA2 - API 개발 기본

인프런 강의
🔗 실전! 스프링 부트와 JPA 활용2 - API 개발과 성능 최적화

🖇️API 개발

@RestController 사용

• @Controller 어노테이션과 @ResponseBody 어노테이션 포함

등록 V1 - 엔티티를 RequestBody에 직접 매핑

@PostMapping("/api/v1/members")
public CreateMemberResponse saveMemberV1(@RequestBody @Valid Member member){
        Long id = memberService.join(member);
        return new CreateMemberResponse(id);
}
@Data
static class CreateMemberResponse{
    private Long id;
    public CreateMemberResponse(Long id){
        this.id = id;
    }
}

🚨문제점(파라미터로 엔티티를 받을 경우)
1. 엔티티에 프레젠테이션 계층을 위한 로직과 검증(@NotEmpty)등 로직 추가됨
2. 한 엔티티에 다양한 요구사항 포함에 어려과 동시에 엔티티 변경 시, 요청된 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;
}

1. 엔티티와 프레젠테이션 계층을 위한 로직 분리가능
2. 엔티티와 API스펙 명확하게 분리 가능 및 엔티티 변형에도 API 스펙은 그대로 유지

💡 실무에서는 엔티티를 API 스펙에 노출하면 안된다 !

데이터베이스 설정 변경 확인

  jpa:
    hibernate:
      ddl-auto: none

수정 V2

@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
@AllArgsConstructor
static class UpdateMemberResponse{
    private Long id;
    private String name;
}

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

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

🚨문제점
1.기본적으로 엔티티의 모든 값 노출
2. 응답 스펙을 맞추기 위해 로직 추가 (@JsonIgnore 등)
3. 추가로 컬렉션을 직접 반환하면 항후 API 스펙을 변경하기 어려움(별도의 Result 클래스 생성으로 해결)

조회 V2 - 엔티티 아닌 별도의 DTO 사용

@GetMapping("/api/v2/members")
    public Result membersV2() {
        List<Member> findMembers = memberService.findMembers();
        //엔티티 -> DTO 변환
        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;
}

=> 엔티티가 변해도 API 스펙 변경 X

엔티티를 외부에 노출하지 않기

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