GETP-170 feat: 파일 업로드 기능 구현

.gitignore

@@ -105,6 +105,7 @@ local.sh
 
 # Static Resources
 src/main/resources/static/*
+src/test/resources/static/*
 storage/
 
 # Yml File

src/docs/asciidoc/member/upload-profile-image.adoc

@@ -1,2 +1 @@
-operation::/upload-profile-image/upload-profile-image/[snippets="httpie-request,request-parts,http-response,response-fields-data"]
-operation::/upload-profile-image/upload-profile-image-error-code/[snippets="error-code-fields"]
+operation::/upload-profile-image/upload-profile-image/[snippets="httpie-request,request-headers,request-parts,http-response,response-fields-data"]

src/docs/asciidoc/storage/upload-file.adoc

@@ -0,0 +1 @@
+operation::/upload-file/upload-file/[snippets="httpie-request,request-headers,request-parts,http-response,response-fields-data"]

src/main/java/es/princip/getp/domain/member/command/domain/service/ProfileImageService.java

@@ -3,24 +3,43 @@
 import es.princip.getp.domain.member.command.domain.model.Member;
 import es.princip.getp.domain.member.command.domain.model.ProfileImage;
 import es.princip.getp.domain.member.command.exception.FailedToSaveProfileImageException;
+import es.princip.getp.infra.storage.application.ImageStorage;
+import es.princip.getp.infra.util.ImageUtil;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
 import org.springframework.web.multipart.MultipartFile;
 
-public interface ProfileImageService {
-
-    /**
-     * 회원의 프로필 이미지를 저장한다.
-     *
-     * @param member 회원
-     * @param image 프로필 이미지 MultiPartFile
-     * @throws FailedToSaveProfileImageException 프로필 이미지 저장에 실패한 경우
-     * @return 저장된 프로필 이미지
-     */
-    ProfileImage saveProfileImage(Member member, MultipartFile image);
-
-    /**
-     * 프로필 이미지를 삭제한다.
-     *
-     * @param profileImage 삭제할 프로필 이미지
-     */
-    void deleteProfileImage(ProfileImage profileImage);
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+@Service
+@RequiredArgsConstructor
+public class ProfileImageService {
+
+    public static final String PROFILE_IMAGE_PREFIX = "profile";
+
+    private final ImageStorage imageStorage;
+
+    public ProfileImage saveProfileImage(final Member member, final MultipartFile image) {
+        final Path destination = getPathToSaveProfileImage(member, image);
+        try (InputStream in = image.getInputStream()) {
+            final URI uri = imageStorage.storeImage(destination, in);
+            return ProfileImage.of(uri.toString());
+        } catch (IOException exception) {
+            throw new FailedToSaveProfileImageException();
+        }
+    }
+
+    private Path getPathToSaveProfileImage(final Member member, final MultipartFile image) {
+        final String memberId = String.valueOf(member.getMemberId());
+        final String fileName = ImageUtil.generateRandomFilename(image.getOriginalFilename());
+        return Paths.get(memberId).resolve(PROFILE_IMAGE_PREFIX).resolve(fileName);
+    }
+
+    public void deleteProfileImage(final ProfileImage profileImage) {
+        imageStorage.deleteImage(URI.create(profileImage.getUri()));
+    }
 }

src/main/java/es/princip/getp/infra/exception/handler/ApiErrorExceptionHandler.java

@@ -3,17 +3,20 @@
 import es.princip.getp.infra.dto.response.ApiErrorResponse;
 import es.princip.getp.infra.dto.response.ApiErrorResponse.ApiErrorResult;
 import es.princip.getp.infra.exception.ApiErrorException;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.core.annotation.Order;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 
-@RestControllerAdvice
+@Slf4j
 @Order(100)
+@RestControllerAdvice
 public class ApiErrorExceptionHandler {
 
     @ExceptionHandler(ApiErrorException.class)
     public ResponseEntity<ApiErrorResult> handleBusinessLogicException(final ApiErrorException exception) {
+        log.debug("ApiErrorException: ", exception);
         return ApiErrorResponse.error(exception.getStatus(), exception.getDescription());
     }
 }

src/main/java/es/princip/getp/infra/exception/handler/DefaultExceptionHandler.java

@@ -23,7 +23,7 @@ public ResponseEntity<ApiErrorResult> handleHttpRequestMethodNotSupportedExcepti
 
     @ExceptionHandler(Exception.class)
     public ResponseEntity<ApiErrorResult> handleException(final Exception exception) {
-        log.info(exception.getMessage());
+        log.error(exception.getMessage(), exception);
         return ApiErrorResponse.error(DefaultErrorCode.INTERNAL_SERVER_ERROR);
     }
 }

src/main/java/es/princip/getp/infra/storage/application/FileStorage.java

@@ -0,0 +1,11 @@
+package es.princip.getp.infra.storage.application;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.nio.file.Path;
+
+public interface FileStorage {
+
+    URI storeFile(InputStream in, Path destination) throws IOException;
+}

src/main/java/es/princip/getp/infra/storage/application/FileUploadLoggingService.java

@@ -0,0 +1,22 @@
+package es.princip.getp.infra.storage.application;
+
+import es.princip.getp.infra.storage.domain.FileLog;
+import es.princip.getp.infra.storage.domain.FileLogRepository;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Service
+@RequiredArgsConstructor
+public class FileUploadLoggingService {
+
+    private final FileLogRepository fileLogRepository;
+
+    @Transactional
+    public FileLog logFile(final String fileName) {
+        final String converted = fileName.replace(" ", "_");
+        final FileLog fileLog = new FileLog(converted);
+        fileLogRepository.save(fileLog);
+        return fileLog;
+    }
+}

src/main/java/es/princip/getp/infra/storage/application/FileUploadService.java

@@ -0,0 +1,56 @@
+package es.princip.getp.infra.storage.application;
+
+import es.princip.getp.infra.storage.domain.FileLog;
+import es.princip.getp.infra.storage.exception.FailedFileSaveException;
+import es.princip.getp.infra.storage.exception.NotSupportedExtensionException;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.InputStream;
+import java.net.URI;
+import java.nio.file.Path;
+import java.util.Set;
+
+@Service
+@RequiredArgsConstructor
+public class FileUploadService {
+
+    private final FileStorage fileStorage;
+    private final FileUploadLoggingService fileUploadLoggingService;
+
+    private static final Set<String> ALLOWED_MIME_TYPES = Set.of(
+        "application/pdf",
+        "application/zip",
+        "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+        "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+        "application/x-hwp",
+        "image/jpeg",
+        "image/png"
+    );
+
+    public URI uploadFile(final MultipartFile file) {
+        validateContentType(file);
+
+        if (file.getOriginalFilename() == null) {
+            throw new FailedFileSaveException();
+        }
+
+        final FileLog fileLog = fileUploadLoggingService.logFile(file.getOriginalFilename());
+        final Path filePath = fileLog.getFilePath();
+
+        try (final InputStream in = file.getInputStream()) {
+            return fileStorage.storeFile(in, filePath);
+        } catch (Exception exception) {
+            throw new FailedFileSaveException();
+        }
+    }
+
+    private void validateContentType(final MultipartFile file) {
+        final String contentType = file.getContentType();
+
+        if (!ALLOWED_MIME_TYPES.contains(contentType)) {
+            throw new NotSupportedExtensionException();
+        }
+    }
+}

src/main/java/es/princip/getp/infra/storage/application/ImageStorage.java

@@ -0,0 +1,13 @@
+package es.princip.getp.infra.storage.application;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.nio.file.Path;
+
+public interface ImageStorage {
+
+    URI storeImage(Path destination, InputStream imageStream) throws IOException;
+
+    void deleteImage(URI destination);
+}

src/main/java/es/princip/getp/infra/storage/domain/FileLog.java

@@ -0,0 +1,33 @@
+package es.princip.getp.infra.storage.domain;
+
+import es.princip.getp.domain.common.domain.BaseTimeEntity;
+import jakarta.persistence.*;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+@Entity
+@Table(name = "file_log")
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class FileLog extends BaseTimeEntity {
+
+    @Id
+    @Getter
+    @Column(name = "file_log_id")
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(name = "file_name")
+    private String fileName;
+
+    public FileLog(final String fileName) {
+        this.fileName = fileName;
+    }
+
+    public Path getFilePath() {
+        return Paths.get(String.valueOf(id)).resolve(fileName);
+    }
+}

src/main/java/es/princip/getp/infra/storage/domain/FileLogRepository.java

@@ -0,0 +1,8 @@
+package es.princip.getp.infra.storage.domain;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface FileLogRepository extends JpaRepository<FileLog, Long> {
+}

src/main/java/es/princip/getp/infra/storage/exception/FailedFileSaveException.java

@@ -0,0 +1,14 @@
+package es.princip.getp.infra.storage.exception;
+
+import es.princip.getp.infra.exception.ErrorDescription;
+import es.princip.getp.infra.exception.ExternalApiErrorException;
+
+public class FailedFileSaveException extends ExternalApiErrorException {
+
+    private static final String code = "FAILED_FILE_SAVE";
+    private static final String message = "파일 저장에 실패했습니다. 잠시 후 다시 시도해주세요.";
+
+    public FailedFileSaveException() {
+        super(ErrorDescription.of(code, message));
+    }
+}

src/main/java/es/princip/getp/infra/storage/exception/FailedImageSaveException.java

@@ -0,0 +1,14 @@
+package es.princip.getp.infra.storage.exception;
+
+import es.princip.getp.infra.exception.ErrorDescription;
+import es.princip.getp.infra.exception.ExternalApiErrorException;
+
+public class FailedImageSaveException extends ExternalApiErrorException {
+
+    private static final String code = "FAILED_IMAGE_SAVE";
+    private static final String message = "사진 저장에 실패했습니다. 잠시 후 다시 시도해주세요.";
+
+    public FailedImageSaveException() {
+        super(ErrorDescription.of(code, message));
+    }
+}

src/main/java/es/princip/getp/infra/storage/exception/NotSupportedExtensionException.java

@@ -0,0 +1,14 @@
+package es.princip.getp.infra.storage.exception;
+
+import es.princip.getp.infra.exception.BusinessLogicException;
+import es.princip.getp.infra.exception.ErrorDescription;
+
+public class NotSupportedExtensionException extends BusinessLogicException {
+
+    private static final String code = "NOT_SUPPORTED_EXTENSION";
+    private static final String message = "지원하지 않는 확장자입니다.";
+
+    public NotSupportedExtensionException() {
+        super(ErrorDescription.of(code, message));
+    }
+}