데이터 중심 설계에서 책임 주도 설계로 ('오브젝트'를 읽고) -2 책임 주도 설계 과정(강의등록)

이 글의 목적

- '스룸' 프로젝트의 리팩토링 과정을 설명하고자 합니다.

- '스룸' 프로젝트의 공동 개발자들에게 재설계한 객체 협력 구조를 설명하고, 피드백 받고자 합니다.

 

설계 원칙

'코드로 이해하는 객체지향 설계, 오브젝트' 를 읽고 데이터 중심 설계가 아닌 객체 지향 설계를 하여 '스룸' 프로젝트 BE 소스코드를 리팩토링 하고자 합니다.

많이 부족하지만, 다음과 같은 기준을 두고 설계를 해보았습니다.

 

1. 책 오브젝트에서는 객체들에게 적절한 책임을 부과하고 객체간의 협력관계를 가지게 하는것은 어려우며, 데이터 중심 설계로 먼저 코딩한 뒤, 이를 바꾸는 방식도 괜찮다고 하였습니다. 이미 모든 서비스 로직이 마련되어 있으니, 최대한 객체의 데이터가 아닌 책임과 역할에 집중하고자 합니다.

 

2. 객체보다 책임을 먼저 생각하며, 객체는 해당 책임을 수행할 때 캡슐화가 가장 잘 이루어질 수 있도록 설계합니다.

 

3. repository는 service 객체에서만 접근이 가능하도록 합니다. 이는 매번 생성되는 객체들과 repository 와의 의존관계를 금지하여, 데이터 의존적이지 않도록 합니다.

 

4. 메서드를 명령과 쿼리로 구분합니다.

- 명령 (set~, modify~, schdule~, update~ 등)에서는 리턴값이 없어야 합니다. (repository에서는 예외로 합니다).

- 쿼리 (get~, is~, has~  등) 에서는 리턴값이 존재하며, 데이터를 절대 수정하지 않아야 합니다. (생성도 안됩니다.)

 

** create~ 등 객체를 생성하는 명령문은 리턴값을 허용합니다.

 

 

객체 설계

우선, 클라이언트의 요구사항을 살펴보겠습니다. 우선적으로 이전 글에서 예시로 들었던 CourseService에서의 '코스 등록' 과정을 리팩토링 합니다.

 

이때, db 에 저장해야 하는 것들이 머릿속에 먼저 떠오르지만, 최대한 데이터는 생각하지 않으려 합니다.

책 '오브젝트' 에서는 책임을 객체에게 부여하고, 객체가 자신의 정보만으로 책임 수행이 불가능할 때, 다른 객체에게 메시지를 보내어 협력하여 이를 수행할 수 있다고 말합니다.

 

따라서 질문은 다음과 같습니다.

'강의 등록' 은 어떤 객체에서 이루어져야 하는가?

 

후보군은 다음과 같습니다. 

1. 영상/재생목록 객체 (Video, Playlist)

- 이는 사용자가 영상/재생목록을 선택하여 코스를 생성하기 때문에 가능합니다.

2. 코스 생성 조건 객체 (EnrollCondition)

- 이는 생성 조건 정보를 포함하고 있기 때문에, 이를 사용하여 책임 수행이 가능할 것으로 보입니다.

3. 코스 (Course)

- 코스를 생성하는데 코스 객체를 사용하는 것은 이상해 보이는데, 코스에게 코스 생성조건과 영상을 전달한다면 생성자를 통해 가능 할 것으로 보입니다.

 

정답은?????

 

-> 정답은 없습니다. ㅎㅎ 사실 세가지 객체로 전부 시도해보았고, 전부 코스 생성이 가능했습니다.

제가 선택한 객체는 코스 생성 조건 객체 (EnrollCondition) 입니다. 이유는 다음과 같습니다.

- 영상/재생목록 객체는 다른 많은 책임이 부여될 것으로 보입니다. 스룸에서는 영상에 해당하는 강의 자료도 있고, 재생목록 객체는 영상 객체와 협력하는 과정이 있을 것 같습니다. 따라서 코스 생성에 대해서는 책임을 부과하지 않기로 했습니다.

- 코스객체를 생성하면서 동시에 코스를 등록하는 것은 어색하며, 어렵다. -> 이는 코스 객체 생성자 안에서 코스영상을 생성하는 로직이 필요하게 되어 복잡하고, 코스객체를 생성하는 것으로 코스가 등록되는 것은 이상하다고 생각이 들었습니다.

- 코스 생성 조건 객체를 사용하면 영상/재생목록을 전달해 주는 것만으로 코스 생성이 가능하다

 

 

클라이언트에서는

1. 영상 또는 플레이리스트를 선택합니다.

2. 코스 등록 조건 (스케줄링 유무, 스케줄링 한다면 몇주로, 일평균 몇분, 한주에 몇개씩의 영상)이 결정됩니다.

3. 코스를 등록하여, 이후 등록한 조건과 영상을 사용할 수 있도록 합니다.

 

클라이언트의 요구사항을 여러개의 책임으로 나눠보겠습니다.

1. 영상/재생목록 정보를 불러와야 합니다.

2. 코스 등록 조건을 사용해 코스를 생성해야 합니다. (코스라는 객체가 생성될 것 같습니다)

3. 코스안에 영상을 담아야 합니다. (이때, 코스안의 영상은 순서, 주차 등의 정보를 가지게 됩니다)

4. 이렇게 생성한 코스와 코스안의 영상을 db 에 저장합니다.

 

 

코스 생성 조건 객체 (EnrollCondition)에서는 영상/재생목록을 인자로 받아 2, 3 책임 수행이 자체적으로 가능합니다.

1번인 영상/재생목록 객체를 가져오는 것은 외부에서 실행하도록 합니다. (VideoService, PlaylistService)

책임 4번은 설계원칙 3번에 따라 courseService에서 수행하도록 합니다.

 

 

이제 코드를 작성할 시간이 왔습니다.

EnrollCondition에서는 스케줄링이 되었는지, 예상 종료일은 언제인지, 주차별 영상 개수는 몇개인지, 몇주차인지, 일평균 목표 학습시간은 몇분인지를 정보로 가질 것입니다.

Course 객체에서는 EnrollConditon과 코스안의 영상 객체인 CoursVideo 리스트, 영상과 재생목록의 상의 클래스인 ContentSaved 리스트를 정보로 가지게 됩니다.

CourseVideo객체는 VideoSaved(저장된 영상 객체) 를 상속받아 추가적으로 주차, 영상순서, 강의 순서를 정보로 가지게 됩니다.

 

객체를 생성해봅시다.

@Getter
public class EnrollCondition {

    private final Boolean scheduled;

    private final Date expectedEndDate;

    private final List<Integer> scheduling;

    private final Integer weeks;

    private final Integer dailyTargetTime;

    public EnrollCondition(NewLecture newLecture, Boolean scheduled) {
        this.scheduled = scheduled;
        if (scheduled) {
            this.expectedEndDate = DateUtil.convertStringToDate(newLecture.getExpectedEndDate());
            this.scheduling = newLecture.getScheduling();
            this.weeks = newLecture.getScheduling().size();
            this.dailyTargetTime = newLecture.getDailyTargetTime();
        } else {
            this.expectedEndDate = null;
            this.scheduling = null;
            this.weeks = null;
            this.dailyTargetTime = null;
        }
    }
}

 

public class Course {

    private final EnrollCondition enrollCondition;

    private final List<ContentSaved> contentSavedList;

    @Getter
    private final List<CourseVideo> courseVideoList;

    public Course(EnrollCondition enrollCondition, ContentSaved contentSaved, List<CourseVideo> courseVideoList) {
        this.enrollCondition = enrollCondition;
        this.contentSavedList = new ArrayList<>(List.of(contentSaved));
        this.courseVideoList = courseVideoList;
    }
}

 

public class CourseVideo extends VideoSaved {

    private final Integer section;

    private final Integer videoIndex;

    private final Integer lectureIndex;

    public CourseVideo(VideoSaved videoSaved, Integer section, Integer videoIndex, Integer lectureIndex) {
        super(videoSaved.getVideoDto());
        this.section = section;
        this.videoIndex = videoIndex;
        this.lectureIndex = lectureIndex;
    }
}

 

public class VideoSaved extends ContentSaved {

    private final VideoDto videoDto;
}

 

 

다음으로, EnrollCondition에게 책임을 수행하기 위한 메서드를 생성해봅니다.

public class EnrollCondition {

	public Course createCourse(ContentSaved contentSaved) {
        return new Course(this, contentSaved, createCourseVideoList(contentSaved));
    }

    private List<CourseVideo> createCourseVideoList(ContentSaved contentSaved) {
        int section = ENROLL_DEFAULT_SECTION_NO_SCHEDULE;
        if (scheduled) {
            section = ENROLL_DEFAULT_SECTION_SCHEDULE;
        }

        List<CourseVideo> courseVideoList = new ArrayList<>();
        if (contentSaved instanceof VideoSaved) {
            courseVideoList.add(new CourseVideo((VideoSaved) contentSaved, section, ENROLL_VIDEO_INDEX, ENROLL_LECTURE_INDEX));
        } else if (contentSaved instanceof PlaylistWithItemListSaved) {
            int videoCount = 1;
            int week = 0;
            int videoIndex = 1;

            PlaylistWithItemListSaved playlistSaved = (PlaylistWithItemListSaved) contentSaved;
            for (PlaylistItemSaved playlistItemSaved : playlistSaved.getPlaylistItemSavedList()) {
                if (scheduled && videoCount > scheduling.get(week)) {
                    week++;
                    section++;
                    videoCount = 1;
                }
                courseVideoList.add(new CourseVideo(playlistItemSaved, section, videoIndex++, ENROLL_LECTURE_INDEX));
                videoCount++;
            }
        } else {
            return null;
        }
        return courseVideoList;
    }
}

이를 통해 CourseService에서 이루어졌던 course 생성, CourseVideo 생성이 EnrollCondition의 책임으로 되고, 등록 조건 정책이 변화하였을 때는 이 객체의 수정 만이 필요하게 됩니다.

 

변화한 CourseService의 구조는 다음과 같습니다.

@Service
public class CourseServiceV2 {

    private final CourseRepository courseRepository;
    private final LectureRepository lectureRepository;
    private final CourseVideoRepository courseVideoRepository;

    public CourseServiceV2(CourseRepository courseRepository, LectureRepository lectureRepository, CourseVideoRepository courseVideoRepository) {
        this.courseRepository = courseRepository;
        this.lectureRepository = lectureRepository;
        this.courseVideoRepository = courseVideoRepository;
    }

    @Transactional
    public EnrolledCourseInfo enroll(Long memberId, NewLecture newLecture, boolean useSchedule, ContentSaved contentSaved) {
        EnrollCondition enrollCondition = new EnrollCondition(newLecture, useSchedule);

        Course course = enrollCondition.createCourse(contentSaved);
        CourseDto courseDto = courseRepository.save(new CourseDto(course));

        LectureDto lectureDto = lectureRepository.save(LectureDto.builder()
                .memberId(memberId)
                .courseId(courseDto.getCourseId())
                .sourceId(course.getFirstSourceId())
                .channel(contentSaved.getChannel())
                .playlist(contentSaved.isPlaylist())
                .lectureIndex(ENROLL_LECTURE_INDEX)
                .build());

        saveCourseVideoDtoList(memberId, courseDto.getCourseId(), course.getCourseVideoList());

        return EnrolledCourseInfo.builder()
                .title(contentSaved.getTitle())
                .courseId(courseDto.getCourseId())
                .lectureId(lectureDto.getId())
                .build();
    }

    private void saveCourseVideoDtoList(Long memberId, Long courseId, List<CourseVideo> courseVideoList) {
        for (CourseVideo courseVideo : courseVideoList) {
            courseVideoRepository.save(CourseVideoDto.builder()
                    .memberId(memberId)
                    .courseId(courseId)
                    .videoId(courseVideo.getVideoId())
                    .section(courseVideo.getSection())
                    .videoIndex(courseVideo.getVideoIndex())
                    .lectureIndex(courseVideo.getLectureIndex())
                    .summaryId(courseVideo.getSummaryId())
                    .build());
        }
    }
}

CourseService에서는 영상/재생목록 정보와, 강의 등록 조건 정보 (주차, 일평균 목표시간 등)를 알 필요가 없게 되고, 그 정보들이 변하더라도 CourseService 코드는 변화하지 않습니다.

CourseService에서는 생성된 Course와 CourseVideo 리스트를 db 에 저장하여 유저가 코스에 들어왔을 때 정보를 받을 수 있도록 합니다.

 

다음 글에서는

'스룸'에서는 youtube data api를 사용해 영상/재생목록 정보를 불러옵니다. 이를 객체간의 협력을 통한 방법으로 재설계하는 과정을 설명합니다.