refactor: 회원 도메인 추가 리팩터링 (#2)

- 엔티티 공용 멤버 관리를 위한 BaseGeneralEntity 클래스 추가
- 기존의 deleteAt 기반 논리적 삭제 로직을 deleteYn 기반으로 변경
- 기타 개선사항 고도화

Author: hellmir

README.md

@@ -228,7 +228,7 @@ OAuth 2.0 가이드 문서에 JSON 토큰에 대한 설명도 나와 있습니
 회원 프로필 테이블입니다. 회원 테이블과 역할이 조금 다릅니다. 회원 테이블이 회원의 권한, 로그인 정보 등의 데이터를 담는다면,
 회원 프로필 테이블은 프로필 이미지, 자기소개, 연락처, 이름 등 회원 프로필 데이터를 가지고 있습니다.
 
-- `member_id`
+- `id`
     - `member` 테이블을 참조하는 FK이자, `member_profile` 테이블의 PK입니다. `member_profile` 테이블과 `member` 테이블은 식별 관계입니다.
 
 ### `available_study_time`

docs/extract-member-id/extract-member-id.md

@@ -50,7 +50,7 @@ public class TestController {
 
 ```json
 {
-  "member_id": 1,
+  "id": 1,
   "created_at": "2025-05-04 20:24:28.000000",
   "updated_at": "2025-05-04 20:24:32.000000",
   "auto_matching": "F",
@@ -178,4 +178,4 @@ public class TestController {
 
 ## 주의사항
 
-`SecurityContextHolder`, `OAuth2AuthenticationPrincipal` 등은 Spring Security 기술이고, **변할 수 있는 것**입니다. 이 때문에 **Service 객체에 Spring Security 기술을 노출시켜서는 안 됩니다**. 왜냐하면 Service 객체는 비즈니스 로직을 가지고 있는 Application 코드이고, 비즈니스 로직 코드는 요구사항이 변경될 경우를 제외하고 변경되어서는 안 됩니다. 다시 말해, 비즈니스 로직 코드는 외부 기술에 의존해서는 안 된다는 것입니다. Service 객체 안에서 `SecurityContextHolder`에 접근하여 `Authentication` 객체를 꺼내는 코드를 작성한다면 그 Service 객체는 Spring Security라는 기술에 종속됩니다. 웬만하면 계속 Spring Security를 사용하겠지만, 그래도 Spring Security가 아닌 다른 기술을 사용하게 되었다고 가정해 봅시다. 그러면 Spring Security에 종속된 Service 객체의 코드 변경 없이 Spring Security를 대체할 수 없게 됩니다. 저희 프로젝트 규모가 더 커져서 막 코드가 10만 줄이 넘어가는데, Application 코드 곳곳에 Spring Security에 대한 의존성이 발견된다고 합시다. 그러면 이 프로젝트는 최후의 순간까지 Spring Security를 사용해야 합니다. 더 개쩌는 기술이 나온다고 하더라도요.
+`SecurityContextHolder`, `OAuth2AuthenticationPrincipal` 등은 Spring Security 기술이고, **변할 수 있는 것**입니다. 이 때문에 **Service 객체에 Spring Security 기술을 노출시켜서는 안 됩니다**. 왜냐하면 Service 객체는 비즈니스 로직을 가지고 있는 Application 코드이고, 비즈니스 로직 코드는 요구사항이 변경될 경우를 제외하고 변경되어서는 안 됩니다. 다시 말해, 비즈니스 로직 코드는 외부 기술에 의존해서는 안 된다는 것입니다. Service 객체 안에서 `SecurityContextHolder`에 접근하여 `Authentication` 객체를 꺼내는 코드를 작성한다면 그 Service 객체는 Spring Security라는 기술에 종속됩니다. 웬만하면 계속 Spring Security를 사용하겠지만, 그래도 Spring Security가 아닌 다른 기술을 사용하게 되었다고 가정해 봅시다. 그러면 Spring Security에 종속된 Service 객체의 코드 변경 없이 Spring Security를 대체할 수 없게 됩니다. 저희 프로젝트 규모가 더 커져서 막 코드가 10만 줄이 넘어가는데, Application 코드 곳곳에 Spring Security에 대한 의존성이 발견된다고 합시다. 그러면 이 프로젝트는 최후의 순간까지 Spring Security를 사용해야 합니다. 더 개쩌는 기술이 나온다고 하더라도요.

init_data/ZTO_LOCAL_DDL.sql

@@ -18,7 +18,7 @@ SET FOREIGN_KEY_CHECKS = 1;
 
 
 CREATE TABLE `member` (
-  `member_id` bigint PRIMARY KEY AUTO_INCREMENT COMMENT '회원 Identifier',
+  `id` bigint PRIMARY KEY AUTO_INCREMENT COMMENT '회원 Identifier',
   `oidc_id` varchar(50) COMMENT 'Open ID Connect에 의한 ID',
   `login_id` VARCHAR(50) COMMENT '로그인할 때 사용되는 ID (자체 로그인)',
   `member_status` VARCHAR(8) NOT NULL DEFAULT 'ACTIVE' COMMENT '회원 상태',
@@ -29,18 +29,18 @@ CREATE TABLE `member` (
 );
 
 CREATE TABLE `role` (
-  `role_id` varchar(20) PRIMARY KEY COMMENT '권한 ID',
+  `id` varchar(20) PRIMARY KEY COMMENT '권한 ID',
   `role_name` varchar(20) NOT NULL COMMENT '권한명'
 );
 
 CREATE TABLE `access_permission` (
-  `permission_id` BIGINT PRIMARY KEY AUTO_INCREMENT COMMENT '접근허가 ID',
+  `id` BIGINT PRIMARY KEY AUTO_INCREMENT COMMENT '접근허가 ID',
   `endpoint` VARCHAR(80) NOT NULL COMMENT '엔드포인트',
   `http_method` VARCHAR(8) NOT NULL COMMENT 'HTTP 메소드 (Upper Case)' /* CHAR로 변경 고려 */
 );
 
 CREATE TABLE `access_permission_role` (
-  `access_permission_role_id` BIGINT PRIMARY KEY AUTO_INCREMENT COMMENT '접근허가_롤 ID',
+  `id` BIGINT PRIMARY KEY AUTO_INCREMENT COMMENT '접근허가_롤 ID',
   `permission_id` BIGINT NOT NULL COMMENT '접근허가 참조 FK',
   `role_id` VARCHAR(20) NOT NULL COMMENT '권한 참조 FK'
 );
@@ -59,15 +59,15 @@ CREATE TABLE `member_profile` (
 );
 
 CREATE TABLE `member_interest` (
-  member_interest_id BIGINT PRIMARY KEY AUTO_INCREMENT COMMENT '관심사 ID',
+  id BIGINT PRIMARY KEY AUTO_INCREMENT COMMENT '관심사 ID',
   name VARCHAR(20) NOT NULL COMMENT '관심사 이름',
   member_id BIGINT NOT NULL COMMENT '회원 프로필 참조 FK',
   `created_at` timestamp NOT NULL COMMENT '생성시간',
   `updated_at` timestamp NOT NULL COMMENT '수정시간'
 );
 
 CREATE TABLE `available_study_time` (
-  available_study_time_id BIGINT PRIMARY KEY COMMENT '스터디 가능 시간대 ID',
+  id BIGINT PRIMARY KEY COMMENT '스터디 가능 시간대 ID',
   from_time TIME(6) COMMENT '스터디 가능 시작 시간 (날짜 빼고 시간만 사용)',
   to_time TIME(6) COMMENT '스터디 가능 끝 시간 (날짜 빼고 시간만 사용)',
   label VARCHAR(10) NOT NULL COMMENT '시간대 라벨 (오전, 오후, 저녁 등등)',
@@ -76,21 +76,21 @@ CREATE TABLE `available_study_time` (
 );
 
 CREATE TABLE `profile_avl_time` (
-  available_study_time_id BIGINT NOT NULL COMMENT '스터디 가능 시간대 참조 FK',
+  id BIGINT NOT NULL COMMENT '스터디 가능 시간대 참조 FK',
   member_id BIGINT NOT NULL COMMENT '회원 프로필 참조 FK',
   PRIMARY KEY (available_study_time_id, member_id)
 );
 
 CREATE TABLE `image` (
-  `image_id` bigint PRIMARY KEY AUTO_INCREMENT COMMENT '이미지 ID',
+  `id` bigint PRIMARY KEY AUTO_INCREMENT COMMENT '이미지 ID',
   `location` VARCHAR(80) NOT NULL COMMENT '이미지가 저장된 장소 (도메인 URL)',
   `created_at` timestamp DEFAULT NOW() COMMENT '생성시간',
   `updated_at` timestamp DEFAULT NOW() COMMENT '수정시간',
   `deleted_at` TIMESTAMP COMMENT '삭제시간 - NULL일 경우 삭제되지 않음'
 );
 
 CREATE TABLE `resized_image` (
-  `resized_image_id` bigint AUTO_INCREMENT COMMENT '리사이징 이미지 ID',
+  `id` bigint AUTO_INCREMENT COMMENT '리사이징 이미지 ID',
   `image_id` bigint NOT NULL COMMENT '이미지 참조 FK',
   -- ENUM('THUMB','SMALL','LARGE','ETC') -> VARCHAR(10)
   `resized_image_url` varchar(255) NOT NULL COMMENT '리사이징 이미지 URL',
@@ -100,13 +100,13 @@ CREATE TABLE `resized_image` (
 );
 
 CREATE TABLE `social_media_type` (
-  `social_media_type_id` VARCHAR(20) PRIMARY KEY,
+  `id` VARCHAR(20) PRIMARY KEY,
   `social_media_name` varchar(100) NOT NULL,
   `icon_id` BIGINT
 );
 
 CREATE TABLE `social_media` (
-  `social_media_id` BIGINT PRIMARY KEY AUTO_INCREMENT,
+  `id` BIGINT PRIMARY KEY AUTO_INCREMENT,
   `member_id` bigint NOT NULL,
   `social_media_type_id` VARCHAR(255) NOT NULL,
   `url` varchar(255) NOT NULL,
@@ -115,7 +115,7 @@ CREATE TABLE `social_media` (
 );
 
 CREATE TABLE `tech_stack` (
-  tech_stack_id BIGINT AUTO_INCREMENT PRIMARY KEY,
+  id BIGINT AUTO_INCREMENT PRIMARY KEY,
   code CHAR(3) NOT NULL UNIQUE,
   tech_stack_name VARCHAR(100) NOT NULL,
   parent_id BIGINT,
@@ -126,8 +126,8 @@ CREATE TABLE `tech_stack` (
 );
 
 CREATE TABLE `tech_stack_ref` (
-  `tech_stack_ref_id` bigint PRIMARY KEY AUTO_INCREMENT,
+  `id` bigint PRIMARY KEY AUTO_INCREMENT,
   `tech_stack_id` BIGINT NOT NULL,
   `member_id` bigint NOT NULL,
   `type` VARCHAR(30) NOT NULL
-);
+);

src/main/java/com/codezerotoone/mvp/domain/common/BaseEntity.java

@@ -29,11 +29,13 @@ public abstract class BaseEntity {
     protected BaseEntity() {
     }
 
-    public LocalDateTime getCreatedAt() {
+    // 변경 사유: 자신의 날짜는 여기저기서 꺼내 볼 수 있게 하는 것보다 스스로가 관리하는 것이 객체지향의 원칙에도, DDD의 지향점에도 부합한다고 생각됩니다.
+    protected LocalDateTime getCreatedAt() {
         return createdAt;
     }
 
-    public LocalDateTime getUpdatedAt() {
+    // 변경 사유: 자신의 날짜는 여기저기서 꺼내 볼 수 있게 하는 것보다 스스로가 관리하는 것이 객체지향의 원칙에도, DDD의 지향점에도 부합한다고 생각됩니다.
+    protected LocalDateTime getUpdatedAt() {
         return updatedAt;
     }
 

src/main/java/com/codezerotoone/mvp/domain/common/BaseGeneralEntity.java

@@ -0,0 +1,45 @@
+package com.codezerotoone.mvp.domain.common;
+
+import jakarta.persistence.*;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
+
+import java.time.LocalDateTime;
+
+import static com.codezerotoone.mvp.domain.common.EntityConstant.BOOLEAN_DEFAULT_FALSE;
+import static jakarta.persistence.GenerationType.IDENTITY;
+
+// 추가 사유: 일반적으로 공통되는 컬럼들은 엔티티가 추가될 때마다 일일이 설정하기보다는 공용 멤버로 묶는 게 나아 보입니다.
+@MappedSuperclass
+@EntityListeners(AuditingEntityListener.class)
+public abstract class BaseGeneralEntity extends BaseEntity {
+    @Id
+    @GeneratedValue(strategy = IDENTITY)
+    private Long id;
+
+    @Column(nullable = false, columnDefinition = BOOLEAN_DEFAULT_FALSE)
+    private boolean deleteYn;
+
+    @Column(name = "deleted_at")
+    private LocalDateTime deletedAt;
+
+    public Long getId() {
+        return id;
+    }
+
+    protected boolean isDeleted() {
+        return deleteYn;
+    }
+
+    protected void updateId(Long id) {
+        this.id = id;
+    }
+
+    protected void deleteEntity() {
+        deleteYn = true;
+        deletedAt = LocalDateTime.now();
+    }
+
+    protected void undeleteEntity() {
+        deleteYn = false;
+    }
+}

src/main/java/com/codezerotoone/mvp/domain/common/EntityConstant.java

@@ -0,0 +1,5 @@
+package com.codezerotoone.mvp.domain.common;
+
+public class EntityConstant {
+    public static final String BOOLEAN_DEFAULT_FALSE = "boolean default false";
+}

src/main/java/com/codezerotoone/mvp/domain/image/entity/Image.java

@@ -1,13 +1,15 @@
 package com.codezerotoone.mvp.domain.image.entity;
 
-import com.codezerotoone.mvp.domain.common.BaseEntity;
+import com.codezerotoone.mvp.domain.common.BaseGeneralEntity;
 import com.codezerotoone.mvp.domain.image.entity.dto.ResizedImageInfo;
-import jakarta.persistence.*;
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Entity;
+import jakarta.persistence.OneToMany;
+import jakarta.persistence.Table;
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
-import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -16,18 +18,16 @@
 @Table(name = "image")
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
-public class Image extends BaseEntity {
-
-    @Id
-    @GeneratedValue(strategy = GenerationType.IDENTITY)
-    private Long imageId;
-
-    @OneToMany(mappedBy = "image", cascade = { CascadeType.PERSIST, CascadeType.REMOVE }) // TODO: 고아객체 삭제?
+public class Image extends BaseGeneralEntity {
+    // 변경 사유: 원본 이미지와 연결되지 않은 경우 의미없는 데이터이므로, DB에 튜플을 남기지 않는 편이 장기적으로 낫다고 보입니다.
+    @OneToMany(mappedBy = "image", cascade = {CascadeType.PERSIST}, orphanRemoval = true)
     private List<ResizedImage> resizedImages = new ArrayList<>();
 
     private String location;
 
-    private LocalDateTime deletedAt = null;
+    private Image(Long id) {
+        updateId(id);
+    }
 
     public static Image create(String location, ResizedImageInfo... resizedImages) {
         Image image = new Image();
@@ -47,17 +47,17 @@ public static Image create(String location, List<ResizedImageInfo> resizedImages
         return image;
     }
 
-    public static Image getReference(Long id) {
-        Image image = new Image();
-        image.imageId = id;
-        return image;
+    // 변경 사유: 메서드명과 역할 불일치
+    public static Image of(Long id) {
+        // 변경 사유: 생성 로직 간소화
+        return new Image(id);
     }
 
     public void delete() {
-        this.deletedAt = LocalDateTime.now();
+        deleteEntity();
     }
 
     public boolean isDeleted() {
-        return this.deletedAt != null;
+        return isDeleted();
     }
 }

src/main/java/com/codezerotoone/mvp/domain/image/entity/ResizedImage.java

@@ -8,15 +8,16 @@
 
 import java.time.LocalDateTime;
 
+import static com.codezerotoone.mvp.domain.common.EntityConstant.BOOLEAN_DEFAULT_FALSE;
+
 @Entity
 @Table(name = "resized_image")
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @Getter
 public class ResizedImage {
-
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
-    private Long resizedImageId;
+    private Long id;
 
     @ManyToOne(fetch = FetchType.LAZY)
     @JoinColumn(name = "image_id")
@@ -28,7 +29,11 @@ public class ResizedImage {
     @Column(name = "image_size_type", columnDefinition = "VARCHAR(10)")
     private ImageSizeType imageSizeType;
 
-    public LocalDateTime deletedAt = null;
+    @Column(nullable = false, columnDefinition = BOOLEAN_DEFAULT_FALSE)
+    private boolean deleteYn;
+
+    @Column(name = "deleted_at")
+    private LocalDateTime deletedAt;
 
     public ResizedImage(Image image, String resizedImageUrl, ImageSizeType imageSizeType) {
         this.image = image;
@@ -37,15 +42,12 @@ public ResizedImage(Image image, String resizedImageUrl, ImageSizeType imageSize
     }
 
     public void delete() {
-        this.deletedAt = LocalDateTime.now();
+        deleteYn = true;
+        deletedAt = LocalDateTime.now();
     }
 
     public boolean isDeleted() {
-        return this.deletedAt != null;
-    }
-
-    public boolean isNotDeleted() {
-        return !isDeleted();
+        return deleteYn;
     }
 
     public String getFullResizedImageUrl() {

src/main/java/com/codezerotoone/mvp/domain/image/repository/ImageRepository.java

@@ -13,8 +13,8 @@ public interface ImageRepository extends JpaRepository<Image, Long> {
     @Query("""
             SELECT i
             FROM Image i
-            WHERE i.deletedAt IS NULL
-                AND i.imageId = :imageId
+            WHERE i.deleteYn = false
+                AND i.id = :imageId
             """)
     Optional<Image> findById(@Param("imageId") Long imageId);
 }

src/main/java/com/codezerotoone/mvp/domain/image/service/ImageService.java

@@ -24,6 +24,6 @@ public class ImageService {
     public Long saveImage(String location, List<ResizedImageInfo> imageInfos) {
         Image newImage = Image.create(location, imageInfos);
         newImage = this.imageRepository.save(newImage);
-        return newImage.getImageId();
+        return newImage.getId();
     }
 }