042 | DTO with HTTP Request & Response

🎈 DTO(Data Trasfer Object)

• 마틴 파울러(Martin Fowler)가 ‘Patterns of Enterprise Application Architecture’ 라는 책에서 처음 소개한 엔터프라이즈 애플리케이션 아키텍처 패턴의 하나이다.
• 데이터를 전송하기 위한 객체
  주로 클라이언트에서 서버 쪽으로 전송하는 요청 데이터를 전달 받을 때, 서버에서 클라이언트 쪽으로 전송하는 응답 데이터를 전송하기 위한 용도로 사용된다.
• 데이터 전송이 이루어지는 구간
  • 클라이언트 → 서버: 요청(request) 데이터
  • 서버 → 클라이언트: 응답(response) 데이터
• DTO 클래스: 요청 데이터를 하나의 객체로 전달 받는 역할

🎈 DTO가 필요한 이유

• 클라이언트의 Request Body를 하나의 객체로 모두 전달 받을 수 있음 → 코드가 간결해진다.

//회원 정보 저장을 위해 postMember에 @RequestParam 사용

@RestController
@RequestMapping("/v1/members")
public class MemberController {
    @PostMapping
    public ResponseEntity postMember(@RequestParam("email") String email,
                                     @RequestParam("name") String name,
                                     @RequestParam("phone") String phone) {
        Map<String, String> map = new HashMap<>();
        map.put("email", email);
        map.put("name", name);
        map.put("phone", phone);

        return new ResponseEntity<Map>(map, HttpStatus.CREATED);
    }
		
		...
}

// DTO 적용
// - @RequestParam을 통해 전달 받은 요청 데이터들을 Map에 추가하는 로직이 사라짐
// - MemberDto 객체를 ResponseEntity 클래스의 생성자 파라미터로 전달하도록 변경

@RestController
@RequestMapping("/v1/members")
public class MemberController {
    @PostMapping
    public ResponseEntity postMember(MemberDto memberDto) {
        return new ResponseEntity<MemberDto>(memberDto, HttpStatus.CREATED);
    }
		
		...
}

 

🎈 데이터 유효성(Validation) 검증의 단순화

• 유효성(Validation) 검증: 서버에서 유효한 데이터를 전달받기 위해 데이터를 검증하는 것
• HTTP 요청을 전달 받는 핸들러 메서드의 주 목적
  • 핸들러 메서드 내부에 있는 유효성 검사 로직을 외부에 작성 → 코드가 간결
  • 요청을 전달받는 것이기 때문에 최대한 간결하게 작성

// 레거시 코드에서 이메일 검증하기

if (!email.matches("^[a-zA-Z0-9_!#$%&'\\*+/=?{|}~^.-]+@[a-zA-Z0-9.-]+$")) {
    throw new InvalidParameterException();
}

// Using DTO Class

public class MemberDto {
    @Email
    private String email;
    private String name;
    private String phone;

    // + getter / setter
}

// Handler Method with DTO

@RestController
@RequestMapping("/v1/members")
public class MemberController {
    @PostMapping
    public ResponseEntity postMember(@Valid MemberDto memberDto) {
        return new ResponseEntity<MemberDto>(memberDto, HttpStatus.CREATED);
    }

		...
}

🎈 HTTP 요청/응답 데이터에 DTO 적용하기

HTTP Request Body != JSON

• 이전까지 사용한 클라이언트에서 전달하는 요청 데이터: x-www-form-urlencoded
• 요청 데이터 중 바디에 해당되는 데이터: Request Body

HTTP Request Body == JSON

DTO 클래스 적용을 위한 코드 리팩토링 절차

• 정보를 전달 받을 DTO 클래스 생성
• 클라이언트 쪽에서 전달하는 요청 데이터를 @RequestParam 애너테이션으로 전달 받는 핸들러 메서드 찾기
• @RequestParam 쪽 코드를 DTO 클래스의 객체로 수정
• Map 객체로 작성되어 있는 Response Body를 DTO 클래스의 객체로 변경

🎈 more

• Response Body를 JSON 형식으로 전달하기 위해서는 @ResponseBody 애너테이션을 메서드 앞에 붙여 주어야하지만 ResponseEntity 객체를 리턴 값으로 사용할 경우 @ResponseBody를 생략할 수 있다.
• 클라이언트 쪽에서 JSON 형식의 데이터를 서버 쪽으로 전송하면 서버 쪽의 웹 애플리케이션은 전달 받은 JSON 형식의 데이터를 DTO 같은 Java의 객체로 변환하는데 이를 역직렬화(Deserialization)이라고 한다.
  • JSON → DTO: 역직렬화(Deserialization)
• 서버 쪽에서 클라이언트에게 응답 데이터를 전송하기 위해서 DTO 같은 Java의 객체를 JSON 형식으로 변환하는 것을 직렬화(Serialization)라고 한다.
  • DTO → JSON: 직렬화(Serialization)