신고 조치 예정 목록 조회 기능 구현 (#750)

* feat: (#746) 컨트롤러 및 DTO 구현

* feat: (#746) 신고 조치 예정 목록 조회 기능 구현

* feat: (#746) report 엔티티의 toString 제거

* feat: (#746) String 파싱 로직을 toString으로 개선

* feat: (#746) 인터페이스의 메서드 순서 개선

* refactor: (#746) ReportsResponse DTO 클래스명 개선

* refactor: (#746) 전체 페이지 수 변수명 개선

* refactor: (#746) 전체 페이지 개수 구하는 로직을 쿼리 발생 개수를 줄이기 위해 개선

* refactor: (#746) ReportQueryService의 getReports메서드 로직 가독성 개선

* refactor: (#746) dto 클래스명 개선

* refactor: (#746) 서비스 import문 정리

* refactor: (#746) 커스텀 데이터를 조회할 시, 엔티티 대신 DTO로 받는 것으로 개선

* refactor: (#746) final 키워드 붙이기

* :refactor: (#746) parseTarget 로직 변경

* refactor: (#746) 테스트 displayName 수정

* refactor: (#746) repository 메서드명 수정

backend/src/main/java/com/votogether/domain/report/controller/ReportCommandCommandController.java → backend/src/main/java/com/votogether/domain/report/controller/ReportCommandController.java

@@ -13,7 +13,7 @@
 
 @RequiredArgsConstructor
 @RestController
-public class ReportCommandCommandController implements ReportCommandControllerDocs {
+public class ReportCommandController implements ReportCommandControllerDocs {
 
  private final ReportCommandService reportCommandService;
 

backend/src/main/java/com/votogether/domain/report/controller/ReportQueryController.java

@@ -0,0 +1,28 @@
+package com.votogether.domain.report.controller;
+
+import com.votogether.domain.report.dto.response.ReportPageResponse;
+import com.votogether.domain.report.service.ReportQueryService;
+import jakarta.validation.constraints.PositiveOrZero;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@Validated
+@RequiredArgsConstructor
+@RestController
+public class ReportQueryController implements ReportQueryControllerDocs {
+
+ private final ReportQueryService reportQueryService;
+
+ @GetMapping("/reports/admin")
+ public ResponseEntity<ReportPageResponse> getReports(
+ @RequestParam @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page
+ ) {
+ final ReportPageResponse reportPageResponse = reportQueryService.getReports(page);
+ return ResponseEntity.ok(reportPageResponse);
+ }
+
+}

backend/src/main/java/com/votogether/domain/report/controller/ReportQueryControllerDocs.java

@@ -0,0 +1,33 @@
+package com.votogether.domain.report.controller;
+
+import com.votogether.domain.report.dto.response.ReportPageResponse;
+import com.votogether.global.exception.ExceptionResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.validation.constraints.PositiveOrZero;
+import org.springframework.http.ResponseEntity;
+
+@Tag(name = "신고 조회", description = "신고 조회 API")
+public interface ReportQueryControllerDocs {
+
+ @Operation(summary = "신고 조치 예정 목록 조회", description = "신고 조치 예정 목록을 조회한다.")
+ @ApiResponses({
+ @ApiResponse(
+ responseCode = "200",
+ description = "신고 조치 예정 목록 조회 성공"
+ ),
+ @ApiResponse(
+ responseCode = "400",
+ description = "0이상의 정수가 아닌 페이지",
+ content = @Content(schema = @Schema(implementation = ExceptionResponse.class))
+ )
+ })
+ ResponseEntity<ReportPageResponse> getReports(
+ @PositiveOrZero(message = "페이지는 0이상 정수만 가능합니다.") final int page
+ );
+
+}

backend/src/main/java/com/votogether/domain/report/dto/ReportAggregateDto.java

@@ -0,0 +1,13 @@
+package com.votogether.domain.report.dto;
+
+import com.votogether.domain.report.entity.vo.ReportType;
+import java.time.LocalDateTime;
+
+public record ReportAggregateDto(
+ long reportMaxId,
+ ReportType reportType,
+ long targetId,
+ String reasons,
+ LocalDateTime createdAt
+) {
+}

backend/src/main/java/com/votogether/domain/report/dto/response/ReportPageResponse.java

@@ -0,0 +1,30 @@
+package com.votogether.domain.report.dto.response;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.util.List;
+
+@Schema(description = "신고 조치 예정 목록 응답")
+public record ReportPageResponse(
+ @Schema(description = "신고 조치 예정 목록 전체 페이지 수", example = "20")
+ long totalPageNumber,
+
+ @Schema(description = "신고 조치 예정 목록 중 현재 페이지", example = "3")
+ long currentPageNumber,
+
+ @Schema(description = "신고 조치 예정 목록")
+ List<ReportResponse> reports
+) {
+
+ public static ReportPageResponse of(
+ final int totalPageNumber,
+ final int currentPageNumber,
+ final List<ReportResponse> reportResponses
+ ) {
+ return new ReportPageResponse(
+ totalPageNumber,
+ currentPageNumber,
+ reportResponses
+ );
+ }
+
+}

backend/src/main/java/com/votogether/domain/report/dto/response/ReportResponse.java

@@ -0,0 +1,41 @@
+package com.votogether.domain.report.dto.response;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.votogether.domain.report.dto.ReportAggregateDto;
+import com.votogether.domain.report.entity.Report;
+import com.votogether.domain.report.entity.vo.ReportType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.time.LocalDateTime;
+import java.util.Arrays;
+import java.util.List;
+
+@Schema(description = "신고 정보 응답")
+public record ReportResponse(
+ @Schema(description = "신고 ID", example = "1")
+ long id,
+
+ @Schema(description = "신고 유형", example = "POST")
+ ReportType type,
+
+ @Schema(description = "신고 이유들")
+ List<String> reasons,
+
+ @Schema(description = "신고 당한 요소의 내용", example = "2")
+ String target,
+
+ @Schema(description = "신고 생성시간", example = "2023-08-01 13:56")
+ @JsonFormat(pattern = "yyyy-MM-dd HH:mm")
+ LocalDateTime createdAt
+) {
+
+ public static ReportResponse of(final ReportAggregateDto reportAggregateDto, final String target) {
+ return new ReportResponse(
+ reportAggregateDto.reportMaxId(),
+ reportAggregateDto.reportType(),
+ Arrays.stream(reportAggregateDto.reasons().split(",")).toList(),
+ target,
+ reportAggregateDto.createdAt()
+ );
+ }
+
+}

backend/src/main/java/com/votogether/domain/report/repository/ReportCustomRepository.java

@@ -0,0 +1,11 @@
+package com.votogether.domain.report.repository;
+
+import com.votogether.domain.report.dto.ReportAggregateDto;
+import java.util.List;
+import org.springframework.data.domain.Pageable;
+
+public interface ReportCustomRepository {
+
+ List<ReportAggregateDto> findReportsGroupedByReportTypeAndTargetId(final Pageable pageable);
+
+}

backend/src/main/java/com/votogether/domain/report/repository/ReportCustomRepositoryImpl.java

@@ -0,0 +1,40 @@
+package com.votogether.domain.report.repository;
+
+import static com.votogether.domain.report.entity.QReport.report;
+
+import com.querydsl.core.types.Projections;
+import com.querydsl.core.types.dsl.Expressions;
+import com.querydsl.jpa.impl.JPAQueryFactory;
+import com.votogether.domain.report.dto.ReportAggregateDto;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Pageable;
+import org.springframework.stereotype.Repository;
+
+@RequiredArgsConstructor
+@Repository
+public class ReportCustomRepositoryImpl implements ReportCustomRepository {
+
+ private final JPAQueryFactory jpaQueryFactory;
+
+ @Override
+ public List<ReportAggregateDto> findReportsGroupedByReportTypeAndTargetId(final Pageable pageable) {
+ return jpaQueryFactory.select(
+ Projections.constructor(
+ ReportAggregateDto.class,
+ report.id.max(),
+ report.reportType,
+ report.targetId,
+ Expressions.stringTemplate("group_concat({0})", report.reason),
+ report.createdAt.max()
+ )
+ )
+ .from(report)
+ .orderBy(report.id.max().desc())
+ .groupBy(report.reportType, report.targetId)
+ .offset(pageable.getOffset())
+ .limit(pageable.getPageSize())
+ .fetch();
+ }
+
+}

backend/src/main/java/com/votogether/domain/report/repository/ReportRepository.java

@@ -10,7 +10,7 @@
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 
-public interface ReportRepository extends JpaRepository<Report, Long> {
+public interface ReportRepository extends JpaRepository<Report, Long>, ReportCustomRepository {
 
  int countByReportTypeAndTargetId(final ReportType reportType, final Long targetId);
 

backend/src/main/java/com/votogether/domain/report/service/ReportCommandService.java

@@ -2,35 +2,21 @@
 
 import com.votogether.domain.member.entity.Member;
 import com.votogether.domain.report.dto.request.ReportRequest;
-import com.votogether.domain.report.entity.vo.ReportType;
-import com.votogether.domain.report.service.strategy.ReportCommentStrategy;
-import com.votogether.domain.report.service.strategy.ReportNicknameStrategy;
-import com.votogether.domain.report.service.strategy.ReportPostStrategy;
+import com.votogether.domain.report.service.strategy.ReportActionProvider;
 import com.votogether.domain.report.service.strategy.ReportStrategy;
-import java.util.EnumMap;
-import java.util.Map;
+import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+@RequiredArgsConstructor
 @Transactional
 @Service
 public class ReportCommandService {
 
- private final Map<ReportType, ReportStrategy> reportActions;
-
- public ReportCommandService(
- final ReportPostStrategy reportPostStrategy,
- final ReportCommentStrategy reportCommentStrategy,
- final ReportNicknameStrategy reportNicknameStrategy
- ) {
- this.reportActions = new EnumMap<>(ReportType.class);
- this.reportActions.put(ReportType.POST, reportPostStrategy);
- this.reportActions.put(ReportType.COMMENT, reportCommentStrategy);
- this.reportActions.put(ReportType.NICKNAME, reportNicknameStrategy);
- }
+ private final ReportActionProvider reportActionProvider;
 
  public void report(final Member reporter, final ReportRequest request) {
- final ReportStrategy reportStrategy = reportActions.get(request.type());
+ final ReportStrategy reportStrategy = reportActionProvider.getStrategy(request.type());
  reportStrategy.report(reporter, request);
  }
 

backend/src/main/java/com/votogether/domain/report/service/ReportQueryService.java

@@ -0,0 +1,50 @@
+package com.votogether.domain.report.service;
+
+import com.votogether.domain.report.dto.ReportAggregateDto;
+import com.votogether.domain.report.dto.response.ReportResponse;
+import com.votogether.domain.report.dto.response.ReportPageResponse;
+import com.votogether.domain.report.repository.ReportRepository;
+import com.votogether.domain.report.service.strategy.ReportActionProvider;
+import com.votogether.domain.report.service.strategy.ReportStrategy;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Pageable;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@RequiredArgsConstructor
+@Transactional(readOnly = true)
+@Service
+public class ReportQueryService {
+
+ private static final int BASIC_PAGE_SIZE = 20;
+
+ private final ReportRepository reportRepository;
+ private final ReportActionProvider reportActionProvider;
+
+ public ReportPageResponse getReports(final int page) {
+ final long totalCount = reportRepository.count();
+ final int totalPageNumber = (int) Math.ceil((double) totalCount / BASIC_PAGE_SIZE);
+
+ final Pageable pageable = PageRequest.of(page, BASIC_PAGE_SIZE);
+ final List<ReportAggregateDto> reportAggregateDtos = reportRepository
+ .findReportsGroupedByReportTypeAndTargetId(pageable);
+ final List<ReportResponse> reportResponses = parseReportResponses(reportAggregateDtos);
+
+ return ReportPageResponse.of(totalPageNumber, page, reportResponses);
+ }
+
+ private List<ReportResponse> parseReportResponses(final List<ReportAggregateDto> reportAggregateDtos) {
+ return reportAggregateDtos.stream()
+ .map(this::parseReportResponse)
+ .toList();
+ }
+
+ private ReportResponse parseReportResponse(final ReportAggregateDto reportAggregateDto) {
+ final ReportStrategy strategy = reportActionProvider.getStrategy(reportAggregateDto.reportType());
+ return ReportResponse.of(reportAggregateDto, strategy.parseTarget(reportAggregateDto.targetId()));
+ }
+
+}
+

backend/src/main/java/com/votogether/domain/report/service/strategy/ReportActionProvider.java

@@ -0,0 +1,28 @@
+package com.votogether.domain.report.service.strategy;
+
+import com.votogether.domain.report.entity.vo.ReportType;
+import java.util.EnumMap;
+import java.util.Map;
+import org.springframework.stereotype.Component;
+
+@Component
+public class ReportActionProvider {
+
+ private final Map<ReportType, ReportStrategy> reportActions;
+
+ public ReportActionProvider(
+ final ReportPostStrategy reportPostStrategy,
+ final ReportCommentStrategy reportCommentStrategy,
+ final ReportNicknameStrategy reportNicknameStrategy
+ ) {
+ this.reportActions = new EnumMap<>(ReportType.class);
+ this.reportActions.put(ReportType.POST, reportPostStrategy);
+ this.reportActions.put(ReportType.COMMENT, reportCommentStrategy);
+ this.reportActions.put(ReportType.NICKNAME, reportNicknameStrategy);
+ }
+
+ public ReportStrategy getStrategy(ReportType type) {
+ return reportActions.get(type);
+ }
+
+}

backend/src/main/java/com/votogether/domain/report/service/strategy/ReportCommentStrategy.java

@@ -65,4 +65,11 @@ private void validateCommentMine(final Comment comment, final Member member) {
  }
  }
 
+ @Override
+ public String parseTarget(final Long targetId) {
+ final Comment reportedComment = commentRepository.findById(targetId)
+ .orElseThrow(() -> new NotFoundException(CommentExceptionType.NOT_FOUND));
+ return reportedComment.getContent();
+ }
+
 }

backend/src/main/java/com/votogether/domain/report/service/strategy/ReportNicknameStrategy.java

@@ -56,4 +56,11 @@ private void changeNicknameByReport(final Member reportedMember, final ReportReq
  }
  }
 
+ @Override
+ public String parseTarget(final Long targetId) {
+ final Member reportedMember = memberRepository.findById(targetId)
+ .orElseThrow(() -> new NotFoundException(MemberExceptionType.NONEXISTENT_MEMBER));
+ return reportedMember.getNickname();
+ }
+
 }

backend/src/main/java/com/votogether/domain/report/service/strategy/ReportPostStrategy.java

@@ -65,4 +65,9 @@ private void validatePostMine(final Post post, final Member member) {
  }
  }
 
+ @Override
+ public String parseTarget(final Long targetId) {
+ return targetId.toString();
+ }
+
 }

backend/src/main/java/com/votogether/domain/report/service/strategy/ReportStrategy.java

@@ -7,11 +7,12 @@
 import com.votogether.domain.report.repository.ReportRepository;
 import com.votogether.global.exception.BadRequestException;
 
-@FunctionalInterface
 public interface ReportStrategy {
 
  void report(final Member reporter, final ReportRequest request);
 
+ String parseTarget(Long targetId);
+
  default void validateDuplicatedReport(
  final Member reporter,
  final ReportRequest request,

backend/src/test/java/com/votogether/domain/report/controller/ReportCommandControllerTest.java

@@ -29,7 +29,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.test.web.servlet.MockMvc;
 
-@WebMvcTest(ReportCommandCommandController.class)
+@WebMvcTest(ReportCommandController.class)
 class ReportCommandControllerTest extends ControllerTest {
 
  @MockBean