feat: 커뮤니티 게시글 검색 조회 (RDB) (#248)

ayoung-dev · web-flow · commit 955ee8693833 · 2024-12-18T15:09:38.000+09:00
* refactor(community): 전체 조회, 검색 조회 메서드 통합

* refactor(community): 전체 조회 수정 및 검색 조회 엔드포인트 추가

* test(community): 전체 조회 테스트 수정 및 검색 조회 테스트 추가

* chore(community): 불필요한 import 제거

* chore(community): 개행 수정
diff --git a/src/main/java/com/somemore/community/controller/CommunityBoardQueryApiController.java b/src/main/java/com/somemore/community/controller/CommunityBoardQueryApiController.java
@@ -30,7 +30,7 @@ public ApiResponse<Page<CommunityBoardResponseDto>> getAll(
     ) {
         return ApiResponse.ok(
                 200,
-                communityBoardQueryUseCase.getCommunityBoards(pageable.getPageNumber()),
+                communityBoardQueryUseCase.getCommunityBoards(null, pageable.getPageNumber()),
                 "전체 커뮤니티 게시글 리스트 조회 성공"
         );
     }
@@ -61,6 +61,19 @@ public ApiResponse<Page<CommunityBoardResponseDto>> getByWriterId(
 //        );
 //    }
 
+    @GetMapping("/community-boards/search")
+    @Operation(summary = "커뮤니티 게시글 키워드 검색", description = "키워드를 포함한 커뮤니티 게시글 목록을 조회합니다.")
+    public ApiResponse<Page<CommunityBoardResponseDto>> getCommunityBoardsBySearch(
+            @RequestParam String keyword,
+            Pageable pageable
+    ) {
+        return ApiResponse.ok(
+                200,
+                communityBoardQueryUseCase.getCommunityBoards(keyword, pageable.getPageNumber()),
+                "커뮤니티 게시글 검색 리스트 조회 성공"
+        );
+    }
+
     @GetMapping("/community-board/{id}")
     @Operation(summary = "커뮤니티 게시글 상세 조회", description = "커뮤니티 게시글의 상세 정보를 조회합니다.")
     public ApiResponse<CommunityBoardDetailResponseDto> getById(
diff --git a/src/main/java/com/somemore/community/repository/board/CommunityBoardRepository.java b/src/main/java/com/somemore/community/repository/board/CommunityBoardRepository.java
@@ -12,7 +12,7 @@
 public interface CommunityBoardRepository {
     CommunityBoard save(CommunityBoard communityBoard);
     Optional<CommunityBoard> findById(Long id);
-    Page<CommunityBoardView> findCommunityBoards(Pageable pageable);
+    Page<CommunityBoardView> findCommunityBoards(String keyword, Pageable pageable);
     Page<CommunityBoardView> findByWriterId(UUID writerId, Pageable pageable);
     boolean existsById(Long id);
     default boolean doesNotExistById(Long id) {
diff --git a/src/main/java/com/somemore/community/repository/board/CommunityBoardRepositoryImpl.java b/src/main/java/com/somemore/community/repository/board/CommunityBoardRepositoryImpl.java
@@ -9,6 +9,7 @@
 import com.somemore.community.domain.QCommunityBoard;
 import com.somemore.volunteer.domain.QVolunteer;
 import lombok.RequiredArgsConstructor;
+import org.apache.commons.lang3.StringUtils;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.support.PageableExecutionUtils;
@@ -44,9 +45,10 @@ public Optional<CommunityBoard> findById(Long id) {
     }
 
     @Override
-    public Page<CommunityBoardView> findCommunityBoards(Pageable pageable) {
+    public Page<CommunityBoardView> findCommunityBoards(String keyword, Pageable pageable) {
         List<CommunityBoardView> content = getCommunityBoardsQuery()
-                .where(isNotDeleted())
+                .where(isNotDeleted()
+                        .and(keywordEq(keyword)))
                 .offset(pageable.getOffset())
                 .limit(pageable.getPageSize())
                 .fetch();
@@ -55,7 +57,8 @@ public Page<CommunityBoardView> findCommunityBoards(Pageable pageable) {
                 .select(communityBoard.count())
                 .from(communityBoard)
                 .join(volunteer).on(communityBoard.writerId.eq(volunteer.id))
-                .where(isNotDeleted());
+                .where(isNotDeleted()
+                        .and(keywordEq(keyword)));
 
         return PageableExecutionUtils.getPage(content, pageable, countQuery::fetchOne);
     }
@@ -160,6 +163,12 @@ private BooleanExpression isNotDeleted() {
 
     private BooleanExpression isWriter(UUID writerId) {return communityBoard.writerId.eq(writerId); }
 
+    private BooleanExpression keywordEq(String keyword) {
+        return StringUtils.isNotBlank(keyword)
+                ? communityBoard.title.containsIgnoreCase(keyword)
+                : null;
+    }
+
 //    private List<CommunityBoardDocument> getBoardDocuments(String keyword) {
 //
 //        if (keyword == null || keyword.isEmpty()) {
diff --git a/src/main/java/com/somemore/community/service/board/CommunityBoardQueryService.java b/src/main/java/com/somemore/community/service/board/CommunityBoardQueryService.java
@@ -28,9 +28,9 @@ public class CommunityBoardQueryService implements CommunityBoardQueryUseCase {
     private static final int PAGE_SIZE = 10;
 
     @Override
-    public Page<CommunityBoardResponseDto> getCommunityBoards(int page) {
+    public Page<CommunityBoardResponseDto> getCommunityBoards(String keyword, int page) {
         Pageable pageable = PageRequest.of(page, PAGE_SIZE);
-        Page<CommunityBoardView> boards = communityBoardRepository.findCommunityBoards(pageable);
+        Page<CommunityBoardView> boards = communityBoardRepository.findCommunityBoards(keyword, pageable);
         return boards.map(CommunityBoardResponseDto::from);
     }
 
diff --git a/src/main/java/com/somemore/community/usecase/board/CommunityBoardQueryUseCase.java b/src/main/java/com/somemore/community/usecase/board/CommunityBoardQueryUseCase.java
@@ -9,7 +9,7 @@
 import java.util.UUID;
 
 public interface CommunityBoardQueryUseCase {
-    Page<CommunityBoardResponseDto> getCommunityBoards(int page);
+    Page<CommunityBoardResponseDto> getCommunityBoards(String keyword, int page);
     Page<CommunityBoardResponseDto> getCommunityBoardsByWriterId(UUID writerId, int page);
     CommunityBoardDetailResponseDto getCommunityBoardDetail(Long id);
     List<CommunityBoard> getAllCommunityBoards();
diff --git a/src/test/java/com/somemore/community/controller/CommunityBoardQueryApiControllerTest.java b/src/test/java/com/somemore/community/controller/CommunityBoardQueryApiControllerTest.java
@@ -42,7 +42,7 @@ void getAll() throws Exception {
         //given
         Page<CommunityBoardResponseDto> page = new PageImpl<>(Collections.emptyList());
 
-        given(communityBoardQueryUseCase.getCommunityBoards(anyInt()))
+        given(communityBoardQueryUseCase.getCommunityBoards(any(), anyInt()))
                 .willReturn(page);
 
         //when
@@ -56,7 +56,7 @@ void getAll() throws Exception {
                         .value("전체 커뮤니티 게시글 리스트 조회 성공"));
 
         verify(communityBoardQueryUseCase, times(1))
-                .getCommunityBoards(anyInt());
+                .getCommunityBoards(any(), anyInt());
     }
 
     @Test
@@ -106,6 +106,29 @@ void getById() throws Exception {
                 .getCommunityBoardDetail(any());
     }
 
+    @Test
+    @DisplayName("커뮤니티 게시글 검색 조회 성공")
+    void getBySearch() throws Exception {
+        //given
+        Page<CommunityBoardResponseDto> page = new PageImpl<>(Collections.emptyList());
+
+        given(communityBoardQueryUseCase.getCommunityBoards(any(), anyInt()))
+                .willReturn(page);
+        //when
+        //then
+        mockMvc.perform(get("/api/community-boards/search")
+                        .param("keyword", "봉사")
+                        .accept(MediaType.APPLICATION_JSON))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$.code").value(200))
+                .andExpect(jsonPath("$.data").exists())
+                .andExpect(jsonPath("$.message")
+                        .value("커뮤니티 게시글 검색 리스트 조회 성공"));
+
+        verify(communityBoardQueryUseCase, times(1))
+                .getCommunityBoards(any(), anyInt());
+    }
+
 //    @Test
 //    @DisplayName("커뮤니티 게시글 검색 조회 성공")
 //    void getBySearch() throws Exception {
diff --git a/src/test/java/com/somemore/community/repository/CommunityBoardRepositoryTest.java b/src/test/java/com/somemore/community/repository/CommunityBoardRepositoryTest.java
@@ -99,7 +99,7 @@ void getCommunityBoards() {
         Pageable pageable = getPageable();
 
         //when
-        Page<CommunityBoardView> communityBoards = communityBoardRepository.findCommunityBoards(pageable);
+        Page<CommunityBoardView> communityBoards = communityBoardRepository.findCommunityBoards(null, pageable);
 
         //then
         assertThat(communityBoards).isNotNull();
@@ -138,6 +138,27 @@ void existsById() {
         assertThat(isExist).isTrue();
     }
 
+    @DisplayName("검색 키워드가 포함된 커뮤니티 게시글을 페이지로 조회할 수 있다. (Repository)")
+    @Test
+    void getCommunityBoardsBySearch() {
+
+        //given
+        Pageable pageable = getPageable();
+
+        String title = "봉사";
+        CommunityBoard communityBoard = createCommunityBoard(title, writerId);
+        communityBoardRepository.save(communityBoard);
+
+        //when
+        Page<CommunityBoardView> communityBoards = communityBoardRepository.findCommunityBoards("봉사", pageable);
+
+        //then
+        assertThat(communityBoards).isNotNull();
+        assertThat(communityBoards.getTotalElements()).isEqualTo(1);
+        assertThat(communityBoards.getSize()).isEqualTo(10);
+        assertThat(communityBoards.getNumber()).isZero();
+    }
+
 //    @DisplayName("게시글을 elastic search index에 저장할 수 있다. (repository)")
 //    @Test
 //    void saveDocuments() {
diff --git a/src/test/java/com/somemore/community/service/board/CommunityBoardQueryServiceTest.java b/src/test/java/com/somemore/community/service/board/CommunityBoardQueryServiceTest.java
@@ -92,7 +92,7 @@ void getAllCommunityBoards() {
 
         //given
         //when
-        Page<CommunityBoardResponseDto> dtos = communityBoardQueryService.getCommunityBoards(2);
+        Page<CommunityBoardResponseDto> dtos = communityBoardQueryService.getCommunityBoards(null, 2);
 
         //then
         assertThat(dtos).isNotNull();
@@ -149,6 +149,26 @@ void getCommunityBoardDetailWithDeletedId() {
                 .withMessage(ExceptionMessage.NOT_EXISTS_COMMUNITY_BOARD.getMessage());
     }
 
+    @DisplayName("검색 키워드가 포함된 커뮤니티 게시글 리스트를 페이지로 조회한다.")
+    @Test
+    void getCommunityBoardsBySearch() {
+
+        //given
+        String title = "봉사";
+        CommunityBoard communityBoard = createCommunityBoard(title, writerId1);
+        communityBoardRepository.save(communityBoard);
+
+        //when
+        Page<CommunityBoardResponseDto> dtos = communityBoardQueryService.getCommunityBoards("봉사", 0);
+
+        //then
+        assertThat(dtos).isNotNull();
+        assertThat(dtos.getContent()).isNotNull();
+        assertThat(dtos.getTotalElements()).isEqualTo(1);
+        assertThat(dtos.getSize()).isEqualTo(10);
+        assertThat(dtos.getTotalPages()).isEqualTo(1);
+    }
+
 //    @DisplayName("게시글을 elastic search index에 저장한다. (service)")
 //    @Test
 //    void saveCommunityBoardDocuments() {
diff --git a/src/test/java/com/somemore/community/service/board/DeleteCommunityBoardServiceTest.java b/src/test/java/com/somemore/community/service/board/DeleteCommunityBoardServiceTest.java
@@ -59,7 +59,7 @@ void deleteCommunityBoardWithId() {
         deleteCommunityBoardService.deleteCommunityBoard(writerId, communityId);
 
         //then
-        assertThat(communityBoardQueryUseCase.getCommunityBoards(0)).isEmpty();
+        assertThat(communityBoardQueryUseCase.getCommunityBoards(null, 0)).isEmpty();
     }
 
     @DisplayName("삭제된 커뮤니티 게시글의 id로 게시글을 삭제할 때 예외를 던진다.")

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ void deleteCommunityBoardWithId() {`
`59`	`59`	`deleteCommunityBoardService.deleteCommunityBoard(writerId, communityId);`
`60`	`60`
`61`	`61`	`//then`
`62`		`- assertThat(communityBoardQueryUseCase.getCommunityBoards(0)).isEmpty();`
	`62`	`+ assertThat(communityBoardQueryUseCase.getCommunityBoards(null, 0)).isEmpty();`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`@DisplayName("삭제된 커뮤니티 게시글의 id로 게시글을 삭제할 때 예외를 던진다.")`