[Spring] DTO

DTO?

DTO란?

DTO(Data Transfer Object)의 약자로 마틴파울러가 소개한 애플리케이션 아키텍처 패턴중의 하나이다. DTO는 프로세스간의 데이터를 전달하는 용도의 객체이다. 

 

 

DTO가 필요한 이유

코드의 간결성

DTO를 사용하게 되면 코드가 간결해진다. 예를 들어 회원정보를 @RequestParam을 통해 이메일, 이름, 주소 등의 정보를 받는다고 생각해보자. 그럼 컨트롤러의 해당 메서드에 받으려는 정보의 숫자만큼 @RequestParam이 필요할것이다. 하지만 Dto를 적용하게된다면? 

//DTO 적용전

@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);

 //DTO적용후
 
 @PostMapping
    public ResponseEntity postMember(MemberDto memberDto) {
        return new ResponseEntity<MemberDto>(memberDto, HttpStatus.CREATED);
    }

Dto클래스를 통해 요청데이터를 하나의 객체로 전달받아 컨트롤러의 코드가 훨씬 깔끔해졌다.

 

유효성(Validation) 검증

상단의 DTO가 적용되지 않은 코드에 유효성 검증이 적용되려면 if문등을 사용하여 컨트롤러 내부에서 검증이 진행되야한다. 정규표현식을 사용하여 검증을 진행한다고 해도 로직이 핸들러 메서드 내부에서 직접적으로 포함되어 코드가 복잡해진다. 핸들러 메서드는 HTTP요청을 전달받는 것이 주목적이므로 이러한 로직은 다른곳에 구성되는것이 깔끔한 코드이다. 이러한 유효성 검증에 대한 로직을 DTO에게 맡기는 방법을 사용할수있다.

• @NotBlank : 정보가 비어있는지를 검증 , null, 공백, 스페이스 값을 허용하지않음
• @Email : 유효한 이메일 주소인지를 검증
• @Pattern(regexp = "") : 정규표현식(Regular Expression)을 매치시켜 유효한지 검증

//컨트롤러

@RestController
@RequestMapping("/v1/members")
@Validated
public class MemberController {
		...

    @PatchMapping("/{member-id}")
    public ResponseEntity patchMember(@PathVariable("member-id") @Min(1) long memberId,
                                    @Valid @RequestBody MemberPatchDto memberPatchDto) {
                                    
                                    ...
    }
}

//DTO

@Getter
@Setter
public class MemberPostDto {
    @NotBlank
    @Email
    private String email;

    @NotBlank(message = "공백이 아니여야합니다.")
    private String name;

    @Pattern(regexp = "^010-\\d{3,4}-\\d{4}$")
    private String phone;
    }

위에서 보다시피 컨트롤러에 @Valid 애너테이션만 추가해주면 유효성검증에 대한 부분은 DTO에서 처리를 하게된다. 만약 컨트롤러에서 @Min() 등의 유효성검증 애너테이션이 필요한경우 클래스에 @Validated를 붙여줘야한다.

 

[ref. Jakarta Bean Validation]

 

원하는 정보만 전달

예를들어 Member라는 객체가 id, name, password의 값을 가지고 있을때 password의 경우에는 클라이언트의 요청에 그대로 전달되면 안된다. 이런경우 Client에게 노출해도 되는 정보만 모아 DTO로 구성하면 해결할수있다.

public class Member {

    private String id;
    private String name;
    private String password;
    
    ...
}

public class MemberDTO {
    private String name;
    
    ...
}

서비스계층과 데이터엑세스 계층에서는 Member 객체로 데이터를 전달하고, 이를 컨트롤러에서 DTO객체로 매핑하여 Client에게 리턴하면 Client에서 접근할수있는값은 Name뿐이다.