feat: lecture, timetableLecture API v3 #1156

Soundbar91 · 2025-01-03T16:32:35Z

🔥 연관 이슈

close lecture, timetablelecture api v3 #1148

🚀 작업 내용

lecture와 timetableLecture의 숫자 배열 강의 시간을 (week, startTime, endTime)으로 분리했습니다.
timetableLecture의 커스텀 강의와 정규 강의 API (생성, 수정)를 분리했습니다.
V2에서 사용하는 롤백 API도 응답 DTO 수정을 했기 때문에 가져왔습니다.

💬 리뷰 중점사항

timetableLecture 버저닝을 하면서 lecture와 겹치는 부분이 존재해서, 같이 작업을 진행했습니다.

테이블 정규화 실패

초기 작업을 할 때 역정규화된 강의 시간 데이터를 다 정규화를 했지만, 중복 시간 체크 구현에서 코드가 너무 꼬이고 엔티티 조회도 너무 많이 발생해서 코드로 정규화를 진행했습니다.
중복 시간 체크는 코드로 정규화를 진행해도 구현이 안 되서 클라이언트에서 구현한 로직을 따라가야 할 것 같습니다.

역정규화 데이터 정규화 로직

해당 로직은 응답 dto (LectureInfoResponse, LectureResponseV3)에 존재합니다.

정규 강의(lecture)의 강의 시간은 -1 구분자가 없고 연속되는 자연수인 경우를 판별하면 되기 때문에 이를 확인해서 정규화를 진행했습니다.

커스텀 강의의 강의 시간은 -1 구분자가 있는 경우에는 다음 강의 장소로 넘어가고, -1 구분자가 나오기 이전 연속되는 자연수가 아닌 경우 다음 강의 장소로 넘어가면 안 되기 때문에 이를 확인해서 정규화를 진행했습니다.

class_time = [1, 2, 100, 101, -1, 200, 201], class_place = "장소 A, 장소 B"의 경우 다음과 같이 응답값을 보냅니다.

[
  {
    "week": 0,
    "start_time": 1,
    "end_time": 2,
    "place": "장소 A"
  },
  {
    "week": 1,
    "start_time": 100,
    "end_time": 101,
    "place": "장소 A"
  },
  {
    "week": 2,
    "start_time": 200,
    "end_time": 201,
    "place": "장소 B"
  }
]

정규 강의는 숫자 배열의 연속이 끊길 때 마다, 다음 강의 장소로 넘어갑니다.
class_time = [1, 2, 100, 101], class_place = "장소 A, 장소 B

[
  {
    "week": 0,
    "start_time": 1,
    "end_time": 2,
    "place": "장소 A"
  },
  {
    "week": 1,
    "start_time": 100,
    "end_time": 101,
    "place": "장소 B"
  }
]

정규화 데이터 역정규화

요청 값으로 들어오는 정규화된 데이터를 역정규화하는 로직은 요청 dto 내부에 존재합니다.
강의 시간 (start_time, end_time) 역정규화는 커스텀 강의에만 진행을 합니다. 정규 강의는 이미 lecture 테이블에 역정규화된 상태이기 때문이고, lecture 테이블에서 강의 시간을 참조해야 하기 때문입니다.
start_time를 1씩 증가시켜서 end_time 값과 동일해질 때 까지 리스트에 넣습니다. 이 작업은 기존 데이터들과 형식을 맞추기 위해서 진행했습니다. start_time = 13, end_time = 16 -> 13, 14, 15, 16
다음 강의 시간으로 넘어가기 전에 -1 구분자를 넣어줍니다. 해당 값은 timetable_lecture 테이블의 class_time에 저장합니다.

강의 장소 (place) 역정규화는 정규 강의와 커스텀 강의 둘 다 진행을 합니다. 강의 장소는 입력으로 들어온 place를 , 구분자로 연결합니다. 해당 값은 timetable_lecture 테이블의 class_place에 저장합니다.

마무리

정규화 <-> 역정규화 이 부분을 제외하면 v2와 유사한 로직입니다..! 리뷰 남겨주시면 감사하겠습니다.

… feature/1148-timetable-lecture-v3

github-actions · 2025-01-03T16:38:06Z

Unit Test Results

349 tests 348 ✔️ 1m 29s ⏱️
  44 suites     1 💤
  44 files     0 ❌

Results for commit b43521a.

♻️ This comment has been updated with latest results.

kwoo28

정규화<->역정규화하는 과정 정말 까다로웠는데 수고 많으셨습니다.. 패키지나 api 분리도 깔끔하게 잘 작성하신것같습니다!

kwoo28 · 2025-01-04T15:08:24Z

...va/in/koreatech/koin/domain/timetableV3/dto/request/TimetableCustomLectureCreateRequest.java

+        // 커스텀 강의 장소 역정규화
+        public String joinClassPlaces() {
+            StringBuilder classPlaces = new StringBuilder();
+            for (int index = 0; index < lectureInfos.size(); index++) {
+                if (index > 0) {
+                    classPlaces.append(", ");
+                }
+                classPlaces.append(lectureInfos.get(index).place());
+            }
+            return classPlaces.toString();
+        }


C

람다식으로 변경할 수 있을것같은데 혹시 이렇게하는거 어떨까요?
문법 참고 주소 : https://velog.io/@songyuheon/Java-Stream-collectCollectors.joining

Suggested change

// 커스텀 강의 장소 역정규화

public String joinClassPlaces() {

StringBuilder classPlaces = new StringBuilder();

for (int index = 0; index < lectureInfos.size(); index++) {

if (index > 0) {

classPlaces.append(", ");

}

classPlaces.append(lectureInfos.get(index).place());

}

return classPlaces.toString();

}

public String joinClassPlaces() {

return lectureInfos.stream()

.map(LectureInfoRequest::place)

.collect(Collectors.joining(", "));

}

오오,, 세 줄로 줄었네욥..! 반영하겠습니다

kwoo28 · 2025-01-04T15:40:26Z

src/main/java/in/koreatech/koin/domain/timetableV3/dto/response/LectureInfoResponse.java

+                    if (index + 1 > classPlaces.size()) {
+                        addLectureInfo(response, startTime, endTime, EMPTY_PLACE);
+                    }


A

해당 조건문은 시간은 2개인데, 강의장소는 1개일때 해당하는 부분 맞나요??

넵 맞습니다 ! 강의 장소 수정이 이뤄졌는데, 한 장소만 수정이 됐을 경우 NPE가 발생하기 때문에 걸었습니다.
클라이언트에서 강의 장소를 추가하지 않은 경우 ""으로 보내주겠지만, 만약을 위해 추가했습니다.

kwoo28 · 2025-01-04T15:48:55Z

src/main/java/in/koreatech/koin/domain/timetableV3/dto/response/LectureInfoResponse.java

+            prevTime = time;
+        }
+
+        if (!Objects.isNull(startTime)) {


A

조건문이 있다는건 startTime이 null값이 될 수 있는 경우가 있다는건데, 여기서 startTime이 null값이 되는 경우는 어떤 상황인가요?? 위에 로직부터 계속 봤는데 어떤 경우에 startTime이 null값이 되는지 헷갈리네요..ㅎ

이 코드가 mysql 프로시저를 코드로 옮긴 내용이라, 다시 코드를 작성해서 푸시했습니다 !
47d93b1

커스텀 강의도 변경했습니다.
3ba3955

This reverts commit 7f293c7.

duehee

어우 작업의 신..
코멘트 몇 개 남겼으니 한 번 확인해주세요! 고생하셨습니다~

duehee · 2025-01-05T07:31:12Z

src/main/java/in/koreatech/koin/domain/timetableV2/model/TimetableLecture.java

@@ -114,4 +114,18 @@ public void delete() {
    public void undelete() {
        this.isDeleted = false;
    }
+
+    public void customLectureUpdate(String classTitle, String professor, String classTime, String classPlace) {


C

메소드명을 updateCustiomLecture로 하는 건 어떨까요? "동사 + 명사" 형태를 더 많이 사용해서요!
-> 아래 updateRegularLecture도 동일해요!

Suggested change

public void customLectureUpdate(String classTitle, String professor, String classTime, String classPlace) {

public void updateCustomLecture(String classTitle, String professor, String classTime, String classPlace) {

반영하겠습니다 !! 감사합니다

duehee · 2025-01-05T07:44:45Z

src/main/java/in/koreatech/koin/domain/timetableV3/dto/request/LectureInfoRequest.java

+    @Schema(description = "종료 시간", example = "115", requiredMode = REQUIRED)
+    Integer endTime,
+
+    @Schema(description = "장소", example = "2공학관314", requiredMode = NOT_REQUIRED)


C

기존에서는 TEXT로 받았는데, 문제 없을까요?

각 문자열을 최대 30으로 받고, 하나의 문자열로 역 정규화를 진행해서 TEXT 범위 이내로 들어옵니다 !

duehee · 2025-01-05T07:56:47Z

src/main/java/in/koreatech/koin/domain/timetableV3/dto/response/LectureInfoResponse.java

+@JsonNaming(value = SnakeCaseStrategy.class)
+public record LectureInfoResponse(
+    @Schema(description = "요일 id", example = "0", requiredMode = REQUIRED)
+    Integer week,


A

저는 이거 처음 볼 때 주(한 주)로 해석하는 여지가 좀 생겼는데, 영어 표현은 day of the week라 너무 길고, weekday나 day같은 표현은 어떨까요?

day가 좋아 보입니다 ! 피드백 감사합니다.

duehee · 2025-01-05T07:57:16Z

src/main/java/in/koreatech/koin/domain/timetableV3/dto/response/LectureInfoResponse.java

+        List<Integer> classTimes = parseToIntegerList(classTime);
+        List<LectureInfoResponse> response = new ArrayList<>();
+
+        // 온라인 강의인 경우


duehee · 2025-01-05T08:00:31Z

src/main/java/in/koreatech/koin/domain/timetableV3/repository/LectureRepositoryV3.java

+            .orElseThrow(() -> LectureNotFoundException.withDetail("lecture_id: " + id));
+    }
+
+    List<Lecture> findBySemester(String semesterDate);


A

find끼리 묶어서 두면 좋을 거 같아요!!!

duehee · 2025-01-05T08:12:33Z

src/main/java/in/koreatech/koin/domain/timetableV3/service/LectureServiceV3.java

+@Service
+@RequiredArgsConstructor


C

👀

Suggested change

@Service

@RequiredArgsConstructor

@Service

@RequiredArgsConstructor

@Transactional(readOnly = true)

헉,,,,,,, 감사합니다

duehee · 2025-01-05T08:17:20Z

src/main/java/in/koreatech/koin/domain/timetableV3/service/TimetableLectureServiceV3.java

+@Service
+@RequiredArgsConstructor


C

Suggested change

@Service

@RequiredArgsConstructor

@Service

@RequiredArgsConstructor

@Transactional(readOnly = true)

duehee · 2025-01-05T08:28:25Z

src/test/java/in/koreatech/koin/acceptance/LectureApiTest.java

+                        "regular_number": "22",
+                        "department": "기계공학부",
+                        "target": "기공1",
+                        "professor": "박한수,최준호",


A

어느새 교수자리까지

대단한 분들이십니다..!

duehee

짱

… feature/1148-timetable-lecture-v3

Soundbar91 added 30 commits December 21, 2024 21:36

feat: 정규 강의 생성 API

4fdcc71

chore: 컨트롤러 네이밍 변경

ad0331f

chore: 스웨거 설명 변경

0585662

chore: 스웨거 에러 코드 추가

41f3a25

chore: 서비스 네이밍 변경

f004f20

chore: 서비스 네이밍 변경

0264545

feat: 커스텀 강의 생성 API

a1c4959

chore: 미사용 import 삭제

a0b4c6c

fix: 조회 버그 수정

8149e60

chore: api implements

19f407f

docs: TODO 작성

a9c29b6

feat: 커스텀 강의 수정 API 기본 틀 추가

598668a

feat: 정규 강의 수정 API 기본 틀 추가

8c593ef

feat: 커스텀 강의 수정 API dto 수정

76d6fc6

feat: timetableLectureV3 조회 API 기본 틀

17fe0be

chore: 미사용 import 삭제

d440a4b

chore: 미사용 import 삭제

d3fa81a

feat: Lecture V3

871b4b1

feat: lecture 정규화

5548bce

chore: lecture - LectureInformation 연간관계 설정

42aa767

chore: 메소드 명 변경 및 미사용 import 삭제

c387b98

feat: 커스텀 강의 업데이트 로직 구현

91b3fde

feat: 정규 강의 수정 임시 커밋

ffe61c0

feat: 정규 강의 수정 기능 구현

ffc5ba0

fix: 응답 버그 수정

d2aab0f

docs: TODO 작성

acd6ce5

feat: 시간표 조회 API 구현

77b6fef

Merge branch 'develop' of https://github.com/BCSDLab/KOIN_API_V2 into…

87ae033

… feature/1148-timetable-lecture-v3

feat: timetableV3 스웨거 그룹화

a1c0885

feat: TimetableLectureInformation 추가 및 flyway 수정

e7db2f5

Soundbar91 added 기능 새로운 기능을 개발합니다. Team User 유저 팀에서 작업할 이슈입니다 labels Jan 3, 2025

Soundbar91 requested review from seongjae6751, daheeParkk, kwoo28 and duehee January 3, 2025 16:32

Soundbar91 self-assigned this Jan 3, 2025

Soundbar91 added 5 commits January 4, 2025 01:49

fix: dto 의존성 끊기

7200c3e

test: 테스트 실패 수정

86a70ad

fix: 정규 강의 수정기능 버그 수정

cf8fbf4

docs: 스웨거 응답 코드 변경

dcc5632

충돌 해결

47d93b1

kwoo28 approved these changes Jan 4, 2025

View reviewed changes

Soundbar91 added 8 commits January 5, 2025 00:57

chore: lecture API 파라미터 변경

fe17cc8

test: 테스트 수정

e999543

chore: 리뷰 반영

70d4a30

chore: 커스텀 정규화 메소드 수정

3ba3955

chore: 리뷰 반영

7ee4e2c

chore: lecture v3 파라미터 변경

1556bbe

chore: frame 복구 api 삭제

7f293c7

Revert "chore: frame 복구 api 삭제"

1100595

This reverts commit 7f293c7.

duehee requested changes Jan 5, 2025

View reviewed changes

chore: 리뷰 반영

9fb5822

Soundbar91 requested a review from duehee January 5, 2025 08:51

chore: 리뷰 반영

09431a2

duehee approved these changes Jan 5, 2025

View reviewed changes

Merge branch 'develop' of https://github.com/BCSDLab/KOIN_API_V2 into…

b43521a

… feature/1148-timetable-lecture-v3

Soundbar91 merged commit 8c9cba9 into develop Jan 5, 2025
4 checks passed

Soundbar91 deleted the feature/1148-timetable-lecture-v3 branch January 5, 2025 15:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: lecture, timetableLecture API v3 #1156

feat: lecture, timetableLecture API v3 #1156

Soundbar91 commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

kwoo28 left a comment

kwoo28 Jan 4, 2025

Soundbar91 Jan 4, 2025

kwoo28 Jan 4, 2025 •

edited

Loading

Soundbar91 Jan 4, 2025

kwoo28 Jan 4, 2025

Soundbar91 Jan 4, 2025

Soundbar91 Jan 4, 2025

duehee left a comment

duehee Jan 5, 2025

Soundbar91 Jan 5, 2025

duehee Jan 5, 2025

Soundbar91 Jan 5, 2025

duehee Jan 5, 2025

Soundbar91 Jan 5, 2025

duehee Jan 5, 2025

duehee Jan 5, 2025

duehee Jan 5, 2025

Soundbar91 Jan 5, 2025

duehee Jan 5, 2025

Soundbar91 Jan 5, 2025

duehee Jan 5, 2025

Soundbar91 Jan 5, 2025

duehee left a comment

	public void customLectureUpdate(String classTitle, String professor, String classTime, String classPlace) {
	public void updateCustomLecture(String classTitle, String professor, String classTime, String classPlace) {

feat: lecture, timetableLecture API v3 #1156

feat: lecture, timetableLecture API v3 #1156

Conversation

Soundbar91 commented Jan 3, 2025 • edited Loading

🔥 연관 이슈

🚀 작업 내용

💬 리뷰 중점사항

테이블 정규화 실패

역정규화 데이터 정규화 로직

정규화 데이터 역정규화

마무리

github-actions bot commented Jan 3, 2025 • edited Loading

Unit Test Results

kwoo28 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

C

Choose a reason for hiding this comment

kwoo28 Jan 4, 2025 • edited Loading

Choose a reason for hiding this comment

A

Choose a reason for hiding this comment

Choose a reason for hiding this comment

A

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duehee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

C

Choose a reason for hiding this comment

Choose a reason for hiding this comment

C

Choose a reason for hiding this comment

Choose a reason for hiding this comment

A

Choose a reason for hiding this comment

Choose a reason for hiding this comment

A

Choose a reason for hiding this comment

A

Choose a reason for hiding this comment

C

Choose a reason for hiding this comment

Choose a reason for hiding this comment

C

Choose a reason for hiding this comment

Choose a reason for hiding this comment

A

Choose a reason for hiding this comment

duehee left a comment

Choose a reason for hiding this comment

Soundbar91 commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025 •

edited

Loading

kwoo28 Jan 4, 2025 •

edited

Loading