공통프로젝트 리팩토링 (2) - DTO

 

처음에는 이너 클래스로 DTO를 관리했는데, 코드의 중복이 전혀 줄어들지 않고 재사용이 불가능해서 정말 파일만 줄어든 것 같다. 그래서 클래스를 분리하기로 결정했다.

 

1. LectureRequestDTO

(1) 기존 코드 및 수정할 부분

@Data
@Schema(description = "강의 개설/조회/수정/삭제 시 입력받는 양식")
@Getter
public class LectureRequest {

    @Data
    @NoArgsConstructor
    public static class LectureCreateForm {
        // 강의 개설 시 입력받는 폼 양식


        private Integer userId; // 강의 개설자의 회원번호
        @NotNull
        private String title;
        @NotNull
        private String description;
        @NotNull
        private LocalDate startDate;
        @NotNull
        private LocalDate endDate;
        @NotNull
        private ArrayList<SessionRequest.SessionCreateForm> lectureTime;

        @Builder
        public LectureCreateForm(Integer userId, String title, String description, LocalDate startDate, LocalDate endDate, ArrayList<SessionRequest.SessionCreateForm> lectureTime){
            this.userId = userId;
            this.title = title;
            this.description = description;
            this.startDate = startDate;
            this.endDate = endDate;
            this.lectureTime = lectureTime;
        }

        public Lecture toEntity(User user){
            return Lecture.builder()
                    .user(user)
                    .title(title)
                    .description(description)
                    .startDate(startDate)
                    .endDate(endDate)
                    .lectureTime(lectureTime.toString())
                    .build();
        }

    }

    @Data
    @NoArgsConstructor
    public static class LectureUpdateForm {
        // 강의 수정 시 입력받는 폼 양식
        @NotNull
        private String content;
        @NotNull
        private LocalDate startDate;
        @NotNull
        private LocalDate endDate;
        @NotNull
        private ArrayList<SessionRequest.SessionCreateForm> lectureTime;

        @Builder
        public LectureUpdateForm(String content, LocalDate startDate, LocalDate endDate, ArrayList<SessionRequest.SessionCreateForm> lectureTime){
            this.content = content;
            this.startDate = startDate;
            this.endDate = endDate;
            this.lectureTime = lectureTime;
        }

    }

    // Read, Delete는 URL에 lectureID가 포함되어있음 => 따로 requestDto 만들 필요 X

}

 

👉@Data 애노테이션과 @Getter 애노테이션의 중복

👉불필요한 주석

👉제약조건에 맞지 않는 검증 어노테이션

👉열려있는 생성자

👉기존 규약에 맞지 않는 필드명(description)

 

엔티티에서는 필드명을 content에서 description으로 수정했는데, 생각해보니 DTO는 필드명이 곧 프론트와의 규약이라 함부로 수정할 수가 없었다. 그래서 DTO는 다시 content로 변경하기로 결정했다.

이렇게 되면 그냥 Entity도 content라는 필드명으로 통일시키는게 좋을까? 고민해봐야겠다.

 

(2) 수정한 부분

 

// 수정 전
@Data
@Schema(description = "강의 개설/조회/수정/삭제 시 입력받는 양식")
@Getter
public class LectureRequest {

// 수정 후
@Schema(description = "강의 개설 시 입력받는 양식")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class LectureCreateRequest {

 

👉 중복된 애노테이션을 제거했다.

@Data 애노테이션에는 @Getter가 포함되어 있다. 따라서 필요한 @Getter 애노테이션만 남긴 뒤, 불필요한 애노테이션은 삭제했다.

 

👉 기본 생성자를 protected로 설정하여, 빌더를 이용한 인스턴스 생성을 유도하였다.

기본 생성자를 public으로 열어두면, new LectureUpdateRequest()를 통해 필드가 비어있는 인스턴스를 생성할 수도 있기 때문이다. 따라서 기본 생성자의 사용을 막아 인스턴스 생성 시 빌더를 이용하도록 하였다.

 

 

// 수정 전
private Integer userId; // 강의 개설자의 회원번호
@NotNull
private String title;
@NotNull
private String description;

// 수정 후
@NotNull(message = "강의 생성자의 아이디값은 필수입니다.")
private Integer userId;

@NotBlank(message = "강의명을 입력해주세요.")
@Max(value = 50, message = "강의명은 최대 50자입니다.")
private String title;

@NotBlank(message = "강의 설명을 입력해주세요.")
private String content;

 

👉 필드에 적절한 제약조건을 걸어주었다.

제약조건을 지키지 않았을 때 넣을 메세지도 추가해보았다. 여기서 검증을 진행하기 때문에, Entity와 ResponseDTO에서는 별도 검증을 진행하지 않는다.

 

 

(3) 수정 결과

@Schema(description = "강의 개설 시 입력받는 양식")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class LectureCreateRequest {
    @NotNull(message = "강의 생성자의 아이디값은 필수입니다.")
    private Integer userId;

    @NotBlank(message = "강의명을 입력해주세요.")
    @Max(value = 50, message = "강의명은 최대 50자입니다.")
    private String title;

    @NotBlank(message = "강의 설명을 입력해주세요.")
    private String content;

    @NotNull(message = "개강일을 입력해주세요.")
    private LocalDate startDate;

    @NotNull(message = "종강일을 입력해주세요.")
    private LocalDate endDate;

    @NotNull(message = "강의 시간을 입력해주세요.")
    private ArrayList<SessionCreateRequest> lectureTime;

    @Builder
    public LectureCreateRequest(Integer userId, String title, String content, LocalDate startDate, LocalDate endDate, ArrayList<SessionCreateRequest> lectureTime){
        this.userId = userId;
        this.title = title;
        this.content = content;
        this.startDate = startDate;
        this.endDate = endDate;
        this.lectureTime = lectureTime;
    }

    public Lecture toEntity(User user){
        return Lecture.builder()
                .user(user)
                .title(title)
                .description(content)
                .startDate(startDate)
                .endDate(endDate)
                .lectureTime(lectureTime.toString())
                .build();
    }
}

 

@Schema(description = "강의 수정 시 입력받는 양식")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class LectureUpdateRequest {
    @NotBlank(message = "강의 설명을 입력해주세요.")
    @Column(columnDefinition = "TEXT")
    private String content;
    @NotNull(message = "개강일을 입력해주세요.")
    private LocalDate startDate;
    @NotNull(message = "종강일을 입력해주세요.")
    private LocalDate endDate;
    @NotNull(message = "강의 시간을 입력해주세요.")
    private ArrayList<SessionCreateRequest> lectureTime;

    @Builder
    public LectureUpdateRequest(String content, LocalDate startDate, LocalDate endDate, ArrayList<SessionCreateRequest> lectureTime){
        this.content = content;
        this.startDate = startDate;
        this.endDate = endDate;
        this.lectureTime = lectureTime;
    }
}

 

 

---

2. LectureResponseDTO

(1) 기존 코드 및 수정할 부분

 

@Data
@Getter
@NoArgsConstructor
public class LectureResponse {

    @Data
    public static class LectureId {
    // 강의 생성, 삭제, 업데이트 시 변경된 강의의 강의번호를 전달해주는 Response Dto

        @NotNull
        private Integer lectureId;

        @Builder
        public LectureId(Integer lectureId) {
            this.lectureId = lectureId;
        }
    }

    @Data
    public static class LectureDetail {
        // 강의정보 세부조회용 Response Dto
        @NotNull
        private Integer lectureId;
        @NotNull
        private Integer userId; // 강의 개설자 회원번호
        // 무한참조를 막기 위해 Lecture의 멤버 객체 User에게서 PK만 가져옴
        // User 객체를 넣으면 여기서 User 참조 -> User에서는 List<Lecture> 참조 -> List<Lecture>에서 다시 User 참조 -> ... 무한반복!

        @NotNull
        private String teacher;
        @NotNull
        private String title; // 강의명
        @NotNull
        private String description; // 강의설명
        @NotNull
        private LocalDate startDate; // 시작일자
        @NotNull
        private LocalDate endDate; // 종료일자
        private String lectureImg; // 썸네일 이미지
        @NotBlank
        private JSONArray lectureTime; // 강의시간

        private Integer sessionId;

        @Builder
        public LectureDetail(Integer lectureId, Integer userId, String teacher, String title, String description, LocalDate startDate, LocalDate endDate, String lectureImg, JSONArray lectureTime) {
            this.lectureId = lectureId;
            this.userId = userId;
            this.teacher = teacher;
            this.title = title;
            this.description = description;
            this.startDate = startDate;
            this.endDate = endDate;
            this.lectureImg = lectureImg;
            this.lectureTime = lectureTime;
        }


    }

    // 내가 개설한 강의 중 현재 진행중인 강의 목록 반환
    @Data
    public static class LecturePreview {

        @NotNull
        private Integer lectureId;
        @NotNull
        private String title;
        @NotNull
        private String teacher;

        private String lectureImg;
        @NotBlank
        private JSONArray lectureTime;

        // 현재 참여가능한 수업 중 가장 앞에 있는(= 끝나지 않은 수업 중 가장 빠른) 수업
        private Integer sessionId;


        @Builder
        public LecturePreview(Integer lectureId, String title, String teacher, String lectureImg, JSONArray lectureTime) {
            this.lectureId = lectureId;
            this.title = title;
            this.teacher = teacher;
            this.lectureImg = lectureImg;
            this.lectureTime = lectureTime;
        }
    }


}

 

 

👉@Data 애노테이션과 @Getter 애노테이션의 중복

👉불필요한 주석

👉열려있는 생성자

👉불필요한 검증 애노테이션

👉Entity -> DTO 변환 함수 필요

 

(2) 수정한 부분

// 수정 전
@Data
@Getter
@NoArgsConstructor
public class LectureResponse {

// 수정 후
@Getter
@NoArgsConstructor (access = AccessLevel.PROTECTED)
public class LectureDetailResponse {

 

👉 중복된 애노테이션을 제거했다.

👉 기본 생성자를 protected로 설정하여, 빌더를 이용한 인스턴스 생성을 유도하였다.

 

LectureRequestDTO에서 설명한 부분이므로 설명은 생략했다.

 

 

public static LectureDetailResponse from(Lecture lecture) {
    return LectureDetailResponse.builder()
            .lectureId(lecture.getLectureId())
            .userId(lecture.getUser().getUserId())
            .teacher(lecture.getUser().getName())
            .title(lecture.getTitle())
            .description(lecture.getDescription())
            .startDate(lecture.getStartDate())
            .endDate(lecture.getEndDate())
            .lectureImg(lecture.getLectureImg())
            .lectureTime(stringToJsonArray(lecture.getLectureTime()))
            .build();
}

 

👉 Entity -> DTO 변환 함수를 엔티티에서 DTO 클래스로 이동했다.

엔티티 클래스에 있을 때는, DTO가 추가될 때마다 엔티티 클래스도 함께 수정해야 했다.

하지만 변환함수를 DTO 클래스로 이동시키면, 엔티티 클래스는 그대로 두고 DTO 클래스만 추가해주면 된다.

 

👉 불필요한 검증 애노테이션 제거

이미 RequestDTO에서 입력값을 검증했고, 저장된 값들도 전부 검증된 값이기 때문에 ResponseDTO에는 필요하지 않을 것 같아서 제거했다.

 

 

(3) 수정 결과

@Getter
@NoArgsConstructor (access = AccessLevel.PROTECTED)
public class LectureDetailResponse {

    private Integer lectureId;
    private Integer userId;
    private String teacher;
    private String title;
    private String description;
    private LocalDate startDate;
    private LocalDate endDate;
    private String lectureImg;
    private JSONArray lectureTime;

    private Integer sessionId;

    public void setSessionId(int sessionId) {
        this.sessionId = sessionId;
    }

    @Builder
    public LectureDetailResponse (Integer lectureId, Integer userId, String teacher, String title, String description, LocalDate startDate, LocalDate endDate, String lectureImg, JSONArray lectureTime) {
        this.lectureId = lectureId;
        this.userId = userId;
        this.teacher = teacher;
        this.title = title;
        this.description = description;
        this.startDate = startDate;
        this.endDate = endDate;
        this.lectureImg = lectureImg;
        this.lectureTime = lectureTime;
    }

    public static LectureDetailResponse from(Lecture lecture) {
        return LectureDetailResponse.builder()
                .lectureId(lecture.getLectureId())
                .userId(lecture.getUser().getUserId())
                .teacher(lecture.getUser().getName())
                .title(lecture.getTitle())
                .description(lecture.getDescription())
                .startDate(lecture.getStartDate())
                .endDate(lecture.getEndDate())
                .lectureImg(lecture.getLectureImg())
                .lectureTime(stringToJsonArray(lecture.getLectureTime()))
                .build();
    }
}

 

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class LectureIdResponse {

    private Integer lectureId;

    @Builder
    public LectureIdResponse(Integer lectureId) {
        this.lectureId = lectureId;
    }

    public static LectureIdResponse from(Lecture lecture) {
        return LectureIdResponse.builder()
                .lectureId(lecture.getLectureId())
                .build();
    }

}

 

@Getter
@NoArgsConstructor (access = AccessLevel.PROTECTED)
public class LecturePreviewResponse {

    private Integer lectureId;
    private String title;
    private String teacher;
    private String lectureImg;
    private JSONArray lectureTime;

    private Integer sessionId;

    public void setSessionId(Integer sessionId) {
        this.sessionId = sessionId;
    }

    @Builder
    public LecturePreviewResponse(Integer lectureId, String title, String teacher, String lectureImg, JSONArray lectureTime) {
        this.lectureId = lectureId;
        this.title = title;
        this.teacher = teacher;
        this.lectureImg = lectureImg;
        this.lectureTime = lectureTime;
    }

    public static LecturePreviewResponse from(Lecture lecture) {
        return LecturePreviewResponse.builder()
                .lectureId(lecture.getLectureId())
                .title(lecture.getTitle())
                .teacher(lecture.getUser().getName())
                .lectureImg(lecture.getLectureImg())
                .lectureTime(stringToJsonArray(lecture.getLectureTime()))
                .build();
    }


}

 

 

---

 

3. SessionReqeustDTO

(1) 기존 코드 및 수정할 부분

@Data
@Getter
public class SessionRequest {

    static String[] weekDays = {"", "월", "화", "수", "목", "금", "토", "일"};

    @Data
    @NoArgsConstructor
    public static class SessionCreateForm {

        @NotNull
        private Integer weekDay;
        @NotNull
        private Integer startHour;
        @NotNull
        private Integer startMinute;
        @NotNull
        private Integer endHour;
        @NotNull
        private Integer endMinute;

        @Builder
        public SessionCreateForm(Integer weekDay, Integer startHour, Integer startMinute, Integer endHour, Integer endMinute) {
            this.weekDay = weekDay;
            this.startHour = startHour;
            this.startMinute = startMinute;
            this.endHour = endHour;
            this.endMinute = endMinute;
        }

        public String toString(){
            StringBuilder sb = new StringBuilder();
            String sMinute, eMinute;
            if (this.startMinute < 10) {
                sMinute = "0"+this.startMinute;
            } else {
                sMinute = this.startMinute.toString();
            }
            if (this.endMinute < 10) {
                eMinute = "0"+this.endMinute;
            } else {
                eMinute = this.endMinute.toString();
            }
            sb.append(weekDays[this.weekDay]+ " ");
            sb.append(this.startHour+":"+sMinute + " ~ ");
            sb.append(this.endHour+":"+eMinute);
            return sb.toString();
        }
    }

    public static class SessionId {
        @NotNull
        private Integer sessionId;

        @Builder
        public SessionId(Integer sessionId){
            this.sessionId = sessionId;
        }
    }


}

 

👉@Data 애노테이션과 @Getter 애노테이션의 중복

👉weekDays는 불변이므로 final을 붙여줘야 할 것 같다.

👉toString() 메서드의 가독성을 개선하고 싶다

 

 

(2) 수정한 부분

// 수정 전
@Data
@NoArgsConstructor
public static class SessionCreateForm {

// 수정 후
@Schema(description = "회차 입력 시 입력받는 양식")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class SessionCreateRequest {

 

 

👉 중복된 애노테이션을 제거했다.

👉 기본 생성자를 protected로 설정하여, 빌더를 이용한 인스턴스 생성을 유도하였다.

 

// 수정 전
static String[] weekDays = {"", "월", "화", "수", "목", "금", "토", "일"};

// 수정 후
static final List<String> weekDays = Collections.unmodifiableList(Arrays.asList("월", "화", "수", "목", "금", "토", "일"));

 

 

👉 weekDays 배열을 unmodifiableList로 변경하여 원소값들이 변경되지 않도록 했다.

String은 참조 타입이다. 따라서 가리키는 메모리 주소가 바뀌지 않는 것이지, 해당 메모리 주소에 저장된 값은 바뀌는 게 아니다.

이러한 점을 고려하여 unmodifiableList로 선언하여 원소값들이 변경되지 않도록 하고, final을 통해 weekDays가 가리키는 메모리 주소도 변경되지 않도록 했다. 조회용이라 모든 인스턴스가 공유해서 사용해도 상관없기 때문에 static은 그대로 유지했다.

 

 

👉 인덱스가 0부터 시작하도록 했다.

프론트에서 1~7로 보내주겠다고 해서 저렇게 해뒀는데, 쓸데없는 문자열을 추가하기보단 인덱스에 -1 처리를 해주는게 나을것같았다.

 

 

// 수정 전
public String toString(){
    StringBuilder sb = new StringBuilder();
    String sMinute, eMinute;
    if (this.startMinute < 10) {
        sMinute = "0"+this.startMinute;
    } else {
        sMinute = this.startMinute.toString();
    }
    if (this.endMinute < 10) {
        eMinute = "0"+this.endMinute;
    } else {
        eMinute = this.endMinute.toString();
    }
    sb.append(weekDays[this.weekDay]+ " ");
    sb.append(this.startHour+":"+sMinute + " ~ ");
    sb.append(this.endHour+":"+eMinute);
    return sb.toString();
}

// 수정 후
public String toString(){
    String startMinute = String.format("%02d", this.startMinute);
    String endMinute = String.format("%02d", this.endMinute);

    return weekDays.get(this.weekDay-1) + " "
            + this.startHour + ":" + startMinute + " ~ "
            + this.endHour + ":" + endMinute;
}

 

👉toString() 함수의 가독성을 향상시켰다.

if문을 통해 자릿수를 맞춰주던 부분은, String.format()을 이용해 두 줄로 줄여보았다.

기본 내장된 toString() 메서드의 구현을 살펴봤더니 리턴할 때 +로 처리하길래 StringBuilder를 지우고 비슷하게 처리해보았다.

 

어차피 + 연산자는 내부적으로 StringBuilder 클래스를 생성하여 처리되기 때문에 기존 코드와 크게 다르진 않을 것이다. 반복문 내에서 +연산자를 쓰는게 아니기 때문에 메모리 낭비 문제도 없다.

 

 

(3) 수정 결과

@Schema(description = "회차 입력 시 입력받는 양식")
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class SessionCreateRequest {

    static final List<String> weekDays = Collections.unmodifiableList(Arrays.asList("월", "화", "수", "목", "금", "토", "일"));
    @NotNull
    private Integer weekDay;
    @NotNull
    private Integer startHour;
    @NotNull
    private Integer startMinute;
    @NotNull
    private Integer endHour;
    @NotNull
    private Integer endMinute;

    @Builder
    public SessionCreateRequest(Integer weekDay, Integer startHour, Integer startMinute, Integer endHour, Integer endMinute) {
        this.weekDay = weekDay;
        this.startHour = startHour;
        this.startMinute = startMinute;
        this.endHour = endHour;
        this.endMinute = endMinute;
    }

    public String toString(){
        String startMinute = String.format("%02d", this.startMinute);
        String endMinute = String.format("%02d", this.endMinute);

        return weekDays.get(this.weekDay-1) + " "
                + this.startHour + ":" + startMinute + " ~ "
                + this.endHour + ":" + endMinute;
    }
}

 

 

---

3. SessionResponseDTO

(1) 기존 코드 및 수정할 부분

@Data
@Getter
@NoArgsConstructor
public class SessionResponse {

    @Data
    public static class SessionId {
        @NotNull
        private Integer sessionId;

        @Builder
        public SessionId(Integer sessionId){
            this.sessionId = sessionId;
        }
    }

    public interface SessionIdMapping {
        Integer getSessionId();
    }

    @Data
    public static class SessionStartTime {
        private LocalDateTime startTime;

        @Builder
        public SessionStartTime(LocalDateTime startTime) {
            this.startTime = startTime;
        }
    }
}

 

👉@Data 애노테이션과 @Getter 애노테이션의 중복

👉아무도 구현하지 않는 인터페이스가 의미가 있을까?

👉열려있는 생성자

 

 

(2) 수정한 부분

 

👉 중복된 애노테이션을 제거했다.

👉 기본 생성자를 protected로 설정하여, 빌더를 이용한 인스턴스 생성을 유도하였다.

👉 아무도 구현하지 않는 SessionIdMapping 인터페이스를 제거하였다.

 

 

 

(3) 수정 결과

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class SessionIdResponse {

    private Integer sessionId;

    @Builder
    public SessionIdResponse(Integer sessionId) {
        this.sessionId = sessionId;
    }
}

 

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class SessionStartTimeResponse {

    private LocalDateTime startTime;

    @Builder
    public SessionStartTimeResponse (LocalDateTime startTime) {
        this.startTime = startTime;
    }


}

 

 

 

DTO 파트는 크게 고민되는 부분은 없었는데, 의존하는 클래스가 많아서 수정하기 힘들었다. 한번 수정할 때마다 빨간줄이 후두둑...ㅜㅜ

유지보수성이 무엇인지 제대로 깨달았다🥹