[JPA로 REST API 만들기] Module 과 Model 생성

모듈이란?

우리의 Todo list 는 기능이 단순히 todo 를 CRUD 하는 것 뿐이지만, 만약 여러 회원을 관리하는 기능까지 추가했다면 한 패키지 안에 개발하는 건 비효율적이다. 따라서 기능별로 모듈을 나눈다. 모듈은 이렇게 기능별, 역할별로 분리한 것을 말한다. 각각의 모델은 각각의 컨트롤러, 서비스, 모델을 가질 수 있다.

 

todo 모듈

패키지 안에 todo 패키지를 생성해준다.

 

Todo list 에서 비즈니스 모델은 바로 todo item 이다. 할일을 적는 텍스트 title 과 완료했는지 아닌지 체크하는 done. 그리고 각 item 을 구분하는 id 로 구성되어 있다. 이 비즈니스 모델을 처리하기 위한 클래스들을 생성해줄 것이다. 패키지 아래에 model 패키지를 생성해준다.

/model/TodoItem.java

todo list 에서 처리할 비즈니스 모델이다. 

package com.todolist.tutorial.todo.model;

import lombok.*;

@Getter @Setter         //getter, setter 메소드
@NoArgsConstructor      //인자 없는 기본 생성자
@AllArgsConstructor     //모든 인자 가지는 생성자
@Builder                //빌더 패턴으로 생성하게 해줌.
public class TodoItem {
    private Long id;
    private String title;
    private boolean done;
}

loombook 어노테이션 덕분에 아래처럼 class 내부에 구현하지 않은 메소드들을 쓸 수 있게 해준다.

 

Request 와 Response 는 각각 http 요청/응답에 따라 주고받는 데이터다. TodoItem 자체를 응답하면 비즈니스 로직을 공개하는 것이므로 지양해야 한다. 또 Request 데이터가 TodoItem 과 형태가 일치하지 않는 경우도 있으므로 한번 더 감싸주는 게 좋다. 이렇게 데이터 간 교환을 위해 비즈니스 로직을 포함시키지 않는 객체를 DTO(Data Transfer Object) 라고 한다.

 

/model/TodoItemRequest.java

이 프로젝트에서는 Request 에서 딱히 처리할 내용이 없으므로 TodoItem 를 상속해주면 된다.

package com.todolist.tutorial.todo.model;

public class TodoItemRequest extends TodoItem {
}

 

/model/ApiResponse.java

TodoItem Response 만 만들어도 되지만, 나중에 user 등이 추가된다면 각각에 대한 Response 객체를 만들어줘야 한다. 그때마다 매번 필드에 error 를 넣어주는 건 비효율적이므로 공통 속성을 상속받을 수 있는 부모클래스 틀을 생성해준다.

package com.todolist.tutorial.todo.model;

import lombok.*;

@Getter @Setter
@NoArgsConstructor
public class ApiResponse<T> {
    private T data;
    private String errors;
}

 

/model/TodoItemResponse.java

단일 todo item 을 응답할 때 한번 더 감쌀 수 있는 TodoItemResponse 객체다. 보안에 더 신경쓴다면 파라미터에 TodoItem 을 그대로 넣기보다 멤버 변수들을 직접 하나하나 넣기도 하지만 튜토리얼이니 통째로 넣었다. 

package com.todolist.tutorial.todo.model;

import lombok.Builder;

public class TodoItemResponse extends ApiResponse<TodoItem> {
    @Builder
    public TodoItemResponse(final TodoItem todoItem, final String errors) {
        this.setData(todoItem);
        this.setErrors(errors);
    }
}

 

/model/TodoItemListResponse.java

여러 개의 todo item 을 응답할 때 감싸는 response 객체다.

package com.todolist.tutorial.todo.model;

import lombok.Builder;

import java.util.List;

public class TodoItemListResponse extends ApiResponse<List<TodoItem>> {
    @Builder
    public TodoItemListResponse(final List<TodoItem> todoItems, final String errors) {
        this.setData(todoItems);
        this.setErrors(errors);
    }
}

 

/model/TodoItemAdapter.java

TodoItem <-> TodoItemResponse, TodoItemList -> TodoItemListResponse 로 바꿔주는 어뎁터를 생성한다.

package com.todolist.tutorial.todo.model;

import java.util.List;

public class TodoItemAdapter {
    //todoITemRequest -> todoItem
    public static TodoItem todoItem(final TodoItemRequest todoItemRequest) {
        if(todoItemRequest == null) return null;

        return TodoItem.builder().title(todoItemRequest.getTitle()).done(todoItemRequest.isDone()).build();
    }

    //todoItem+error message -> todoItemResponse
    public static TodoItemResponse todoItemResponse(final TodoItem todoItem, final String errors) {
        return TodoItemResponse.builder().todoItem(todoItem).errors(errors).build();
    }

    //todoItemList+error message -> todoItemListResponse
    public static TodoItemListResponse todoItemListResponse(final List<TodoItem> todoItems, final String errors) {
        return TodoItemListResponse.builder().todoItems(todoItems).errors(errors).build();
    }
}