refactor/#130 게시글 상세 조회 시 이전, 다음 게시글 정보 추가 #131
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Walkthrough이 변경 사항은 Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Test Coverage Report
Files
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (6)
aics-domain/src/main/java/kgu/developers/domain/post/domain/PostRepository.java (1)
20-22: 메서드 선언이 명확하며, 문서화를 추가하면 좋을 것 같습니다.메서드의 의도가 명확하게 전달되도록 작성되었습니다. 다만, 각 메서드의 동작을 더 자세히 설명하는 JavaDoc을 추가하면 좋을 것 같습니다.
다음과 같이 JavaDoc을 추가하는 것을 제안합니다:
+ /** + * 주어진 생성 시간과 카테고리를 기준으로 이전 게시글을 조회합니다. + * @param createdAt 기준 게시글의 생성 시간 + * @param category 게시글 카테고리 + * @return 이전 게시글 (Optional) + */ Optional<Post> findByPrevPost(LocalDateTime createdAt, Category category); + /** + * 주어진 생성 시간과 카테고리를 기준으로 다음 게시글을 조회합니다. + * @param createdAt 기준 게시글의 생성 시간 + * @param category 게시글 카테고리 + * @return 다음 게시글 (Optional) + */ Optional<Post> findByNextPost(LocalDateTime createdAt, Category category);aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostTitleResponse.java (1)
15-24: null 처리가 적절하며, 검증 로직 추가를 고려해보세요.from() 메서드의 null 처리가 적절합니다. 추가로 title 필드에 대한 길이 제한 등의 검증 로직 추가를 고려해보시면 좋을 것 같습니다.
다음과 같이 검증 어노테이션을 추가하는 것을 제안합니다:
@Builder public record PostTitleResponse( @Schema(description = "게시글 id", example = "1", nullable = true) Long postId, @Schema(description = "게시글 제목", example = "SW 부트캠프 4기 교육생 모집", nullable = true) + @Size(max = 255, message = "게시글 제목은 255자를 초과할 수 없습니다") String postTitle )aics-domain/src/testFixtures/java/mock/FakePostRepository.java (1)
89-95: 스트림 연산 최적화를 고려해보세요현재 구현은 정확하지만, 데이터가 많은 경우 성능 최적화가 가능합니다.
다음과 같은 최적화를 제안합니다:
@Override public Optional<Post> findByPrevPost(LocalDateTime createdAt, Category category) { return data.stream() + .filter(post -> post.getDeletedAt() == null) // 먼저 삭제된 게시글 필터링 + .filter(post -> post.getCategory().equals(category)) // 카테고리 필터링 .filter(post -> post.getCreatedAt().isBefore(createdAt)) - .filter(post -> post.getCategory().equals(category) && post.getDeletedAt() == null) .max(Comparator.comparing(Post::getCreatedAt)); }이렇게 필터를 분리하면 각 단계에서 처리해야 할 데이터의 양을 줄일 수 있습니다.
Also applies to: 97-103
aics-api/src/main/java/kgu/developers/api/post/application/PostService.java (1)
55-63: 코드 가독성 개선이 필요합니다.현재 구현은 정확하지만, 다음과 같은 개선사항을 제안합니다:
- 이전/다음 게시글 조회 로직을 별도의 private 메서드로 추출
- null 체크 로직 추가
다음과 같이 리팩토링을 제안합니다:
@Transactional public PostDetailResponse getPostByIdWithPrevAndNext(Long postId) { Post post = getById(postId); post.increaseViews(); - LocalDateTime timestamp = post.getCreatedAt(); - Category category = post.getCategory(); - - Post prevPost = postRepository.findByPrevPost(timestamp, category).orElse(null); - Post nextPost = postRepository.findByNextPost(timestamp, category).orElse(null); - - PostTitleResponse prevPostResponse = PostTitleResponse.from(prevPost); - PostTitleResponse nextPostResponse = PostTitleResponse.from(nextPost); + PostTitleResponse prevPostResponse = getPreviousPost(post); + PostTitleResponse nextPostResponse = getNextPost(post); return PostDetailResponse.from(post, prevPostResponse, nextPostResponse); } + +private PostTitleResponse getPreviousPost(Post currentPost) { + if (currentPost == null) return null; + Post prevPost = postRepository.findByPrevPost( + currentPost.getCreatedAt(), + currentPost.getCategory() + ).orElse(null); + return PostTitleResponse.from(prevPost); +} + +private PostTitleResponse getNextPost(Post currentPost) { + if (currentPost == null) return null; + Post nextPost = postRepository.findByNextPost( + currentPost.getCreatedAt(), + currentPost.getCategory() + ).orElse(null); + return PostTitleResponse.from(nextPost); +}aics-api/src/testFixtures/java/post/application/PostServiceTest.java (1)
87-92: 테스트 케이스 보완이 필요합니다.현재 테스트는 기본적인 속성만 검증하고 있습니다. 다음 속성들도 함께 검증하면 좋을 것 같습니다:
- 생성 시간 (createdAt)
- 조회수 초기값
- 작성자 정보
Post created = postService.getById(response.postId()); assertEquals(request.title(), created.getTitle()); assertEquals(request.content(), created.getContent()); assertEquals(category.getDescription(), created.getCategory().getDescription()); +assertEquals(0, created.getViews()); +assertNotNull(created.getCreatedAt()); +assertEquals("202411345", created.getAuthor().getId());aics-api/src/main/java/kgu/developers/api/post/presentation/PostController.java (1)
80-80: API 문서 업데이트가 필요합니다.메서드의 기능이 확장되었으므로 API 문서에도 이전/다음 게시글 정보가 포함된다는 내용을 추가해야 합니다.
@Operation(summary = "게시글 상세 조회 API", description = """ - - Description : 이 API는 게시글의 상세 정보를 조회합니다. + - Description : 이 API는 게시글의 상세 정보와 함께 이전/다음 게시글의 정보를 조회합니다. - Assignee : 이신행 """)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (9)
aics-api/src/main/java/kgu/developers/api/post/application/PostService.java(2 hunks)aics-api/src/main/java/kgu/developers/api/post/presentation/PostController.java(1 hunks)aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostDetailResponse.java(2 hunks)aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostTitleResponse.java(1 hunks)aics-api/src/testFixtures/java/post/application/PostServiceTest.java(5 hunks)aics-domain/src/main/java/kgu/developers/domain/post/domain/PostRepository.java(2 hunks)aics-domain/src/main/java/kgu/developers/domain/post/infrastructure/JpaPostRepository.java(1 hunks)aics-domain/src/main/java/kgu/developers/domain/post/infrastructure/PostRepositoryImpl.java(2 hunks)aics-domain/src/testFixtures/java/mock/FakePostRepository.java(3 hunks)
🔇 Additional comments (6)
aics-domain/src/main/java/kgu/developers/domain/post/infrastructure/JpaPostRepository.java (1)
12-13: 메서드 구현이 적절합니다!
Spring Data JPA 메서드 명명 규칙을 잘 따르고 있으며, 이전/다음 게시글 조회를 위한 정렬 방향이 올바르게 설정되어 있습니다.
Also applies to: 15-16
aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostTitleResponse.java (1)
8-14: 응답 구조가 잘 설계되었습니다.
record를 사용한 불변 객체 구현과 Swagger 문서화가 잘 되어있습니다.
aics-domain/src/main/java/kgu/developers/domain/post/infrastructure/PostRepositoryImpl.java (1)
42-46: 이전/다음 게시글 조회 구현이 잘 되었습니다!
이전/다음 게시글을 조회하는 메서드가 명확하게 구현되었으며, JpaPostRepository에 적절히 위임되어 있습니다.
Also applies to: 48-52
aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostDetailResponse.java (1)
Line range hint 62-76: from() 메서드 구현이 잘 되었습니다!
새로운 필드들이 빌더에 적절히 추가되었습니다.
aics-api/src/main/java/kgu/developers/api/post/application/PostService.java (2)
3-4: 메서드 이름이 명확하게 변경되었습니다.
메서드 이름이 getPostById에서 getPostByIdWithPrevAndNext로 변경되어 메서드의 기능을 더 명확하게 표현합니다.
Also applies to: 50-51
44-48: 들여쓰기가 개선되었습니다.
메서드 파라미터의 들여쓰기가 일관성 있게 정리되어 가독성이 향상되었습니다.
aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostDetailResponse.java
Outdated
Show resolved
Hide resolved
LeeHanEum
approved these changes
Dec 10, 2024
aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostTitleResponse.java
Outdated
Show resolved
Hide resolved
aics-api/src/main/java/kgu/developers/api/post/presentation/response/PostDetailResponse.java
Outdated
Show resolved
Hide resolved
minjo-on
deleted the
refactor/#130-add-previous-and-next-post-data-to-post-detail-response
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
게시글 상세 조회 시 이전, 다음 게시글 정보 추가
Tasks