8000 [Feature] 댓글 어드민 API 개발 by Jinyshin · Pull Request #33 · If-u-Lab/If-u-server · GitHub
[go: up one dir, main page]

Skip to content

[Feature] 댓글 어드민 API 개발 - #33

Merged
Jinyshin merged 4 commits into
devfrom
feature/admin-comments
Dec 27, 2025
Merged

Jinyshin merged 4 commits into
devfrom
feature/admin-comments

Conversation

@Jinyshin
@Jinyshin Jinyshin commented Nov 29, 2025 •
Copy link
Copy Markdown
Member

이전 PR merge 이후에 리뷰 반영하도록 하겠습니다.

🔗 Issue Link

close #20

🎯 What I Did

  • 어드민 댓글 관리 API 구현
    • 전체 댓글 목록 조회 (페이지네이션, 차단 필터링 없이 모든 댓글 조회)
    • 신고된 댓글 목록 조회 (신고 건수 포함, 신고 건수 많은 순 정렬)
    • 댓글 강제 삭제 (소프트 삭제, 삭제 사유 로깅)
  • 댓글 조회 N+1 쿼리 문제 해결 (fetch join 활용)
  • Google Java code style formatting 적용

🔍 Review Points

  • N+1 쿼리 최적화: CommentRepository의 fetch join 쿼리 동작 확인
  • 어드민 권한 체크: ADMIN 권한 검증 로직 확인
  • 신고된 댓글 조회: 신고 건수 집계 및 정렬 로직 검증

🧪 API Test Scenarios

테스트한 엔드포인트

  • GET /api/v1/admin/comments - 전체 댓글 목록 조회
  • GET /api/v1/admin/comments/reports - 신고된 댓글 목록 조회
  • DELETE /api/v1/admin/comments/{commentId} - 댓글 강제 삭제

테스트 시나리오

  1. 정상 플로우

    • 전체 댓글 목록 조회 (페이징, userEmail/replies 포함 확인)
    • 신고된 댓글 목록 조회 (reportCount, 정렬 확인)
    • 댓글 강제 삭제 (삭제 사유 포함, deletedAt 확인)
  2. 에러 케이스

    • 일반 사용자의 어드민 API 호출 → ADMIN_ACCESS_REQUIRED (403)
    • 존재하지 않는 댓글 삭제 → COMMENT_NOT_FOUND (404)
    • 이미 삭제된 댓글 재삭제 → COMMENT_ALREADY_DELETED (400)

✅ Checklist

  • Swagger 문서화 완료 (@Operation, @ApiResponse, @ApiErrorExample(s) 등)
  • 필요시 Notion 문서화 완료

🚀 Notes

  • 이전 PR의 커밋이 포함되어 있는데, merge이후 rebase예정입니다.
  • bc6f789 커밋부터 확인하면 됩니다.
  • 제가 깜빡하고 google style 자동 적용 설정을 안해둬서 이번에 했습니다(😓). 마지막 커밋은 확인하지 않으셔도 괜찮습니다.

@Jinyshin
Jinyshin requested a review from qkrcodus November 29, 2025 16:18
@Jinyshin Jinyshin self-assigned this Nov 29, 2025
@Jinyshin Jinyshin added the enhancement New feature or request label Nov 29, 2025
@Jinyshin
Jinyshin requested review from wngktjd13 and removed request for qkrcodus November 29, 2025 16:19
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @Jinyshin, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

이 PR은 어드민 사용자를 위한 댓글 관리 기능을 도입하고, 기존 댓글 조회 로직의 성능을 최적화하며, 전반적인 코드 품질과 일관성을 향상시키는 데 중점을 둡니다. 어드민은 모든 댓글과 신고된 댓글을 조회하고, 특정 댓글을 강제로 삭제할 수 있습니다. 또한, N+1 쿼리 문제를 해결하여 데이터베이스 부하를 줄이고, Google Java 스타일 가이드를 적용하여 코드 가독성을 높였습니다.

Highlights

  • 어드민 댓글 관리 API 구현: 전체 댓글 목록 조회, 신고된 댓글 목록 조회, 댓글 강제 삭제 기능을 포함하는 어드민용 댓글 관리 API가 구현되었습니다.
  • N+1 쿼리 문제 해결: 댓글 조회 시 발생하던 N+1 쿼리 문제가 fetch join을 활용하여 최적화되었습니다.
  • Google Java 코딩 스타일 적용: 프로젝트 전반에 Google Java 코딩 스타일 포맷팅이 적용되어 코드 일관성이 향상되었습니다.
  • 새로운 코딩 컨벤션 추가: JSON 필드명 camelCase 사용 및 Mapper 계층 활용에 대한 코딩 컨벤션이 CLAUDE.md 문서에 추가되었습니다.
  • 유효성 검사 오류 처리 개선: 유효성 검사 실패 시 첫 번째 필드 에러 메시지를 추출하여 반환하도록 GlobalExceptionHandler가 개선되었습니다.
  • 인증되지 않은 접근 처리 추가: 인증되지 않은 사용자가 보호된 리소스에 접근할 경우 UNAUTHORIZED 응답을 반환하도록 SecurityConfig에 authenticationEntryPoint가 설정되었습니다.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@Jinyshin Jinyshin changed the title Feature/admin comments [Feature] 댓글 어드민 API 개발 Nov 29, 2025
@claude
claude Bot commented Nov 29, 2025
Copy link
Copy Markdown

PR 리뷰

전반적으로 잘 구현된 코드입니다. N+1 쿼리 최적화와 Mapper 계층 분리가 잘 되어있고, 에러 처리도 꼼꼼하게 되어있습니다.

P2 (적극적으로 고려해주세요)

  • AdminCommentController.java:124-131 - 컨트롤러에서 반복적으로 권한 체크하는 로직이 중복됩니다. Spring Security의 @PreAuthorize("hasRole('ADMIN')") 또는 커스텀 AOP를 통해 권한 체크 로직을 분리하면 더 깔끔해집니다.

  • CommentService.java:305-309 - AdminCommentDeleteResponse의 deletedAt을 LocalDateTime.now()로 생성하고 있으나, 엔티티의 deletedAt과 시간 차이가 발생할 수 있습니다. comment.getDeletedAt()을 사용하는 것이 더 정확합니다.

  • CommentService.java:111-152 - 질문이 존재하는지만 확인하고 있습니다. 질문이 삭제되었거나 비공개 상태일 때도 댓글을 조회할 수 있는지 정책 검토가 필요합니다.

P3 (웬만하면 반영해주세요)

  • CommentService.java:213-245, 247-286 - 어드민용 메서드들과 일반 사용자용 메서드에서 대댓글 조회 및 그룹핑 로직이 중복됩니다. private 메서드로 추출하면 유지보수성이 향상됩니다.

  • CommentRepository.java:14-23, 36-42 - fetch join 쿼리가 잘 작성되었으나, 페이징 시 countQuery를 별도로 지정하지 않으면 불필요한 fetch join이 count 쿼리에도 포함될 수 있습니다. @Query의 countQuery 파라미터 추가를 권장합니다.

  • CommentService.java:174-175, 200-201 - findByIdAndDeletedAtIsNull을 사용해 삭제된 사용자를 필터링하고 있으나, 이미 인증된 사용자는 삭제되지 않았을 것으로 예상됩니다. findById 또는 getReferenceById 사용을 검토해보세요.

P4 (반영해도 좋고 넘어가도 좋습니다)

  • AdminReportedCommentListResponse.java:12 - 파일 끝에 빈 줄이 누락되었습니다.
  • AdminReportedCommentResponse.java:20 - 파일 끝에 빈 줄이 누락되었습니다.

전반적으로 코드 품질이 우수하며, N+1 최적화와 Mapper 패턴 적용이 잘 되어있습니다. P2 항목들만 고려해주시면 더욱 견고한 코드가 될 것 같습니다.

@gemini-code-assist gemini-code-assist Bot left a comment
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

이번 PR은 어드민 댓글 관리 API를 구현하고 N+1 쿼리 문제를 해결하는 등 중요한 기능 추가와 개선을 포함하고 있네요. 전반적으로 코드 품질이 우수하며, 특히 fetch join을 활용한 N+1 문제 해결과 Mapper 계층 도입은 매우 좋은 접근 방식입니다.

몇 가지 개선점을 제안드립니다.

  • AdminCommentController에서 반복되는 권한 확인 로직은 성능 저하와 코드 중복을 야기할 수 있으므로, Spring Security의 기능을 활용하거나 AOP를 통해 중앙에서 처리하는 방식을 고려해보시면 좋겠습니다.
  • 댓글 강제 삭제 시 응답으로 반환되는 시간과 실제 데이터베이스에 기록되는 시간이 다를 수 있는 작은 불일치 문제를 수정하여 일관성을 높이는 것을 제안합니다.

이러한 부분들을 개선하면 코드의 유지보수성과 성능이 더욱 향상될 것입니다. 수고 많으셨습니다!

Comment on lines +121 to +131
/**
* ADMIN 권한 체크
*/
private void checkAdminRole(Long userId) {
User user = userRepository.findById(userId)
.orElseThrow(() -> new BusinessException(ErrorCode.USER_NOT_FOUND));

if (user.getRole() != Role.ADMIN) {
throw new BusinessException(ErrorCode.ADMIN_ACCESS_REQUIRED);
}
}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

checkAdminRole 메서드가 컨트롤러의 모든 엔드포인트에서 반복적으로 호출되고 있습니다. 이는 코드 중복을 야기하며, 매번 데이터베이스 조회를 통해 사용자 역할을 확인하므로 비효율적입니다. 이 인가 로직은 더 효율적이고 깔끔하게 처리할 수 있습니다.

개선 제안:

  1. Spring Security 어노테이션 사용: @EnableMethodSecurity를 설정하고, 컨트롤러나 각 메서드에 @PreAuthorize("hasRole('ADMIN')")을 사용하여 선언적으로 권한을 검사할 수 있습니다. 이를 위해서는 JWT 검증 과정에서 사용자의 역할을 GrantedAuthority로 변환하여 Authentication 객체에 포함해야 합니다.
  2. AOP Aspect 활용: AOP를 사용하여 어드민 API에 대한 호출을 가로채 역할 검사를 수행하는 공통 로직을 만들 수 있습니다.
  3. 성능 개선: 성능을 위해, 사용자의 역할을 JWT 페이로드에 포함시키고 Authentication 객체에 저장하여 매 요청마다 데이터베이스를 조회하는 것을 피하는 것이 좋습니다.

현재 구조에서 가장 간단하게 적용할 수 있는 방법은, 반복되는 로직을 별도의 컴포넌트나 서비스로 분리하여 중복을 제거하는 것입니다. 하지만 장기적으로는 Spring Security의 기능을 최대한 활용하는 방향을 권장합니다.

Comment on lines +305 to +309
return new AdminCommentDeleteResponse(
comment.getId(),
true,
LocalDateTime.now()
);
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

forceDeleteComment 메서드에서 AdminCommentDeleteResponse를 생성할 때 LocalDateTime.now()를 사용하여 deletedAt 필드를 채우고 있습니다. 하지만 그 전에 호출되는 comment.delete() 메서드 내부에서도 deletedAt 필드를 LocalDateTime.now()로 설정하고 있습니다. 이로 인해 동일한 삭제 이벤트에 대해 두 개의 약간 다른 타임스탬프가 생성될 수 있습니다. 응답은 엔티티에 실제 기록된 삭제 시간을 반영해야 일관성이 유지됩니다.

comment.delete()가 호출된 후, 엔티티의 deletedAt 값을 사용하여 응답 객체를 생성하는 것을 제안합니다.

Suggested change
return new AdminCommentDeleteResponse(
comment.getId(),
true,
LocalDateTime.now()
);
return new AdminCommentDeleteResponse(
comment.getId(),
true,
comment.getDeletedAt()
);

@Jinyshin
Jinyshin marked this pull request as draft November 29, 2025 16:21
- 전체 댓글 조회 (페이징)
- 신고된 댓글 조회 (신고 건수 내림차순)
- 댓글 강제 삭제 (이유 로깅)
- Admin 전용 DTO 및 Mapper 추가
- ReportedCommentProjection으로 신고 통계 효율적 조회
- 인증 실패 시 일관된 JSON 에러 응답 처리

; Conflicts:
;	src/main/java/com/ifu/ifu_server/domain/comment/service/CommentService.java
@Jinyshin
Jinyshin force-pushed the feature/admin-comments branch from e8133ae to 7510184 Compare December 27, 2025 01:34
@claude
claude Bot commented Dec 27, 2025
Copy link
Copy Markdown

PR 리뷰

전체적으로 어드민 댓글 관리 API가 잘 구현되었습니다. N+1 쿼리 최적화와 신고 건수 집계 로직이 효과적으로 작성되었네요.

P2 (적극적으로 고려해주세요)

  • AdminCommentController.java:124-131 - 어드민 권한 체크를 매 엔드포인트마다 수동으로 수행하고 있습니다. Spring Security의 @PreAuthorize("hasRole('ADMIN')") 또는 커스텀 어노테이션을 사용하면 중복 코드를 제거하고 보안 로직을 선언적으로 관리할 수 있습니다. 현재 방식은 실수로 권한 체크를 빼먹을 위험이 있습니다.

  • CommentService.java:303-307 - deletedAt을 LocalDateTime.now()로 새로 생성하지 말고 엔티티의 실제 deletedAt 값을 반환해야 합니다. 현재는 엔티티에 저장된 시간과 응답의 시간이 수 밀리초 차이날 8000 수 있습니다.

    return new AdminCommentDeleteResponse(
        comment.getId(),
        true,
        comment.getDeletedAt()  // LocalDateTime.now() 대신
    );
  • CommentReportRepository.java:19-28 - JPQL의 GROUP BY c는 Hibernate 특정 기능입니다. JPA 표준에 따르면 모든 non-aggregated 필드를 명시해야 합니다. 데이터베이스나 Hibernate 버전 변경 시 호환성 문제가 발생할 수 있으므로 명시적으로 작성하는 것을 권장합니다.

P3 (웬만하면 반영해주세요)

  • CommentService.java:245-284 - getReportedCommentsForAdmin 메서드가 루트 댓글만 필터링하고 대댓글도 조회하는데, Projection에 대댓글도 포함되어 있다면 두 번 조회됩니다. 로직 검증이 필요합니다.

  • CommentService.java:301 - 삭제 사유(reason)를 로그에만 남기고 있는데, 추후 감사(audit) 목적으로 DB에 저장하는 것을 고려해보세요. 현재는 어드민이 왜 삭제했는지 추적할 방법이 없습니다.

  • AdminCommentController.java:40 - UserRepository를 컨트롤러에서 직접 주입받고 있습니다. 권한 체크 로직은 서비스 계층으로 이동하는 것이 더 적절합니다.

P4 (반영해도 좋고 넘어가도 좋습니다)

  • CommentRepository.java:5 - import 순서: java.time.LocalDateTime가 다른 java.* 패키지들 사이에 끼어있지 않고 분리되어 있습니다. import 순서 정리를 권장합니다.

  • AdminReportedCommentListResponse.java:12 - 파일 끝에 빈 줄이 없는 반면, 다른 DTO 파일들(AdminCommentDeleteRequest.java:10)은 빈 줄이 있습니다. 일관성을 위해 통일하세요.

- checkAdminRole 중복 제거 (Spring Security hasRole 활용)
- AdminCommentController에서 UserRepository 의존성 제거
- 매 요청마다 발생하던 불필요한 DB 조회 제거로 성능 개선
- forceDeleteComment 응답에서 LocalDateTime.now() 대신 comment.getDeletedAt() 사용
- 댓글 조회 시 DRAFT 상태 질문에 대한 접근 차단 추가
- CommentRepository 코드 포맷팅 정리 (들여쓰기 통일)
@Jinyshin
Jinyshin marked this pull request as ready for review December 27, 2025 01:51
@claude
claude Bot commented Dec 27, 2025
Copy link
Copy Markdown

PR 리뷰

전반적으로 어드민 댓글 관리 API 구현이 잘 되어 있고, N+1 문제 해결을 위한 fetch join 활용도 적절합니다. 다만 몇 가지 개선이 필요한 부분이 있어 코멘트 남깁니다.

P1 (꼭 반영해주세요)

  • CommentReportRepository.java:19-28 - GROUP BY 절에서 GROUP BY c를 사용하고 있는데, 이는 Hibernate 특정 구현에 의존합니다. 데이터베이스에 따라 동작하지 않을 수 있으므로 명시적으로 GROUP BY c.id, c.content, c.question.id, ... 등 모든 SELECT 컬럼을 나열해야 합니다.

P2 (적극적으로 고려해주세요)

  • CommentService.java:259-261 - getReportedCommentsForAdmin에서 루트 댓글만 필터링하고 있는데, 신고된 댓글에 대댓글도 포함될 수 있습니다. 현재 로직은 신고된 대댓글의 경우 응답에서 누락됩니다. Projection에서 이미 parentId를 가져오므로 루트/대댓글을 구분해서 처리해야 합니다.

  • CommentReportRepository.java:19-28 - JOIN FETCH를 사용하지 않고 일반 JOIN을 사용했지만, Projection에서 user.email을 직접 접근하므로 N+1 쿼리가 발생할 수 있습니다. JOIN FETCH c.user로 변경을 권장합니다.

  • AdminCommentController.java:97 - forceDeleteComment 메서드에서 adminUserId를 추출하지만 실제로는 ADMIN 권한 검증이 SecurityConfig에만 의존하고 있습니다. 서비스 레이어에서도 명시적으로 권한 체크를 하거나, 최소한 주석으로 SecurityConfig 의존성을 명시하는 것이 좋습니다.

P3 (웬만하면 반영해주세요)

  • CommentService.java:265-267 - 대댓글 조회 쿼리 메서드명이 findByParentIdInWithUser인데, 실제로는 parent.id를 기준으로 조회합니다. 메서드명과 구현이 일치하도록 findByParentIdIn 또는 findRepliesByParentIds 등으로 변경하면 더 명확합니다.

  • CommentService.java:305 - 어드민 삭제 로그가 INFO 레벨인데, 보안/감사 관점에서 중요한 작업이므로 WARN 또는 별도 감사 로그로 남기는 것을 권장합니다.

P4 (반영해도 좋고 넘어가도 좋습니다)

  • AdminCommentReplyResponse.java:15, AdminReportedCommentListResponse.java:12 - 레코드 끝에 불필요한 빈 줄이 있습니다. 일관성을 위해 제거하면 좋습니다.

  • CommentController.java:32-100 - Google Java Style 포맷팅 적용으로 인한 들여쓰기 변경은 확인했습니다.


긍정적인 부분: fetch join을 활용한 N+1 쿼리 최적화가 잘 되어 있고, 어드민 API의 응답 구조가 명확합니다. Swagger 문서화도 충실하게 작성되었습니다.

- GROUP BY c (엔티티)를 명시적인 컬럼 나열로 변경
- Hibernate 특정 구현 의존성 제거
- MySQL ONLY_FULL_GROUP_BY 모드 호환성 확보
- 다른 JPA 구현체에서도 동작 보장
@claude
claude Bot commented Dec 27, 2025
Copy link
Copy Markdown

PR 리뷰

전반적으로 어드민 댓글 관리 API가 잘 구현되었습니다. N+1 문제 해결과 권한 체크가 적절히 되어 있습니다.

P2 (적극적으로 고려해주세요)

  • CommentService.java:258-261 - 신고된 댓글 목록 조회 시 루트 댓글만 필터링하고 있는데, DB 쿼리 결과에 대댓글도 포함될 수 있습니다. 만약 대댓글만 신고된 경우 루트 댓글 없이 대댓글만 조회되어 findByParentIdInWithUser 호출 시 부모를 찾을 수 없는 문제가 발생할 수 있습니다.

  • CommentReportRepository.java:19-29 - JPQL 쿼리에서 모든 컬럼을 GROUP BY에 포함하고 있습니다. 이는 비효율적이며 일부 DB에서는 성능 이슈를 일으킬 수 있습니다. c.id만 GROUP BY하고 나머지는 집계 함수로 가져오는 방식을 권장합니다.

P3 (웬만하면 반영해주세요)

  • AdminCommentController.java:97-98 - userId를 Authentication에서 가져온 후 어드민 권한 검증이 서비스 레이어에서 누락되어 있습니다. SecurityConfig에서 권한 체크는 하지만, 서비스 레이어에서 명시적으로 User 조회 및 ADMIN 역할 검증을 추가하면 더 안전합니다.

  • CommentService.java:305 - 삭제 사유(reason)를 로그에만 남기고 있습니다. 향후 삭제 이력 추적을 위해 DB에 별도 테이블로 기록하는 것을 고려해보세요.

  • CommentService.java:258-261, 264-266 - 신고된 댓글이 없거나 루트 댓글 ID가 없을 때의 처리는 되어있지만, projection 리스트가 비어있을 때 빈 응답을 반환하는 것이 명확하지 않습니다. 빈 리스트 응답에 대한 테스트 케이스 추가를 권장합니다.

P4 (반영해도 좋고 넘어가도 좋습니다)

  • AdminCommentListResponse.java:12, AdminReportedCommentListResponse.java:12 - 클래스 끝에 빈 줄이 없습니다. 일관성을 위해 다른 DTO처럼 빈 줄 추가 권장
  • Google Java Style formatting 적용으로 인한 공백 변경은 확인했습니다

@Jinyshin
Jinyshin merged commit 9b24b3c into dev Dec 27, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] 댓글 어드민 API 개발

1 participant

0