🔙뒤로가기

@RestController 어노테이션

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Controller;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {

	@AliasFor(annotation = Controller.class)
	String value() default "";

}

@Controller와 @ResponsBody를 합친 것이다.

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

package jpabook2.jpashop2.domain.api;

import jpabook2.jpashop2.domain.Member;
import jpabook2.jpashop2.domain.service.MemberService;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

@RestController
@RequiredArgsConstructor
public class MemberApiController {
    private final MemberService memberService;
    /*
    등록 V1 : 요청 값으로 Member 엔티티를 직접 받는다.
     */
    @PostMapping("/api/v1/members")
    public CreateMemberResponse saveMemberV1(@RequestBody @Valid Member member){
        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의 문제점

1. 엔티티와 API가 1:1로 매핑된 상태 ⇒ 엔티티 스펙 변경 시 API의 스펙 자체가 바뀌어버린다.
2. 엔티티의 코드가 지저분해짐 ⇒ 엔티티에 프레젠테이션 계층을 위한 로직이 추가된다. ⇒ 엔티티에 @NotEmpty 등 API 검증을 위한 로직이 추가된다.
3. 하나의 엔티티에 모든 API를 위한 스펙을 담을 수는 없다. ⇒ 실무에서는 회원 엔티티를 위한 API만 해도 다양하게 만들어짐
4. 엔티티는 파라미터로 무엇이 넘어올지 모른다. ⇒ 개발자 입장에서는 API 스펙 명세를 까보지 않는 한 어느 데이터까지 넘어오는지 판단할 수가 없다.

결론

엔티티를 파라미터로 받지도 말고, 외부에 노출시키지도 말자.

해결책

• 엔티티 대신 API 요청 스펙에 맞는 별도의 DTO를 만들어 파라미터로 받는다.

V2 회원 등록 API - 엔티티 대신 DTO를 RequestBody에 매핑

/*
등록 V2 : 요청 값으로 Member 엔티티 대신 별도의 DTO를 받는다.
*/
@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;
    }

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