feat: 개발질문 게시판의 해시태그 기능 구현 완료 #629

mingmingmon · 2024-12-15T06:13:39Z

Summary

#609

커뮤니티 게시판 중에서 개발질문 카테고리에 대해서 해시태그를 설정할 수 있는 기능을 개발했습니다.

Tasks

해시태그 등록 API 작성
(해시태그를 먼저 등록하고, 개발질문 게시판에 해시태그id를 연결하는 형태입니다.)
게시글 requestDto에 해시태그id list를 전달하도록 수정
(개발질문 게시판 전용으로 dto를 만드는 선택지도 있었지만, @Jeong-Ag 님과 회의 후에 결정했습니다. 모든 게시판의 요청 dto에 해시태그 id list를 담아서 전달할 수 있습니다. 이때 null이어도 괜찮습니다. 이는 현재 개발질문 게시판에서만 해시태그 기능을 사용할 수 있지만 추후 확장성을 고려한 선택이었습니다.)
게시글 수정 시 해시태그id list를 전달하도록 수정
(게시글을 수정할 때 해시태그 수정도 함께 할 수 있도록 했습니다. 이때는 기존에 있던 해시태그 정보와 새로운 해시태그 정보를 비교해서 소프트 딜리티를 수정하거나 새롭게 등록할 수 있도록 로직을 작성했습니다.)
해시태그로 게시글 검색하기
(해시태그를 여러개 전달하면 페이지네이션을 적용해서 해당 해시태그를 모두 포함하는 게시글을 반환합니다.)

ETC

리뷰 해주실 때 로직에 대한 피드백이나 성능 피드백 많이 해주시면 반영하겠습니다! 다만 수정된 API 연동이 최대한 빨리 진행되어야 해서, 성능 피드백은 PR 머지 후 다른 이슈에서 진행하고자 합니다.

SQL문

hashtag

CREATE TABLE hashtag (
    id BIGSERIAL PRIMARY KEY,                   
    name VARCHAR(255) NOT NULL,                
    is_deleted BOOLEAN DEFAULT FALSE NOT NULL,  
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP 
);

BoardHashtag

CREATE TABLE board_hashtag (
    id BIGSERIAL PRIMARY KEY,                   
    board_id BIGINT NOT NULL,                   -
    hashtag_id BIGINT NOT NULL,                
    is_deleted BOOLEAN DEFAULT FALSE NOT NULL,  
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, 
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

Screenshot

해시태그 생성 API
개발질문 게시판이 아닌 경우 해시태그 등록 시 예외처리. 해시태그가 없다면 정상 등록 가능.
게시글 상세조회 API에서 해시태그 정보를 함께 반환하도록 수정함. 해시태그가 없는 경우는 빈 리스트를 반환. 다른 게시글 조회 관련 API도 마찬가지로 수정완료.
게시글 수정 API에서 해시태그 정보를 받도록 수정. 이때 카테고리가 개발질문인 것만 해시태그 정보를 수정가능하도록 예외처리
해시태그가 모두 포함된 게시글 조회
[자료구조 해시태그]

[JAVA, C++ 해시태그]

… 하도록 수정

…설정 시 예외처리

limehee · 2024-12-16T09:18:39Z

src/main/java/page/clab/api/domain/community/board/adapter/in/web/BoardRegisterController.java

@@ -4,6 +4,7 @@
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
+import org.apache.coyote.BadRequestException;


불필요한 클래스가 import되었어요. 제거 부탁드러요.

limehee · 2024-12-16T09:27:58Z

.../clab/api/domain/community/board/adapter/out/persistence/BoardHashtagPersistenceAdapter.java

+        RegisterBoardHashtagPort, RetrieveBoardHashtagPort {
+
+    private final BoardHashtagRepository boardHashtagRepository;
+    private final BoardHashtagMapper mapper;


현재 프로젝트의 PersistenceAdapter 클래스에서 변수명으로 repository, mapper를 사용하는 경우, 도메인 이름을 접두어로 붙이는 방식과 붙이지 않는 방식이 혼재되어 있어요. 우선 해당 클래스 내에서 하나의 방식으로 통일하여 변수명을 변경하고, 이후에 전체적인 변수명 규칙에 대해 논의하는 시간을 가질 필요가 있어보여요.

limehee · 2024-12-16T09:32:11Z

...ava/page/clab/api/domain/community/board/adapter/out/persistence/BoardHashtagRepository.java

+    List<BoardHashtagJpaEntity> findAllByBoardId(Long boardId);
+
+    @Query(value = "SELECT b.* FROM board_hashtag b WHERE b.board_id = :boardId", nativeQuery = true)
+    List<BoardHashtagJpaEntity> findAllIncludingDeletedByBoardId(Long boardId);


@Query( value = "SELECT b.* " + "FROM board_hashtag b " + "WHERE b.board_id = :boardId", nativeQuery = true )

위 예시처럼 적절히 개행을 추가해주면 가독성 개선에 도움이 될 것 같아요.

limehee · 2024-12-16T09:34:13Z

...page/clab/api/domain/community/board/adapter/out/persistence/BoardHashtagRepositoryImpl.java

+@RequiredArgsConstructor
+public class BoardHashtagRepositoryImpl implements BoardHashtagRepositoryCustom {
+
+    private final JPAQueryFactory queryFactory;


기존에 사용하던 QueryDSL을 대신하여 JPQL을 선택하게 된 이유가 궁금해요. 간단히 설명 부탁드려도 될까요?

limehee · 2024-12-16T09:36:49Z

.../java/page/clab/api/domain/community/board/application/dto/mapper/BoardHashtagDtoMapper.java

+@RequiredArgsConstructor
+public class BoardHashtagDtoMapper {
+
+    public BoardHashtag fromDto(Long boardId, Long hashtagId){


)와 { 사이에 공백이 누락되었어요.

limehee · 2024-12-16T10:00:07Z

...in/java/page/clab/api/domain/community/hashtag/adapter/in/web/HashtagRegisterController.java

+
+    private final RegisterHashtagUseCase registerHashtagUseCase;
+
+    @Operation(summary = "[U] 해시태그 생성", description = "ROLE_USER 이상의 권한이 필요함")


현재 해시태그는 운영진 및 코어팀과 사전 협의된 내용으로 구성되는 것으로 알고 있어요. 혹시 제가 잘못 인지한 것일까요? 만약 해시태그 생성 권한을 일반 사용자에게 허용한다면, 서버의 공격 표면이 증가하고 불필요한 데이터가 생성될 가능성이 높아 보여요.

제가 생각했을 때에는 velog에서 해시태그를 추가할 때처럼, 사용자가 직접 본인만의 해시태그를 만들어서 추가하는 방식으로 하면 원하는 해시태그가 없을 때에도 손쉽게 추가할 수 있어 자유도가 증가할 것이라고 생각했는데,
블로그의 게시글과 커뮤니티 게시글의 특성이 다르다보니 해시태그가 악용될 수 있다는 생각도 들긴 하네요.

지금은 정해진 태그로 필터링하는 형식으로 기획되어있어서, 권한은 나중에 풀어도 괜찮을 것 같아요.

limehee · 2024-12-16T10:02:36Z

src/main/java/page/clab/api/domain/community/hashtag/domain/Hashtag.java

+public class Hashtag {
+
+    Long id;
+    String name;


해시태그의 중복 등록을 방지하기 위해 유니크 제약 조건을 추가하는 것이 필요해 보여요.

limehee · 2024-12-16T10:02:56Z

.../clab/api/external/community/board/application/port/ExternalRetrieveBoardHashtagUseCase.java

+import page.clab.api.domain.community.board.domain.BoardHashtag;
+
+public interface ExternalRetrieveBoardHashtagUseCase {
+    List<BoardHashtagResponseDto> getBoardHashtagInfoByBoardId(Long boardId);


{와 메소드 선언부 사이에 개행이 누락되었어요.

limehee · 2024-12-16T10:04:25Z

...ab/api/external/community/board/application/service/ExternalBoardHashtagRegisterService.java

+        for (Long hashtagId : requestDto.getHashtagIdList()) {
+            if (!externalRetrieveHashtagUseCase.existById(hashtagId)) {
+                throw new NotFoundException("[Hashtag] id: " + hashtagId + "에 해당하는 해시태그가 존재하지 않습니다.");
+            };


해당 내용은 getById() 메소드를 추가로 작성하여, PersistenceAdapter에서 담당하도록 하는게 책임 분리에 더욱 적합해 보여요.

limehee · 2024-12-16T10:05:09Z

...ain/java/page/clab/api/external/hashtag/application/port/ExternalRetrieveHashtagUseCase.java

+import page.clab.api.domain.community.hashtag.domain.Hashtag;
+
+public interface ExternalRetrieveHashtagUseCase {
+    Hashtag getById(Long id);


{와 메소드 선언부 사이에 개행이 누락되었어요.

SongJaeHoonn

작업량이 정말 많으셨을 것 같은데, 빠르게 진행해주신 것 같아 놀랐습니다! 고생하셨습니다.

일단, 저는 해시태그에 대해 그냥 List<String>으로 관리하고, Board를 저장할 때에도 String으로 받아 개발 질문 게시글에 대해서만 반환하도록 하는 걸로 간단하게 생각했었는데, Hashtag라는 새로운 도메인을 만드실 줄은 몰랐습니다..!
HashTag 엔티티를 사용하는게 아니라 그냥 String으로만 관리하면 간단할 것 같은데 Hashtag 도메인을 새로 구현하신 이유가 있으신지 궁금합니다.

SongJaeHoonn · 2024-12-20T03:44:20Z

.../page/clab/api/domain/community/board/adapter/in/web/BoardsByHashtagRetrievalController.java

+            "현재는 카테고리가 개발질문인 게시글만 해시태그가 적용되어 있어서 해당 API의 응답으로 개발질문 게시판만 반환됨")
+    @PreAuthorize("hasRole('GUEST')")
+    @GetMapping("/hashtag")
+    public ApiResponse<PagedResponseDto<BoardOverviewResponseDto>> retrieveBoardsByCategory(


이부분 메서드 네임을 retrieveBoardsByHashtag로 변경해도 괜찮을 것 같아요

SongJaeHoonn · 2024-12-20T04:00:28Z

.../clab/api/domain/community/board/adapter/out/persistence/BoardHashtagPersistenceAdapter.java

+    }
+
+    @Override
+    public List<BoardHashtag> getAllByBoardId(Long boardId) {


이전에 코드베이스 전반 검토할 때, findBy는 예외처리를 하지 않고 조회하는 메서드, getBy는 예외처리까지 포함되어 조회하는 메서드에 적용하기로 했어서, 작업하신 메서드 이름들을 올바른 이름으로 바꾸는 작업이 필요할 것 같아요.

SongJaeHoonn · 2024-12-20T04:11:00Z

.../java/page/clab/api/domain/community/board/application/dto/mapper/BoardHashtagDtoMapper.java

+                .build();
+    }
+
+    public BoardHashtagRequestDto toDto(Long boardId, List<Long> hashtagIdList) {


List<Long> hashtagIdList -> List<Long> hashtagIds
저희 프로젝트에서 리스트를 변수로 표현할 때 뒤에 List를 붙이는 게 아니라 복수형으로 표현하는 것으로 알고있어서 변경 제안 드립니다.

SongJaeHoonn · 2024-12-20T04:31:41Z

...main/java/page/clab/api/domain/community/board/application/service/BoardRegisterService.java

+            throw new InvalidBoardCategoryHashtagException("개발질문 게시판에만 해시태그를 등록할 수 있습니다.");
+        }
+        if (savedBoard.isDevelopmentQna() && requestDto.getHashtagIdList() != null) {
+            externalRegisterBoardHashtagUseCase.registerBoardHashtag(boardHashtagDtoMapper.toDto(savedBoard.getId(), requestDto.getHashtagIdList()));


제가 잘못 이해하고 있는건지는 모르겠지만, 굳이 BoardHashtag 등록을 external에서 끌고와서 해야 하는지 모르겠습니다.
Board도메인 안에서 처리가 불가능한 것인가요?

Board 도메인 내에서 BoardHashtag의 저장 및 조회를 externalRegisterBoardHashtagUseCase, externalRetrieveBoardHashtagUseCase를 통해 수행하고 있는 것 같은데, Board도메인의 서비스 계층에서 담당해도 괜찮지 않을까 생각합니다.

SongJaeHoonn · 2024-12-20T04:45:02Z

src/main/java/page/clab/api/domain/community/board/application/service/BoardUpdateService.java

+                    });
+        });
+
+        hashtagsToAdd.forEach(idToAdd -> addHashtag(board.getId(), idToAdd, currentBoardHashtags));


BoardHashtag를 업데이트하는 주요 비즈니스 로직인데, 메서드 하나에 너무 많은 로직이 들어가 있기도 하고, 인덴트도 깊어서 보기 힘들거나 이해하는데 오랜 시간이 소요될 수 있을 것 같아요.
인덴트가 깊거나 한 줄이 너무 긴 부분은 메서드로 추출해서 로직의 흐름을 한 눈에 파악할 수 있도록 하는 것도 괜찮아 보입니다.

SongJaeHoonn · 2024-12-20T04:50:33Z

...in/java/page/clab/api/domain/community/hashtag/adapter/in/web/HashtagRegisterController.java

+
+    private final RegisterHashtagUseCase registerHashtagUseCase;
+
+    @Operation(summary = "[U] 해시태그 생성", description = "ROLE_USER 이상의 권한이 필요함")


제가 생각했을 때에는 velog에서 해시태그를 추가할 때처럼, 사용자가 직접 본인만의 해시태그를 만들어서 추가하는 방식으로 하면 원하는 해시태그가 없을 때에도 손쉽게 추가할 수 있어 자유도가 증가할 것이라고 생각했는데,
블로그의 게시글과 커뮤니티 게시글의 특성이 다르다보니 해시태그가 악용될 수 있다는 생각도 들긴 하네요.

SongJaeHoonn · 2024-12-20T04:52:27Z

...ain/java/page/clab/api/domain/community/hashtag/application/dto/mapper/HashtagDtoMapper.java

+@RequiredArgsConstructor
+public class HashtagDtoMapper {
+
+    public Hashtag fromDto(String name) {


이부분은 Dto에서 Hashtag를 생성하는 것이 아니기 때문에 메서드 이름을 of로 해야 맞을 것 같아요.

SongJaeHoonn · 2024-12-20T04:52:53Z

.../java/page/clab/api/domain/community/hashtag/application/port/in/RetrieveHashtagUseCase.java

+
+import page.clab.api.domain.community.hashtag.domain.Hashtag;
+
+public interface RetrieveHashtagUseCase {


개행이 필요할 것 같습니다.

SongJaeHoonn · 2024-12-20T04:53:14Z

...in/java/page/clab/api/domain/community/hashtag/application/port/out/RegisterHashtagPort.java

+
+public interface RegisterHashtagPort {
+    Hashtag save(Hashtag hashtag);
+


개행을 하지 않아도 될 것 같습니다.

mingmingmon added 9 commits December 14, 2024 12:12

feat(Hashtag): Hashtag와 BoardHashtag 관련 entity와 domain 객체 설계

443535b

feat(HashtagRegister): 해시태그 등록 api 작성

2c83f45

feat(BoardRegister): 게시글 생성 시 개발질문 카테고리인 경우 해시태그 저장 로직 추가

6480448

refactor(BoardDtoMapper): 게시판 관련 응답 시 해시태그 정보를 포함하도록 수정

3f32633

feat(BoardUpdate): 게시글 수정 시 해시태그의 변경 로직 추가

1ca7590

feat(BoardsByHashtagRetrievalController): 해시태그로 게시글 조회하는 API 작성

6b2a81e

fix(BoardsByHashtagRetrievalService): 잘못된 페이지네이션 수정

4c4a70d

refactor(BoardRegisterController): 개발질문 게시판이 아닌 게시판에 해시태그 등록할 경우 예외발생…

8496bd4

… 하도록 수정

fix(BoardRegisterService, BoardUpdateService): 개발질문 카테고리가 아닌 경우 해시태그 …

c85f96b

…설정 시 예외처리

mingmingmon added the ✨ Feature 새로운 기능 명세 및 개발 label Dec 15, 2024

mingmingmon self-assigned this Dec 15, 2024

mingmingmon requested a review from limehee as a code owner December 15, 2024 06:13

mingmingmon requested a review from SongJaeHoonn December 15, 2024 06:13

limehee linked an issue Dec 16, 2024 that may be closed by this pull request

개발 질문 게시판에 해시태그 기능 추가 #609

Open

5 tasks

limehee requested changes Dec 16, 2024

View reviewed changes

SongJaeHoonn requested changes Dec 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 개발질문 게시판의 해시태그 기능 구현 완료 #629

feat: 개발질문 게시판의 해시태그 기능 구현 완료 #629

mingmingmon commented Dec 15, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

SongJaeHoonn Dec 20, 2024

limehee Dec 20, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

limehee Dec 16, 2024

SongJaeHoonn left a comment

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024

SongJaeHoonn Dec 20, 2024


		private final RegisterHashtagUseCase registerHashtagUseCase;

		@Operation(summary = "[U] 해시태그 생성", description = "ROLE_USER 이상의 권한이 필요함")


		import page.clab.api.domain.community.hashtag.domain.Hashtag;

		public interface RetrieveHashtagUseCase {


		public interface RegisterHashtagPort {
		Hashtag save(Hashtag hashtag);

feat: 개발질문 게시판의 해시태그 기능 구현 완료 #629

Are you sure you want to change the base?

feat: 개발질문 게시판의 해시태그 기능 구현 완료 #629

Conversation

mingmingmon commented Dec 15, 2024

Summary

Tasks

ETC

SQL문

Screenshot

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SongJaeHoonn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment