[황준수] Sprint6

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,21 +1,25 @@
-
 ## 요구사항
 
 ### 기본
+
 - [x] 기본 항목 1
 - [ ] 기본 항목 2
 
 ### 심화
+
 - [ ] 심화 항목 1
 - [ ] 심화 항목 2
 
 ## 주요 변경사항
 - 
-- 
+
+-
 
 ## 스크린샷
+
 ![image](이미지url)
 
 ## 멘토에게
+
 - 셀프 코드 리뷰를 통해 질문 이어가겠습니다.
 - 

.gitignore

@@ -51,3 +51,4 @@ bin/
 
 ### Mac OS ###
 .DS_Store
+/data/**

build.gradle

@@ -1,37 +1,46 @@
 plugins {
-	id 'java'
-	id 'org.springframework.boot' version '4.0.2'
-	id 'io.spring.dependency-management' version '1.1.7'
+    id 'java'
+    id 'org.springframework.boot' version '3.4.0'
+    id 'io.spring.dependency-management' version '1.1.6'
 }
 
 group = 'com.sprint.mission'
 version = '0.0.1-SNAPSHOT'
-description = 'Sprint Mission 3'
+description = 'Sprint Mission 6'
 
 java {
-	toolchain {
-		languageVersion = JavaLanguageVersion.of(17)
-	}
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
 }
 
 configurations {
-	compileOnly {
-		extendsFrom annotationProcessor
-	}
+    compileOnly {
+        extendsFrom annotationProcessor
+    }
 }
 
 repositories {
-	mavenCentral()
+    mavenCentral()
 }
 
 dependencies {
-	implementation 'org.springframework.boot:spring-boot-starter-webmvc'
-	compileOnly 'org.projectlombok:lombok'
-	annotationProcessor 'org.projectlombok:lombok'
-	testImplementation 'org.springframework.boot:spring-boot-starter-webmvc-test'
-	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.14'
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    implementation 'org.postgresql:postgresql:42.7.3'
+    compileOnly 'org.projectlombok:lombok'
+    annotationProcessor 'org.projectlombok:lombok'
+    implementation 'org.mapstruct:mapstruct:1.6.3'
+    annotationProcessor 'org.mapstruct:mapstruct-processor:1.6.3'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }
 
 tasks.named('test') {
-	useJUnitPlatform()
+    useJUnitPlatform()
+}
+
+jar {
+    enabled = false
 }

src/main/java/com/sprint/mission/discodeit/DiscodeitApplication.java

@@ -6,7 +6,7 @@
 @SpringBootApplication
 public class DiscodeitApplication {
 
-	public static void main(String[] args) {
-		SpringApplication.run(DiscodeitApplication.class, args);
-	}
+  public static void main(String[] args) {
+    SpringApplication.run(DiscodeitApplication.class, args);
+  }
 }

src/main/java/com/sprint/mission/discodeit/base/BaseEntity.java

@@ -0,0 +1,49 @@
+package com.sprint.mission.discodeit.base;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.EntityListeners;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.MappedSuperclass;
+import java.time.Instant;
+import java.util.UUID;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import org.springframework.data.annotation.CreatedDate;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
+
+@Getter
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@MappedSuperclass
+@EntityListeners(AuditingEntityListener.class)
+public abstract class BaseEntity {
+
+  @Id
+  @GeneratedValue(strategy = GenerationType.UUID)
+  protected UUID id;
+
+  @CreatedDate
+  @Column(nullable = false, updatable = false)
+  protected Instant createdAt;
+
+  @Override
+  public boolean equals(Object obj) {
+    if (this == obj) {
+      return true;
+    }
+    if (obj == null) {
+      return false;
+    }
+    if (getClass() != obj.getClass()) {
+      return false;
+    }
+    return id.equals(((BaseEntity) obj).id);
+  }
+
+  @Override
+  public int hashCode() {
+    return id.hashCode();
+  }
+}

src/main/java/com/sprint/mission/discodeit/base/BaseUpdatableEntity.java

@@ -0,0 +1,31 @@
+package com.sprint.mission.discodeit.base;
+
+import jakarta.persistence.MappedSuperclass;
+import java.time.Instant;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import org.springframework.data.annotation.LastModifiedDate;
+
+@Getter
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@MappedSuperclass
+public abstract class BaseUpdatableEntity extends BaseEntity {
+
+  @LastModifiedDate
+  protected Instant updatedAt;
+
+  @Override
+  public boolean equals(Object obj) {
+    if (this == obj) {
+      return true;
+    }
+    if (obj == null) {
+      return false;
+    }
+    if (getClass() != obj.getClass()) {
+      return false;
+    }
+    return id.equals(((BaseUpdatableEntity) obj).id);
+  }
+}

src/main/java/com/sprint/mission/discodeit/binarycontent/controller/BinaryContentController.java

@@ -1,30 +1,98 @@
 package com.sprint.mission.discodeit.binarycontent.controller;
 
-import com.sprint.mission.discodeit.binarycontent.dto.BinaryContentInfo;
+import com.sprint.mission.discodeit.binarycontent.dto.BinaryContentDto;
 import com.sprint.mission.discodeit.binarycontent.dto.BinaryContentsRequest;
 import com.sprint.mission.discodeit.binarycontent.service.BinaryContentService;
-import lombok.RequiredArgsConstructor;
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.*;
-
+import com.sprint.mission.discodeit.storage.BinaryContentStorage;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import java.util.UUID;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
 
 @RequiredArgsConstructor
 @RestController
-@RequestMapping("/binarycontents")
+@RequestMapping("/api/binaryContents")
+@Tag(name = "BinaryContent", description = "첨부 파일 API")
 public class BinaryContentController {
-    private final BinaryContentService binaryContentService;
 
-    @RequestMapping(value = "/{contentId}", method = RequestMethod.GET)
-    public ResponseEntity<BinaryContentInfo> getBinaryContent(@PathVariable UUID contentId) {
-        return ResponseEntity.ok(binaryContentService.findBinaryContent(contentId));
-    }
+  private final BinaryContentService binaryContentService;
+  private final BinaryContentStorage storage;
+
+  @Operation(summary = "첨부 파일 조회")
+  @ApiResponses(value = {
+      @ApiResponse(
+          responseCode = "200", description = "첨부 파일 조회 성공",
+          content = @Content(
+              mediaType = MediaType.ALL_VALUE,
+              schema = @Schema(implementation = BinaryContentDto.class)
+          )
+      ),
+      @ApiResponse(
+          responseCode = "404", description = "첨부 파일을 찾을 수 없음",
+          content = @Content(
+              mediaType = MediaType.ALL_VALUE,
+              examples = @ExampleObject("BinaryContent with id {binaryContentId} not found")
+          )
+      )
+  })
+  @GetMapping(value = "/{binaryContentId}")
+  public ResponseEntity<BinaryContentDto> find(
+      @Parameter(description = "조회할 첨부 파일 ID") @PathVariable UUID binaryContentId
+  ) {
+    return ResponseEntity.ok(binaryContentService.findBinaryContent(binaryContentId));
+  }
+
+  @Operation(summary = "여러 첨부 파일 조회")
+  @ApiResponses(value = {
+      @ApiResponse(
+          responseCode = "200", description = "첨부 파일 목록 조회 성공",
+          content = @Content(
+              mediaType = MediaType.ALL_VALUE,
+              array = @ArraySchema(schema = @Schema(implementation = BinaryContentDto.class))
+          )
+      )
+  })
+  @GetMapping
+  public ResponseEntity<List<BinaryContentDto>> findAllByIdIn(
+      @Parameter(description = "조회할 첨부 파일 ID 목록",
+          array = @ArraySchema(schema = @Schema(implementation = UUID.class))
+      )
+      @RequestParam List<UUID> binaryContentIds
+  ) {
+    BinaryContentsRequest request = new BinaryContentsRequest(binaryContentIds);
+    return ResponseEntity.ok(binaryContentService.findAllByIdIn(request));
+  }
 
-    @RequestMapping(method = RequestMethod.GET)
-    public ResponseEntity<List<BinaryContentInfo>> getBinaryContents(
-            @RequestBody BinaryContentsRequest request
-    ) {
-        return ResponseEntity.ok(binaryContentService.findAllByIdIn(request));
-    }
+  @Operation(summary = "파일 다운로드")
+  @ApiResponses(value = {
+      @ApiResponse(
+          responseCode = "200", description = "파일 다운로드 성공",
+          content = @Content(
+              mediaType = MediaType.ALL_VALUE,
+              schema = @Schema(type = "string", format = "binary")
+          )
+      )
+  })
+  @GetMapping("/{binaryContentId}/download")
+  public ResponseEntity<?> download(
+      @Parameter(description = "다운로드할 파일 ID", required = true) @PathVariable UUID binaryContentId
+  ) {
+    BinaryContentDto binaryContent = binaryContentService.findBinaryContent(binaryContentId);
+    return storage.download(binaryContent);
+  }
 }

src/main/java/com/sprint/mission/discodeit/binarycontent/dto/BinaryContentCreateRequest.java

@@ -0,0 +1,9 @@
+package com.sprint.mission.discodeit.binarycontent.dto;
+
+public record BinaryContentCreateRequest(
+    String fileName,
+    String contentType,
+    byte[] bytes
+) {
+
+}

src/main/java/com/sprint/mission/discodeit/binarycontent/dto/BinaryContentDto.java

@@ -0,0 +1,12 @@
+package com.sprint.mission.discodeit.binarycontent.dto;
+
+import java.util.UUID;
+
+public record BinaryContentDto(
+    UUID id,
+    String fileName,
+    Long size,
+    String contentType
+) {
+
+}

src/main/java/com/sprint/mission/discodeit/binarycontent/dto/BinaryContentsRequest.java

@@ -4,5 +4,7 @@
 import java.util.UUID;
 
 public record BinaryContentsRequest(
-        List<UUID> contentIds
-) {}
+    List<UUID> ids
+) {
+
+}