Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

컬럼 제약조건 및 DB 동기화를 위한 엔티티 클래스 수정 #806

Merged
merged 19 commits into from
Dec 16, 2024

Conversation

Hanjaemo
Copy link
Member

@Hanjaemo Hanjaemo commented Dec 15, 2024

💡 작업 내용

  • 컬럼 제약조건 및 DB 동기화를 위한 엔티티 클래스 수정

✅ 셀프 체크리스트

  • PR 제목을 형식에 맞게 작성했나요?
  • 브랜치 전략에 맞는 브랜치에 PR을 올리고 있나요?
  • 이슈는 close 했나요?
  • Reviewers, Labels, Projects를 등록했나요?
  • 작업 도중 문서 수정이 필요한 경우 잘 수정했나요?
  • 테스트는 잘 통과했나요?
  • 불필요한 코드는 제거했나요?

closes #805

Summary by CodeRabbit

  • 신규 기능

    • GameOptionTempTalkPick 클래스가 BaseTimeEntity를 상속받아 기능이 확장되었습니다.
    • TalkPick 클래스에 @Embedded 필드가 추가되어 복합 타입으로 저장됩니다.
    • Like 클래스에 active 필드의 기본값이 true로 설정되었습니다.
  • 변경 사항

    • 여러 클래스의 필드에 유효성 검사 주석이 추가되어 데이터 무결성이 향상되었습니다.
    • Comment 클래스에서 reportedCount 필드와 관련된 로직이 제거되었습니다.
    • TalkPickVote 클래스의 voteOption 필드에 대한 주석이 명확히 정의되었습니다.
    • ReportCommentService 클래스에서 오류 처리 로직이 개선되었습니다.
    • CustomSuccessHandler 클래스에서 변수 선언 위치가 변경되었습니다.

@Hanjaemo Hanjaemo added 🗂️ db DB 관련 🪄 refactor 리팩토링 D-3 우선순위가 낮거나 여유로운 작업 labels Dec 15, 2024
@Hanjaemo Hanjaemo self-assigned this Dec 15, 2024
@Hanjaemo Hanjaemo linked an issue Dec 15, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Dec 15, 2024

Walkthrough

이 풀 리퀘스트는 여러 엔티티 클래스에 대한 JPA 및 유효성 검증 어노테이션을 개선하고 구조를 최적화하는 작업을 포함합니다. 주요 변경 사항은 @Column(name = "id") 어노테이션 제거, 필드에 대한 @NotNull@Size 제약 조건 추가, 일부 클래스의 상속 구조 변경 등을 포함합니다. 이러한 수정은 엔티티 클래스의 데이터 무결성과 매핑을 강화하는 데 중점을 두고 있습니다.

Changes

파일 변경 요약
GameBookmark.java @Column(name = "id") 어노테이션 제거
TalkPickBookmark.java @Column(name = "id") 어노테이션 제거, 여러 JPA 어노테이션 추가
Comment.java reportedCount 필드 제거, @NotNull@Embedded 어노테이션 추가
File.java @NotNull, @Size 어노테이션 추가
GameOption.java BaseTimeEntity 상속 추가
Like.java @NotNull 어노테이션 추가
TalkPick.java 새로운 어노테이션 및 필드 추가
TempTalkPick.java BaseTimeEntity 상속 추가
GameVote.java JPA 어노테이션 및 관계 매핑 개선
TalkPickVote.java JPA 어노테이션 추가 및 개선
CommentDto.java reportedCount 필드 제거 및 관련 메서드 수정
CustomSuccessHandler.java redirectUrl 변수 위치 변경
ReportCommentService.java 에러 코드 개선 및 리포트 로직 수정

Assessment against linked issues

목표 해결 여부 설명
엔티티 클래스 검토 [#805] -

Possibly related PRs

Suggested labels

🛠️ fix, D-0

Suggested reviewers

  • gywns0417
  • jschoi-96

Poem

🐰 엔티티의 춤, 어노테이션의 노래
코드는 깨끗해지고 제약은 단단해져
JPA의 마법으로 데이터 노래해
리팩토링의 토끼, 기쁨을 노래해! 🎉

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 55bdd9d and 193f780.

📒 Files selected for processing (3)
  • src/main/java/balancetalk/bookmark/domain/GameBookmark.java (0 hunks)
  • src/main/java/balancetalk/global/oauth2/CustomSuccessHandler.java (1 hunks)
  • src/main/resources/config (1 hunks)
💤 Files with no reviewable changes (1)
  • src/main/java/balancetalk/bookmark/domain/GameBookmark.java
✅ Files skipped from review due to trivial changes (1)
  • src/main/resources/config
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/java/balancetalk/global/oauth2/CustomSuccessHandler.java

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🔭 Outside diff range comments (3)
src/main/java/balancetalk/vote/domain/GameVote.java (1)

Line range hint 31-39: 필수 관계에 대한 유효성 검증 추가 필요

Member와 GameOption은 GameVote에서 필수적인 관계로 보입니다. 데이터 무결성을 보장하기 위해 @NotNull 제약조건을 추가하는 것이 좋습니다.

다음과 같이 수정을 제안합니다:

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "member_id")
+   @NotNull
    private Member member;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "game_option_id")
+   @NotNull
    private GameOption gameOption;
src/main/java/balancetalk/bookmark/domain/TalkPickBookmark.java (1)

Line range hint 31-39: 필수 관계에 대한 유효성 검증 추가 필요

Member와 TalkPick 관계에 @NotNull 제약조건이 누락되어 있습니다.

다음과 같이 수정을 제안합니다:

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "member_id")
+   @NotNull
    private Member member;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "talk_pick_id")
+   @NotNull
    private TalkPick talkPick;
src/main/java/balancetalk/talkpick/domain/TempTalkPick.java (1)

Line range hint 29-48: 필수 필드에 대한 유효성 검증 추가 필요

title, optionA, optionB와 같은 필수 필드에 대한 @NotNull 제약조건이 누락되어 있습니다. 또한 sourceUrl에 대한 URL 형식 검증이 필요해 보입니다.

다음과 같이 수정을 제안합니다:

    @OneToOne
    @JoinColumn(name = "member_id")
+   @NotNull
    private Member member;

    @Size(max = 50)
+   @NotNull
    private String title;

    @Column(columnDefinition = "LONGTEXT")
+   @NotNull
    private String content;

    @Size(max = 10)
+   @NotNull
    @Column(name = "option_a")
    private String optionA;

    @Size(max = 10)
+   @NotNull
    @Column(name = "option_b")
    private String optionB;

+   @Pattern(regexp = "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$")
    private String sourceUrl;
🧹 Nitpick comments (7)
src/main/java/balancetalk/like/domain/Like.java (3)

34-37: @column 어노테이션 추가를 고려해보세요.

likeType 필드에 @NotNull 제약조건이 잘 추가되었습니다. 하지만 데이터베이스 컬럼 속성을 더 명확하게 지정하기 위해 다음과 같은 개선을 제안드립니다:

    @Enumerated(value = EnumType.STRING)
    @NotNull
+   @Column(length = 20)
    private LikeType likeType;

45-46: primitive boolean 타입 사용을 고려해보세요.

@NotNull이 지정된 Boolean 래퍼 타입 대신 primitive boolean 타입을 사용하면 다음과 같은 장점이 있습니다:

  • null 가능성 제거
  • 메모리 사용량 감소
  • 박싱/언박싱 오버헤드 제거
    @NotNull
-   private Boolean active = true;
+   private boolean active = true;

Line range hint 48-54: 메서드 이름의 일관성을 개선해주세요.

현재 메서드 이름이 일관성이 없습니다:

  • activate()
  • deActive() (대문자 'A' 사용)

다음과 같이 수정하는 것을 추천드립니다:

    public void activate() {
        this.active = true;
    }

-   public void deActive() {
+   public void deactivate() {
        this.active = false;
    }
src/main/java/balancetalk/bookmark/domain/TalkPickBookmark.java (1)

Line range hint 44-57: 상태 변경 메서드에 대한 문서화 필요

activate(), deactivate() 메서드의 용도와 영향을 명확히 하기 위해 JavaDoc 문서화를 추가하는 것이 좋습니다.

다음과 같이 수정을 제안합니다:

+   /**
+    * 북마크를 활성화 상태로 변경합니다.
+    */
    public void activate() {
        this.active = true;
    }

+   /**
+    * 북마크를 비활성화 상태로 변경합니다.
+    */
    public void deactivate() {
        this.active = false;
    }
src/main/java/balancetalk/talkpick/domain/TempTalkPick.java (1)

Line range hint 50-58: update 메서드 개선 필요

update 메서드에서 반환값의 의도가 명확하지 않습니다. 또한 유효성 검증이 누락되어 있습니다.

다음과 같이 수정을 제안합니다:

+   /**
+    * 임시 토크픽의 내용을 업데이트합니다.
+    * @param newTempTalkPick 새로운 임시 토크픽 정보
+    * @throws IllegalArgumentException 필수 필드가 null인 경우
+    */
    public Long update(TempTalkPick newTempTalkPick) {
+       Objects.requireNonNull(newTempTalkPick, "newTempTalkPick must not be null");
+       validateRequiredFields(newTempTalkPick);
        this.title = newTempTalkPick.getTitle();
        this.content = newTempTalkPick.getContent();
        this.optionA = newTempTalkPick.getOptionA();
        this.optionB = newTempTalkPick.getOptionB();
        this.sourceUrl = newTempTalkPick.getSourceUrl();
        return id;
    }

+   private void validateRequiredFields(TempTalkPick tempTalkPick) {
+       if (tempTalkPick.getTitle() == null || tempTalkPick.getContent() == null ||
+           tempTalkPick.getOptionA() == null || tempTalkPick.getOptionB() == null) {
+           throw new IllegalArgumentException("Required fields must not be null");
+       }
+   }
src/main/java/balancetalk/game/domain/GameOption.java (2)

Line range hint 77-84: 투표 수 관리 메서드의 동시성 이슈를 고려해주세요.

increaseVotesCountdecreaseVotesCount 메서드에서 동시성 문제가 발생할 수 있습니다. JPA의 낙관적 락이나 비관적 락 도입을 고려해보세요.

다음과 같은 개선을 제안합니다:

+    @Version
+    private Long version;

-    public void increaseVotesCount() {
+    @Lock(LockModeType.OPTIMISTIC)
+    public synchronized void increaseVotesCount() {
         this.votesCount++;
     }

-    public void decreaseVotesCount() {
+    @Lock(LockModeType.OPTIMISTIC)
+    public synchronized void decreaseVotesCount() {
         this.votesCount--;
     }

Line range hint 86-88: 이미지 ID 검증 로직을 개선해주세요.

hasImage 메서드가 단순히 null 체크만 수행하고 있습니다. 유효한 이미지 ID 범위 검증도 추가하는 것이 좋을 것 같습니다.

-    public boolean hasImage() {
-        return imgId != null;
+    public boolean hasImage() {
+        return imgId != null && imgId > 0;
     }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d88c89f and a56a4d2.

📒 Files selected for processing (10)
  • src/main/java/balancetalk/bookmark/domain/GameBookmark.java (0 hunks)
  • src/main/java/balancetalk/bookmark/domain/TalkPickBookmark.java (1 hunks)
  • src/main/java/balancetalk/comment/domain/Comment.java (3 hunks)
  • src/main/java/balancetalk/file/domain/File.java (2 hunks)
  • src/main/java/balancetalk/game/domain/GameOption.java (2 hunks)
  • src/main/java/balancetalk/like/domain/Like.java (3 hunks)
  • src/main/java/balancetalk/talkpick/domain/TalkPick.java (1 hunks)
  • src/main/java/balancetalk/talkpick/domain/TempTalkPick.java (1 hunks)
  • src/main/java/balancetalk/vote/domain/GameVote.java (1 hunks)
  • src/main/java/balancetalk/vote/domain/TalkPickVote.java (1 hunks)
💤 Files with no reviewable changes (1)
  • src/main/java/balancetalk/bookmark/domain/GameBookmark.java
🔇 Additional comments (10)
src/main/java/balancetalk/like/domain/Like.java (1)

5-20: 임포트 구문이 깔끔하게 정리되어 있습니다!

Jakarta Persistence, 유효성 검증, Lombok 관련 임포트가 잘 구성되어 있습니다.

src/main/java/balancetalk/file/domain/File.java (2)

15-15: 코드가 적절해 보입니다!

새로운 필드 제약조건을 위한 Size 어노테이션 import가 올바르게 추가되었습니다.


36-45: 데이터베이스 스키마와의 정합성 검증이 필요합니다.

필드에 추가된 제약조건들이 논리적으로는 적절해 보입니다:

  • fileType: @NotNull 제약조건 추가
  • uploadName: 최대 50자 제한
  • storedName: 최대 100자 제한

하지만 이러한 제약조건들이 실제 데이터베이스 스키마와 일치하는지 확인이 필요합니다.

추가로 고려해볼 사항:

  1. 파일 이름 길이 제한이 운영체제나 파일 시스템의 제약과도 호환되는지 확인
  2. 향후 확장성을 고려했을 때 현재 설정된 길이 제한이 충분한지 검토
src/main/java/balancetalk/vote/domain/TalkPickVote.java (3)

6-14: JPA 어노테이션 임포트 구성이 적절합니다.

필요한 모든 JPA 어노테이션들이 명시적으로 임포트되어 있으며, 불필요한 임포트는 없습니다.


Line range hint 33-40: 연관관계의 Fetch 전략이 적절하게 설정되었습니다.

MemberTalkPick에 대한 @ManyToOne 관계에서 FetchType.LAZY를 사용한 것이 성능 최적화 측면에서 좋은 선택입니다.


Line range hint 42-44: VoteOption 필드의 제약조건을 검토해주세요.

@NotNull 제약조건이 추가되었지만, 이 필드가 업데이트되는 updateVoteOption 메서드에서는 null 체크가 없습니다.

다음 스크립트로 updateVoteOption 메서드의 호출 부분을 확인해보세요:

src/main/java/balancetalk/game/domain/GameOption.java (2)

34-34: BaseTimeEntity 상속 추가는 적절합니다.

생성일시와 수정일시를 자동으로 관리할 수 있게 되어 감사 추적성이 향상되었습니다.


Line range hint 41-44: name 필드의 유효성 검증이 개선되었습니다.

@NotBlank@Size(max = 30) 조합으로 적절한 제약조건이 설정되었습니다.

src/main/java/balancetalk/talkpick/domain/TalkPick.java (2)

Line range hint 79-81: comments 필드의 CascadeType.ALL 사용 주의

comments 필드에 CascadeType.ALL을 사용하면 TalkPick 엔티티 삭제 시 연관된 Comment 엔티티도 모두 삭제됩니다. 댓글 데이터를 보존해야 하는 비즈니스 로직이라면 cascade 속성을 재검토하는 것이 좋습니다.


Line range hint 75-77: votes 필드의 CascadeType.REMOVE 사용 확인

votes 필드에 CascadeType.REMOVE를 사용하여 TalkPick 엔티티 삭제 시 연관된 TalkPickVote 엔티티가 삭제됩니다. 투표 기록의 보존이 필요한지 확인하고, 필요하다면 cascade 설정을 조정해주세요.

Copy link

@Hanjaemo Hanjaemo added the 🛠️ fix 오류 수정 label Dec 16, 2024
@Hanjaemo Hanjaemo added D-0 긴급 이슈에 대한 작업 and removed D-3 우선순위가 낮거나 여유로운 작업 labels Dec 16, 2024
@Hanjaemo Hanjaemo merged commit e64f8ad into main Dec 16, 2024
4 checks passed
@Hanjaemo Hanjaemo deleted the refactor/805-entity branch December 17, 2024 11:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D-0 긴급 이슈에 대한 작업 🗂️ db DB 관련 🛠️ fix 오류 수정 🪄 refactor 리팩토링
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

엔티티 클래스 검토
3 participants