Name: entity-class-conventions
Author: MediBird

entity-class-conventions

description: globs: **/entity/*.java alwaysApply: false --- - 엔티티 클래스에는 @Entity 어노테이션을 사용해야 합니다. - 상속 계층 구조에는 @MappedSuperclass 어노테이션을 사용합니다. - Lombok의 @Data, @EqualsAndHashCode, @SuperBuilder, @NoArg

by MediBird(0) 0 installs

Instruction file imported from MediBird/caring-note-api-server (.cursor/rules/entity-class-conventions.mdc). Copyright stays with the author.

description: globs: **/entity/*.java alwaysApply: false

엔티티 클래스에는 @Entity 어노테이션을 사용해야 합니다.
상속 계층 구조에는 @MappedSuperclass 어노테이션을 사용합니다.
Lombok의 @Data, @EqualsAndHashCode, @SuperBuilder, @NoArgsConstructor 어노테이션을 활용합니다.
ID 필드는 ULID를 사용하며 문자열 타입(String)으로 선언합니다 (IDENTITY 전략 대신).
@Id 어노테이션은 필수이지만 @GeneratedValue는 사용하지 않습니다.
연관관계의 fetch 전략:
- @ManyToOne, @OneToOne: 기본값이 EAGER이므로 명시적으로 FetchType.LAZY 설정 필요
- @OneToMany, @ManyToMany: 기본값이 이미 LAZY이므로 별도 설정 불필요
- @OneToOne 양방향 관계의 경우, 연관관계 주인이 아닌 쪽(mappedBy 있는 쪽)에서는 LAZY 로딩이 제대로 동작하지 않을 수 있으므로 설계 시 고려 필요
- 성능 최적화를 위해 특별한 이유가 없는 한 모든 연관관계는 지연 로딩(LAZY) 사용 권장
생성 및 수정 시간과 사용자를 추적하기 위해 BaseEntity를 상속받아야 합니다.
엔티티 속성은 적절한 어노테이션(예: @Size, @NotEmpty, @Email 등)으로 주석 처리해야 합니다.

{ "ocm": "1", "id": "medibird-caring-note-api-server-entity-class-conventions-rule", "kind": "skill", "name": "entity-class-conventions", "description": "description: globs: **/entity/*.java alwaysApply: false --- - 엔티티 클래스에는 @Entity 어노테이션을 사용해야 합니다. - 상속 계층 구조에는 @MappedSuperclass 어노테이션을 사용합니다. - Lombok의 @Data, @EqualsAndHashCode, @SuperBuilder, @NoArgsConstructor 어노테이션을 활용합니다. - ID 필드는 ULID를 사용하며 문자열 타입(String)으로 선언합니다 (IDENTITY 전략 대신). - @Id 어노테이션은 필수이지만 @GeneratedValue는 사용하지 않습니다. - 연관관계의 fetch 전략: - @ManyToOne, @OneToOne: 기본값이 EAGER이므로 명시적으로 FetchType.LAZY 설정 필요 - @OneToMany, @ManyToMany: 기본값이 이미 LAZY이므로 별도 설정 불필요 - @OneToOne 양방향 관계의 경우, 연관관계 주인이 아닌 쪽(mappedBy 있는 쪽)에서는 LAZY 로딩이 제대로 동작하지 않을 수 있으므로 설계 시 고려 필요 - 성능 최적화를 위해 특별한 이유가 없는 한 모든 연관관계는 지연 로딩(LAZY) 사용 권장 - 생성 및 수정 시간과 사용자를 추적하기 위해 BaseEntity를 상속받아야 합니다. - 엔티티 속성은 적절한 어노테이션(예: @Size, @NotEmpty, @Email 등)으로 주석 처리해야 합니다.", "publisher": "MediBird", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github-cursor-rules" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "description: globs: **/entity/*.java alwaysApply: false --- - 엔티티 클래스에는 @Entity 어노테이션을 사용해야 합니다. - 상속 계층 구조에는 @MappedSuperclass 어노테이션을 사용합니다. - Lombok의 @Data, @EqualsAndHashCode, @SuperBuilder, @NoArgsConstructor 어노테이션을 활용합니다. - ID 필드는 ULID를 사용하며 문자열 타입(String)으로 선언합니다 (IDENTITY 전략 대신). - @Id 어노테이션은 필수이지만 @GeneratedValue는 사용하지 않습니다. - 연관관계의 fetch 전략: - @ManyToOne, @OneToOne: 기본값이 EAGER이므로 명시적으로 FetchType.LAZY 설정 필요 - @OneToMany, @ManyToMany: 기본값이 이미 LAZY이므로 별도 설정 불필요 - @OneToOne 양방향 관계의 경우, 연관관계 주인이 아닌 쪽(mappedBy 있는 쪽)에서는 LAZY 로딩이 제대로 동작하지 않을 수 있으므로 설계 시 고려 필요 - 성능 최적화를 위해 특별한 이유가 없는 한 모든 연관관계는 지연 로딩(LAZY) 사용 권장 - 생성 및 수정 시간과 사용자를 추적하기 위해 BaseEntity를 상속받아야 합니다. - 엔티티 속성은 적절한 어노테이션(예: @Size, @NotEmpty, @Email 등)으로 주석 처리해야 합니다." ], "primary": false, "metadata": { "source": { "provider": "github-cursor-rules", "repository": "https://github.com/MediBird/caring-note-api-server", "path": ".cursor/rules/entity-class-conventions.mdc", "ref": "56e293e839e3a76ca38e5836a22c5401f44d36b1", "url": "https://github.com/MediBird/caring-note-api-server/blob/56e293e839e3a76ca38e5836a22c5401f44d36b1/.cursor/rules/entity-class-conventions.mdc", "key": "MediBird/caring-note-api-server/.cursor/rules/entity-class-conventions.mdc" } }, "instructions": "---\ndescription: \nglobs: **/entity/*.java\nalwaysApply: false\n---\n- 엔티티 클래스에는 @Entity 어노테이션을 사용해야 합니다.\n- 상속 계층 구조에는 @MappedSuperclass 어노테이션을 사용합니다.\n- Lombok의 @Data, @EqualsAndHashCode, @SuperBuilder, @NoArgsConstructor 어노테이션을 활용합니다.\n- ID 필드는 ULID를 사용하며 문자열 타입(String)으로 선언합니다 (IDENTITY 전략 대신).\n- @Id 어노테이션은 필수이지만 @GeneratedValue는 사용하지 않습니다.\n- 연관관계의 fetch 전략:\n - @ManyToOne, @OneToOne: 기본값이 EAGER이므로 명시적으로 FetchType.LAZY 설정 필요\n - @OneToMany, @ManyToMany: 기본값이 이미 LAZY이므로 별도 설정 불필요\n - @OneToOne 양방향 관계의 경우, 연관관계 주인이 아닌 쪽(mappedBy 있는 쪽)에서는 LAZY 로딩이 제대로 동작하지 않을 수 있으므로 설계 시 고려 필요\n - 성능 최적화를 위해 특별한 이유가", "cost": { "context_tokens": 187 } }

entity-class-conventions

About

description: globs: **/entity/*.java alwaysApply: false

Use it

Manifest

Reviews