Merge pull request #34 from Namsoo315/남현수-sprint6

남현수 sprint6

Author: Namsoo315

README.md

@@ -1,39 +1,180 @@
-# 프로젝트 마일스톤 & 요구사항
+기본 요구사항
+API 명세
+이번 미션은 아래의 API 스펙과 비교하며 구현해보세요.
 
-## 🚀 프로젝트 마일스톤
+API 스펙 v1.1
+API 스펙을 준수한다면, 아래의 프론트엔드 코드와 호환됩니다.
 
-- RESTful API로 재설계 및 리팩토링
-- Swagger를 활용한 API 문서 자동화
-- 프론트엔드 연동
-- PaaS를 활용한 배포
+정적 리소스 v1.1.4
+소스 코드(참고용) v1.1.4
+프론트엔드 소스 코드는 참고용으로만 활용하세요. 수정하여 활용하는 경우 이어지는 요구사항 또는 미션을 수행하는 데 어려움이 있을 수 있습니다.
 
----
+데이터베이스
+[ ] 아래와 같이 데이터베이스 환경을 설정하세요.
+데이터베이스: discodeit
+유저: discodeit_user
+패스워드: discodeit1234
+[ ] ERD를 참고하여 DDL을 작성하고, 테이블을 생성하세요.
+작성한 DDL 파일은 /src/main/resources/schema.sql 경로에 포함하세요. 9tj7wyc7q-image.png
+PK: Primary Key
+UK: Unique Key
+NN: Not Null
+FK: Foreign Key
+ON DELETE CASCADE: 연관 엔티티 삭제 시 같이 삭제
+ON DELETE SET NULL: 연관 엔티티 삭제 시 NULL로 변경
+Spring Data JPA 적용하기
+[ ] Spring Data JPA와 PostgreSQL을 위한 의존성을 추가하세요.
+[ ] 앞서 구성한 데이터베이스에 연결하기 위한 설정값을 application.yaml 파일에 작성하세요.
+[ ] 디버깅을 위해 SQL 로그와 관련된 설정값을 application.yaml 파일에 작성하세요.
+엔티티 정의하기
+[ ]  클래스 다이어그램을 참고해 도메인 모델의 공통 속성을 추상 클래스로 정의하고 상속 관계를 구현하세요.
 
-## 📋 기본 요구사항
+이때 Serializable 인터페이스는 제외합니다.
 
-1. **RESTful API 재설계**
-    - 스프린트 미션#4에서 구현한 API를 RESTful API로 다시 설계
-    - API 스펙을 확인하고 본인이 설계한 API와 비교
-    - `oasdiff`를 활용하면 API 비교가 수월함
-    - 제공된 API 스펙에 맞추어 구현 (심화 요구사항 프론트엔드 연동을 위해 필수)
+패키지명: com.sprint.mission.discodeit.entity.base
 
-2. **API 테스트**
-    - Postman을 활용하여 컨트롤러 테스트
-    - 테스트 결과를 export하여 PR에 첨부
+클래스 다이어그램
 
-3. **Swagger 기반 API 문서화**
-    - `springdoc-openapi` 활용
-    - Swagger-UI를 통해 API 테스트 가능
+[ ]  JPA의 어노테이션을 활용해 createdAt, updatedAt 속성이 자동으로 설정되도록 구현하세요.
 
----
+@CreatedDate, @LastModifiedDate
+[ ]  클래스 다이어그램을 참고해 클래스 참조 관계를 수정하세요. 필요한 경우 생성자, update 메소드를 수정할 수 있습니다. 단, 아직 JPA Entity와 관련된
+어노테이션은 작성하지 마세요.
 
-## ✨ 심화 요구사항
+클래스 다이어그램
+pq5iz92wt-image.png
 
-1. **정적 리소스 서빙**
-    - 제공된 `fe_1.0.0.zip` 활용
-    - API 스펙을 준수하면 프론트엔드와 정상 연동
+화살표의 방향과 화살표 유무에 유의하세요.
 
-2. **PaaS 배포 (Railway.app)**
-    - Railway.app 가입 및 GitHub 레포지토리 연결
-    - `Settings > Network` 섹션에서 Generate Domain 버튼으로 도메인 생성
-    - 생성된 도메인 접속 후 애플리케이션 테스트
+[ ]  ERD와 클래스 다이어그램을 토대로 연관관계 매핑 정보를 표로 정리해보세요.(이 내용은 PR에 첨부해주세요.)
+| A | B | 다중성 | 방향성 | 부모-자식 관계 | 연관관계의 주인 |
+| ------- | ------------- | ------ | ----------------------------------------- | ------------------------------ | ---------- |
+| User | UserStatus | 1:1 | 단방향 User → UserStatus | 부모: User, 자식: UserStatus | User |
+| User | ReadStatus | 1\:N | 단방향 ReadStatus → User | 부모: User, 자식: ReadStatus | ReadStatus |
+| User | Message | 1\:N | 단방향 Message → User (author) | 부모: User, 자식: Message |
+Message |
+| User | BinaryContent | 1:1 (Nullable) | 단방향 User → BinaryContent (profile)        | 부모: User, 자식:
+BinaryContent | User |
+| Channel | ReadStatus | 1\:N | 단방향 ReadStatus → Channel | 부모: Channel, 자식: ReadStatus |
+ReadStatus |
+| Channel | Message | 1\:N | 단방향 Message → Channel | 부모: Channel, 자식: Message | Message |
+| Message | BinaryContent | 1\:N | 단방향 Message → BinaryContent (attachments) | 부모: Message, 자식:
+BinaryContent | Message |
+
+예시
+엔티티 관계 다중성 방향성 부모-자식 관계 연관관계의 주인
+A:B 1:N B→A 단방향 부모: A, 자식: B B
+[ ] JPA 주요 어노테이션을 활용해 ERD, 연관관계 매핑 정보를 도메인 모델에 반영해보세요.
+@Entity, @Table
+@Column, @Enumerated
+@OneToMany, @OneToOne, @ManyToOne
+@JoinColumn, @JoinTable
+[ ] ERD의 외래키 제약 조건과 연관관계 매핑 정보의 부모-자식 관계를 고려해 영속성 전이와 고아 객체를 정의하세요.
+cascade, orphanRemoval
+레포지토리와 서비스에 JPA 도입하기
+[ ] 기존의 Repository 인터페이스를 JPARepository로 정의하고 쿼리메소드로 대체하세요.
+FileRepository와 JCFRepository 구현체는 삭제합니다.
+[ ] 영속성 컨텍스트의 특징에 맞추어 서비스 레이어를 수정해보세요.
+힌트: 트랜잭션, 영속성 전이, 변경 감지, 지연로딩
+DTO 적극 도입하기
+[ ] Entity를 Controller 까지 그대로 노출했을 때 발생할 수 있는 문제점에 대해 정리해보세요. DTO를 적극 도입했을 때 보일러플레이트 코드가 많아지지만, 그럼에도
+불구하고 어떤 이점이 있는지 알 수 있을거에요.(이 내용은 PR에 첨부해주세요.)
+힌트
+Entity와 API의 결합
+프로덕션 환경에서는 성능을 고려해 OSIV를 false로 설정하는 경우가 대부분
+양방향 연관관계 시 순환 참조
+민감한 데이터
+[ ] 다음의 클래스 다이어그램을 참고하여 DTO를 정의하세요.
+hd4c6g1of-image.png
+
+[ ]  Entity를 DTO로 매핑하는 로직을 책임지는 Mapper 컴포넌트를 정의해 반복되는 코드를 줄여보세요.
+
+패키지명: com.sprint.mission.discodeit.mapper buo7cmjvp-image.png
+BinaryContent 저장 로직 고도화
+데이터베이스에 이미지와 같은 파일을 저장하면 성능 상 불리한 점이 많습니다. 따라서 실제 바이너리 데이터는 별도의 공간에 저장하고, 데이터베이스에는 바이너리 데이터에 대한 메타
+정보(파일명, 크기, 유형 등)만 저장하는 것이 좋습니다.
+
+[ ]  BinaryContent 엔티티는 파일의 메타 정보(fileName, size, contentType)만 표현하도록 bytes 속성을 제거하세요.
+
+[ ]  BinaryContent의 byte[] 데이터 저장을 담당하는 인터페이스를 설계하세요.
+
+저장 매체의 확장성(로컬 저장소, 원격 저장소)을 고려해 인터페이스부터 설계합니다.
+
+패키지명: com.sprint.mission.discodeit.storage
+
+클래스 다이어그램
+nqt5zw2pk-image.png
+
+BinaryContentStorage
+
+바이너리 데이터의 저장/로드를 담당하는 컴포넌트입니다.
+UUID put(UUID, byte[])
+UUID 키 정보를 바탕으로 byte[] 데이터를 저장합니다.
+UUID는 BinaryContent의 Id 입니다.
+InputStream get(UUID)
+키 정보를 바탕으로 byte[] 데이터를 읽어 InputStream 타입으로 반환합니다.
+UUID는 BinaryContent의 Id 입니다.
+ResponseEntity<?> download(BinaryContentDto)
+HTTP API로 다운로드 기능을 제공합니다.
+BinaryContentDto 정보를 바탕으로 파일을 다운로드할 수 있는 응답을 반환합니다.
+[ ]  서비스 레이어에서 기존에 BinaryContent를 저장하던 로직을 BinaryContentStorage를 활용하도록 리팩토링하세요.
+
+[ ]  BinaryContentController에 파일을 다운로드하는 API를 추가하고, BinaryContentStorage에 로직을 위임하세요.
+
+엔드포인트: GET /api/binaryContents/{binaryContentId}/download
+
+요청
+
+값: BinaryContentId
+방식: Query Parameter
+응답: ResponseEntity<?>
+
+클래스 다이어그램
+
+5qwe2kqno-image.png
+
+[ ]  로컬 디스크 저장 방식으로 BinaryContentStorage 구현체를 구현하세요.
+
+클래스 다이어그램
+
+skptrmm5p-image.png
+
+[ ]  discodeit.storage.type 값이 local 인 경우에만 Bean으로 등록되어야 합니다.
+
+Path root
+로컬 디스크의 루트 경로입니다.
+discodeit.storage.local.root-path 설정값을 정의하고, 이 값을 통해 주입합니다.
+void init()
+루트 디렉토리를 초기화합니다.
+Bean이 생성되면 자동으로 호출되도록 합니다.
+Path resolvePath(UUID)
+파일의 실제 저장 위치에 대한 규칙을 정의합니다.
+파일 저장 위치 규칙 예시: {root}/{UUID}
+put, get 메소드에서 호출해 일관된 파일 경로 규칙을 유지합니다.
+ResponseEntity<Resource> donwload(BinaryContentDto)
+get 메소드를 통해 파일의 바이너리 데이터를 조회합니다.
+BinaryContentDto와 바이너리 데이터를 활용해 ResponseEntity<Resource> 응답을 생성 후 반환합니다.
+페이징과 정렬
+[ ] 메시지 목록을 조회할 때 다음의 조건에 따라 페이지네이션 처리를 해보세요.
+50개씩 최근 메시지 순으로 조회합니다.
+총 메시지가 몇개인지 알 필요는 없습니다.
+[ ] 일관된 페이지네이션 응답을 위해 제네릭을 활용해 DTO로 구현하세요.
+패키지명: com.sprint.mission.discodeit.dto.response
+
+클래스 다이어그램
+wj4q7nhn3-image.png
+
+content: 실제 데이터입니다.
+
+number: 페이지 번호입니다.
+
+size: 페이지의 크기입니다.
+
+totalElements: T 데이터의 총 갯수를 의미하며, null일 수 있습니다.
+
+[ ] Slice 또는 Page 객체로부터 DTO를 생성하는 Mapper를 구현하세요.
+패키지명: com.sprint.mission.discodeit.mapper
+
+x7qjncxm0-image.png
+
+확장성을 위해 제네릭 메소드로 구현하세요.

build.gradle

@@ -32,7 +32,6 @@ dependencies {
     developmentOnly 'org.springframework.boot:spring-boot-devtools'
     runtimeOnly 'org.postgresql:postgresql'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
-    
     // https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui
     implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.9")
 }

src/main/java/com/sprint/mission/discodeit/entity/BinaryContent.java

@@ -1,33 +1,39 @@
 package com.sprint.mission.discodeit.entity;
 
+import com.sprint.mission.discodeit.entity.base.BaseEntity;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Table;
 import java.io.Serial;
 import java.io.Serializable;
 import java.time.Instant;
 import java.util.UUID;
 
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
 import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
 
+
+@Table(name = "binary_contents")
+@Entity
 @Getter
-public class BinaryContent implements Serializable {
-
-  @Serial
-  private static final long serialVersionUID = 1L;
-  private final UUID id;
-
-  private final Instant createdAt;
-
-  private final String fileName;
-  private final Long size;
-  private final String contentType;
-  private final byte[] bytes;
-  // 수정 불가능 하기 때문에 updatedAt은 삭제
-
-  public BinaryContent(String fileName, String contentType, Long size, byte[] bytes) {
-    this.id = UUID.randomUUID();
-    this.createdAt = Instant.now();
-    this.fileName = fileName;
-    this.contentType = contentType;
-    this.size = size;
-    this.bytes = bytes;
-  }
+@SuperBuilder
+@AllArgsConstructor(access = AccessLevel.PROTECTED)
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class BinaryContent extends BaseEntity {
+
+  @Column(name = "file_name", nullable = false, length = 255)
+  private String fileName;
+
+  @Column(nullable = false)
+  private Long size;
+
+  @Column(name = "content_type", nullable = false, length = 100)
+  private String contentType;
+
+  @Column(nullable = false)
+  private byte[] bytes;
+
 }

src/main/java/com/sprint/mission/discodeit/entity/Channel.java

@@ -1,51 +1,58 @@
 package com.sprint.mission.discodeit.entity;
 
+import com.sprint.mission.discodeit.entity.base.BaseUpdatableEntity;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.EnumType;
+import jakarta.persistence.Enumerated;
+import jakarta.persistence.Table;
 import java.io.Serial;
 import java.io.Serializable;
 import java.time.Instant;
 import java.util.UUID;
 
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
 import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.experimental.SuperBuilder;
 
+@Table(name = "channels")
+@Entity
 @Getter
-public class Channel implements Serializable {
-
-  @Serial
-  private static final long serialVersionUID = 1L;
-  private final UUID id;
+@SuperBuilder
+@AllArgsConstructor(access = AccessLevel.PROTECTED)
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class Channel extends BaseUpdatableEntity {
 
+  @Column(length = 100)
   private String name;
+
+  @Column(length = 500)
   private String description;
-  private final ChannelType type;
-
-  private final Instant createdAt;
-  private Instant updatedAt;
-
-  public Channel(ChannelType type, String name, String description) {
-    this.id = UUID.randomUUID();
-    this.type = type;
-    this.name = name;
-    this.description = description;
-    this.createdAt = Instant.now();
-    this.updatedAt = createdAt;
-  }
-
-  public void update(String newName, String newDescription) {
-    boolean anyValueUpdated = false;
-
-    if (newName != null && !newName.isEmpty()) {
-      this.name = newName;
-      anyValueUpdated = true;
-    }
-
-    if (newDescription != null && !newDescription.isEmpty()) {
-      this.description = newDescription;
-      anyValueUpdated = true;
-    }
-
-    if (anyValueUpdated) {
-      this.updatedAt = Instant.now();
-    }
-  }
+
+  @Enumerated(EnumType.STRING)
+  @Column(length = 10, nullable = false)
+  private ChannelType type;
+
+//  public Channel(ChannelType type, String name, String description) {
+//    this.type = type;
+//    this.name = name;
+//    this.description = description;
+//  }
+//
+//  public void update(String newName, String newDescription) {
+//    boolean anyValueUpdated = false;
+//
+//    if (newName != null && !newName.isEmpty()) {
+//      this.name = newName;
+//      anyValueUpdated = true;
+//    }
+//
+//    if (newDescription != null && !newDescription.isEmpty()) {
+//      this.description = newDescription;
+//      anyValueUpdated = true;
+//    }
+//  }
 
 }