feat: 어드민 게시글 CRUD API 작성 #940

songsunkook · 2024-10-03T14:42:47Z

🚀 작업 내용

코인 자체 게시글과 한기대 공지 게시글을 JOIN해서 제공하면 성능이 많이 떨어져서(100ms -> 13000ms) JOIN 없이 제공할 수 있도록 게시글 관련 DB 구조를 변경했습니다.
게시글 관련 기존 객체 Article이 koreatech_article이 아닌 articles 테이블을 참조하도록 변경했습니다.
게시글 관련 엔티티가 수정 및 추가되서 기존의 관련 비즈니스 로직도 일부 수정되었습니다.
옛날 코인 게시글 중 작성자 user 정보가 존재하지 않는 경우가 많아 탈퇴한 사용자의 코인 게시글은 제거했습니다.
코인 게시글의 사용자가 탈퇴한 경우 작성자 정보로 "탈퇴한 사용자"를 반환하도록 했습니다.
코인 공지 게시글을 어드민 페이지에서 열람하면 해당 어드민 계정의 name을 반환하고, 일반 코인 페이지에서 열람하면 "BCSD Lab"을 반환하도록 했습니다.

기존 테이블 구조

articles: 레거시 게시글 테이블. 옛날 코인 자체 게시글과 한기대 크롤링 게시글이 들어있음. 몇 달 전부터 미사용 중
koreatech_articles: 한기대 크롤링 게시글 테이블.

변경된 테이블 구조

articles: 게시글 테이블. 제목이나 내용 등 게시글 종류에 무관하게 필요한 내용이 포함됨
koreatech_articles: 한기대 크롤링 게시글만이 갖는 추가 필드를 다룸
koin_articles: 코인 자체 게시글만이 갖는 추가 필드를 다룸

💬 리뷰 중점사항

게시글 관련 DB 테이블을 싹 갈아엎어서 flyway가 많이 길어졌습니다. 로컬에서 꼭 한번씩 테스트해주시면 감사하겠습니다!

+) 이번 작업은 신규 캠퍼스팀원 @DHkimgit 및 백엔드 에이스 @ImTotem 과 함께 진행했습니다.

github-actions · 2024-10-03T14:47:36Z

Unit Test Results

318 tests +8 317 ✔️ +8 1m 23s ⏱️ +2s
  36 suites +1     1 💤 ±0
  36 files +1     0 ❌ ±0

Results for commit 1cf2c98. ± Comparison against base commit a37767d.

♻️ This comment has been updated with latest results.

…feature/admin-article-api

20HyeonsuLee

몇가지 코멘트 남겼습니다 확인해주세요~!

추가로 리뷰하면서 ArticleService로직좀 살펴봤는데 리팩토링이 필요해보여요

20HyeonsuLee · 2024-10-04T03:00:30Z

src/main/resources/db/migration/V67__create_new_articles_tables.sql

+    `content`    MEDIUMTEXT CHARACTER SET 'utf8mb4'   NULL     DEFAULT NULL COMMENT '내용',
+    `hit`        INT UNSIGNED                         NOT NULL DEFAULT '0' COMMENT '조회수',
+    `is_notice`  TINYINT(1)                           NOT NULL DEFAULT '0' COMMENT '공지사항인지 여부',
+    `is_deleted` TINYINT(1)                           NOT NULL DEFAULT '0' COMMENT '삭제 여부',


C

새로 생성하는 테이블들에 is_deleted가 꼭 필요한 걸까요?

특정 작성자의 모든 게시글 조회와 같이 articles.is_deleted를 JOIN해서 함께 필터링해야 하는 경우를 감안해서 is_deleted를 koin_articles와 koreatech_articles도 가지도록 역정규화했습니다.

20HyeonsuLee · 2024-10-04T03:09:18Z

src/main/resources/db/migration/V72__update_article_attachments_fk.sql

+DROP TABLE `koin`.`old_articles`;
+DROP TABLE `koin`.`old_koreatech_articles`;


C

기존 테이블의 삭제는 조금 보류해뒀으면 좋을 것 같아요.
배포중 롤백해야하는 상황이 생긴다면 git revert를 한 후 재배포를 할텐데 DB는 롤백이 안되기때문에 DB와 Entity의 정합성이 안맞을 것 같습니다

그래서 덤프뜨고 진행하면 되는지 질문드렸었는데 그래도 조심스럽게 대응해야 하는 건 맞는 것 같아요.
RENAME과 DROP만 나중으로 미루면 되는 내용이니 리뷰 반영해두겠습니다.

적용 완료했습니다.(RENAME 롤백, DROP 롤백)

article_attachments 테이블은 기존 테이블을 그대로 사용하기 때문에 하위호환성을 지키기가 애매했습니다.

기존에 걸려있던 article_id FK 해제

article_id 값 일괄 변경

따라서 배포 시 해당 테이블만 미리 dump해두고 진행하면 될 것 같습니다. 나머지 테이블은 전부 기존 테이블 그대로 유지했기에 코드만 롤백(revert)하면 됩니다.

article_attachments.article_id는 원상복구 힘드니 배포 전 덤프떠둘 것

ImTotem

수고하셨습니다!
배치만 보다가 보니까 적응이 안되네요 ㅋㅋㅋ

배치에도 테이블에 new_ 붙여야겠네요

dradnats1012

송선권씨 옆에 두고 설명 들었습니다
DB 어렵네요...
몇가지만 확인해주세용

dradnats1012 · 2024-10-04T08:21:25Z

src/main/java/in/koreatech/koin/admin/notice/service/AdminNoticeService.java

+        Optional<Article> foundArticle = articleRepository.findById(noticeId);
+        if (foundArticle.isEmpty()) {
+            return;
+        }


getById()를 안쓴 이유가 있나요?

제거 요청은 대상 존재 유무에 상관없이 204 응답을 반환하는 것이 적절하다고 생각해서 대상이 존재하지 않는 경우 예외가 발생하는 getById() 대신 findById()를 사용하고 직접 핸들링하는 방향으로 작성했습니다.

dradnats1012 · 2024-10-04T08:45:13Z

src/main/java/in/koreatech/koin/admin/notice/controller/AdminNoticeController.java

+
+@RestController
+@RequiredArgsConstructor
+public class AdminNoticeController implements AdminNoticeApi {


@RequestMapping("/admin")으로 뺴도 될 것 같아요!

dradnats1012 · 2024-10-04T08:45:35Z

src/main/java/in/koreatech/koin/admin/notice/controller/AdminNoticeApi.java

+import jakarta.validation.Valid;
+
+@Tag(name = "(Admin) Notice: 코인 공지", description = "")
+public interface AdminNoticeApi {


여기도요!

DHkimgit and others added 17 commits October 1, 2024 17:15

feat: AdminNoticeApi 구성

e15a5fe

feat: AdminNoticeController 구성

e634ad0

feat: AdminNoticeController 구성

4dbf570

feat: AdminNoticeDto 구성

0ceb6d3

feat: AdminNoticeService 구성

88b3d9a

feat: 도메인 엔티티 추가

9f9e160

feat: KoinArticle entity, repository 작성

f88ac47

feat: KoreatechArticle entity, repository 작성

417bd39

feat: Article entity 수정

ba0c5ba

feat: Articles 도메인 로직 수정

f516870

feat: KoinAdminNotice 도메인 controller 수정

0eef50e

feat: KoinAdminNotice 도메인 service 작성

2f9178b

feat: KoinAdminNotice 도메인 DTO 수정

6798df4

refactor: 미사용 entity 삭제

3eb1d49

refactor: 페어 리뷰 반영

62c1079

test: Article 테스트 수정

619db6e

feat: flyway 작성

9f89da9

songsunkook added the Team Campus 캠퍼스 팀에서 작업할 이슈입니다 label Oct 3, 2024

songsunkook requested review from ImTotem, seongjae6751, dradnats1012, 20HyeonsuLee, Choon0414 and kih1015 October 3, 2024 14:42

songsunkook assigned songsunkook, ImTotem and DHkimgit Oct 3, 2024

github-actions bot added the 기능 새로운 기능을 개발합니다. label Oct 3, 2024

github-actions bot requested a review from kwoo28 October 3, 2024 14:43

DHkimgit and others added 8 commits October 3, 2024 23:47

refactor: 미사용 repository 삭제

291a022

Merge branch 'refs/heads/develop' into feature/admin-article-api

301c70b

fix: flyway 버전 수정

1079a59

Merge remote-tracking branch 'origin/feature/admin-article-api' into …

035284f

…feature/admin-article-api

test: AdminNoticeApi 테스트 코드 작성

527f9b5

Merge remote-tracking branch 'origin/feature/admin-article-api' into …

e492bed

…feature/admin-article-api

feat: upload domain 추가

bafefc5

feat: unique 속성 flyway 적용

8f46386

20HyeonsuLee requested changes Oct 4, 2024

View reviewed changes

songsunkook added 3 commits October 4, 2024 13:59

refactor: 테이블 구조 하위호환성 지키도록 수정

3b76dbc

article_attachments.article_id는 원상복구 힘드니 배포 전 덤프떠둘 것

fix: 테이블명 변경에 따른 네이티브 쿼리 수정

fa73a23

feat: response에 생성 일시 및 수정 일시 추가

b83ea4c

ImTotem approved these changes Oct 4, 2024

View reviewed changes

dradnats1012 approved these changes Oct 4, 2024

View reviewed changes

20HyeonsuLee approved these changes Oct 4, 2024

View reviewed changes

songsunkook added 2 commits October 4, 2024 21:17

refactor: path 수정 및 리뷰 반영

066517c

test: path 수정 반영

1cf2c98

songsunkook merged commit 8b1f5d9 into develop Oct 4, 2024
4 checks passed

songsunkook deleted the feature/admin-article-api branch October 4, 2024 14:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 어드민 게시글 CRUD API 작성 #940

feat: 어드민 게시글 CRUD API 작성 #940

songsunkook commented Oct 3, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024 •

edited

Loading

20HyeonsuLee left a comment

20HyeonsuLee Oct 4, 2024

songsunkook Oct 4, 2024

20HyeonsuLee Oct 4, 2024

songsunkook Oct 4, 2024 •

edited

Loading

songsunkook Oct 4, 2024 •

edited

Loading

ImTotem left a comment

dradnats1012 left a comment

dradnats1012 Oct 4, 2024

songsunkook Oct 4, 2024

dradnats1012 Oct 4, 2024

dradnats1012 Oct 4, 2024

		DROP TABLE `koin`.`old_articles`;
		DROP TABLE `koin`.`old_koreatech_articles`;

feat: 어드민 게시글 CRUD API 작성 #940

feat: 어드민 게시글 CRUD API 작성 #940

Conversation

songsunkook commented Oct 3, 2024 • edited Loading

🚀 작업 내용

기존 테이블 구조

변경된 테이블 구조

💬 리뷰 중점사항

github-actions bot commented Oct 3, 2024 • edited Loading

Unit Test Results

20HyeonsuLee left a comment

Choose a reason for hiding this comment

20HyeonsuLee Oct 4, 2024

Choose a reason for hiding this comment

C

songsunkook Oct 4, 2024

Choose a reason for hiding this comment

20HyeonsuLee Oct 4, 2024

Choose a reason for hiding this comment

C

songsunkook Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

songsunkook Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

ImTotem left a comment

Choose a reason for hiding this comment

dradnats1012 left a comment

Choose a reason for hiding this comment

dradnats1012 Oct 4, 2024

Choose a reason for hiding this comment

songsunkook Oct 4, 2024

Choose a reason for hiding this comment

dradnats1012 Oct 4, 2024

Choose a reason for hiding this comment

dradnats1012 Oct 4, 2024

Choose a reason for hiding this comment

songsunkook commented Oct 3, 2024 •

edited

Loading

github-actions bot commented Oct 3, 2024 •

edited

Loading

songsunkook Oct 4, 2024 •

edited

Loading

songsunkook Oct 4, 2024 •

edited

Loading