Feature/36 s3 이미지 업로드 기능 구현 (#66)

7zrv · web-flow · commit 0be3598afd33 · 2024-11-28T14:36:34.000+09:00
* feat: 이미지 업로드 기능 구현

- aws s3 연동을 위한 의존성 추가
- 환경변수 추가
- S3 연결을 위한 config 클래스 구현
- 서비스 레이어에 이미지 업로드 기능 구현
- 업로드 실패 예외와 예외 메세지 추
- test.yml에 테스트에 필요한 환경변수 추가
- 테스트 코드 작성및 검증 완료

* chore: 환경변수 추가

- cicd workflow 에 이미지 업로드 관련 환경변수 추가
- appication.yml에 이미지 업로드 관련 환경변수 이름 변경

* feat: 이미지 파일 검증 기능 구현

- 이미지 크기를 8MB로 제한
- 이미지의 크기 초과를 검증하는 기능 구현
- 이미지의 확장자명을 검증하는 기능 구현
- 이미지 업로드시 검증 기능들을 수행하도록 수정
- 전역 예외처리 핸들러에 이미지 업로드 예외 추가
- 예외 메세지 추가
- 테스트 코드 작성및 검증 완

* fix: 코드 리뷰 사항 반영

- BASE_URL을 S3_BASE_URL라는 더 명시적인 이름으로 변경
- ImageUploadUtils private 생성자의 예외처리 메세지를 ExceptionMessage에 등록하여 사용하도록 수정
- 이미지 업로드 메서드의 내부 기능을 메서드로 추출하여 가독성 향상
- ImageUploadUtils의 일부 기능의 접근 제어자를 private으로 수정
- 테스트 코드의 when, then을 더 명확하게 분
diff --git a/.github/workflows/CD.yml b/.github/workflows/CD.yml
@@ -27,6 +27,11 @@ jobs:
       JWT_SECRET: ${{ secrets.JWT_SECRET }}
       FRONT_URL: ${{secrets.FRONT_URL}}
       BACK_URL: ${{secrets.BACK_URL}}
+      BUCKET_NAME: ${{secrets.BUCKET_NAME}}
+      BUCKET_REGION: ${{secrets.BUCKET_REGION}}
+      IMG_BASE_URL: ${{secrets.BASE_URL}}
+      S3_ACCESS_KEY: ${{secrets.S3_ACCESS_KEY}}
+      S3_SECRET_KEY: ${{secrets.S3_SECRET_KEY}}
 
     steps:
       - name: Github Repository 파일 불러오기
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -35,6 +35,11 @@ jobs:
       JWT_SECRET: ${{ secrets.JWT_SECRET }}
       FRONT_URL: ${{secrets.FRONT_URL}}
       BACK_URL: ${{secrets.BACK_URL}}
+      BUCKET_NAME: ${{secrets.BUCKET_NAME}}
+      BUCKET_REGION: ${{secrets.BUCKET_REGION}}
+      IMG_BASE_URL: ${{secrets.BASE_URL}}
+      S3_ACCESS_KEY: ${{secrets.S3_ACCESS_KEY}}
+      S3_SECRET_KEY: ${{secrets.S3_SECRET_KEY}}
 
 
     steps:
diff --git a/build.gradle b/build.gradle
@@ -52,6 +52,9 @@ dependencies {
     runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.12.6'
     runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.12.6'
 
+    // AWS
+    implementation(platform("software.amazon.awssdk:bom:2.29.20"))
+    implementation("software.amazon.awssdk:s3")
 
     // Web Layer
     implementation 'org.springframework.boot:spring-boot-starter-web'
@@ -61,7 +64,6 @@ dependencies {
     annotationProcessor 'org.projectlombok:lombok'
     implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.6.0'
 
-
     //test
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testImplementation 'org.springframework.security:spring-security-test'
diff --git a/src/main/java/com/somemore/global/configure/S3Config.java b/src/main/java/com/somemore/global/configure/S3Config.java
@@ -0,0 +1,45 @@
+package com.somemore.global.configure;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.AwsCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.presigner.S3Presigner;
+
+@Configuration
+public class S3Config {
+    @Value("${cloud.aws.credentials.access-key}")
+    private String accessKey;
+
+    @Value("${cloud.aws.credentials.secret-key}")
+    private String secretKey;
+
+    @Value("${cloud.aws.region.static}")
+    private String region;
+
+    @Bean
+    public AwsCredentials basicAWSCredentials() {
+        return AwsBasicCredentials.create(accessKey, secretKey);
+    }
+
+    @Bean
+    public S3Presigner s3Presigner(AwsCredentials awsCredentials) {
+        return S3Presigner.builder()
+                .region(Region.of(region))
+                .credentialsProvider(StaticCredentialsProvider.create(awsCredentials))
+                .build();
+    }
+
+    @Bean
+    public S3Client s3Client(AwsCredentials awsCredentials) {
+        return S3Client.builder()
+                .region(Region.of(region))
+                .credentialsProvider(StaticCredentialsProvider.create(awsCredentials))
+                .build();
+    }
+
+}
diff --git a/src/main/java/com/somemore/global/exception/ExceptionMessage.java b/src/main/java/com/somemore/global/exception/ExceptionMessage.java
@@ -14,6 +14,11 @@ public enum ExceptionMessage {
     NOT_EXISTS_LOCATION("존재하지 않는 위치 ID 입니다."),
     NOT_EXISTS_RECRUIT_BOARD("존재하지 않는 봉사 모집글 ID 입니다."),
     UNAUTHORIZED_RECRUIT_BOARD("자신이 작성한 봉사 모집글이 아닙니다."),
+    UPLOAD_FAILED("파일 업로드에 실패했습니다."),
+    INVALID_FILE_TYPE("지원하지 않는 파일 형식입니다."),
+    FILE_SIZE_EXCEEDED("파일 크기가 허용된 한도를 초과했습니다."),
+    EMPTY_FILE("파일이 존재하지 않습니다."),
+    INSTANTIATION_NOT_ALLOWED("인스턴스화 할 수 없는 클래스 입니다.")
     ;
 
     private final String message;
diff --git a/src/main/java/com/somemore/global/exception/ImageUploadException.java b/src/main/java/com/somemore/global/exception/ImageUploadException.java
@@ -0,0 +1,8 @@
+package com.somemore.global.exception;
+
+public class ImageUploadException extends RuntimeException{
+
+    public ImageUploadException(String message) {
+        super(message);
+    }
+}
diff --git a/src/main/java/com/somemore/global/handler/GlobalExceptionHandler.java b/src/main/java/com/somemore/global/handler/GlobalExceptionHandler.java
@@ -2,10 +2,13 @@
 
 
 import com.somemore.global.exception.BadRequestException;
+import com.somemore.global.exception.ImageUploadException;
+import org.springframework.data.crossstore.ChangeSetPersister;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ProblemDetail;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
 import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
 
 
@@ -25,4 +28,15 @@ ProblemDetail handleBadRequestException(final BadRequestException e) {
         return problemDetail;
     }
 
+    @ExceptionHandler(ImageUploadException.class)
+    ProblemDetail handleImageUploadException(final ImageUploadException e) {
+
+        ProblemDetail problemDetail = ProblemDetail.forStatusAndDetail(HttpStatus.BAD_REQUEST, e.getMessage());
+
+        problemDetail.setTitle("이미지 업로드 실패");
+        problemDetail.setDetail("업로드 중 문제가 발생했습니다. 파일 크기나 형식이 올바른지 확인해 주세요.");
+
+        return problemDetail;
+    }
+
 }
diff --git a/src/main/java/com/somemore/imageupload/dto/ImageUploadRequestDto.java b/src/main/java/com/somemore/imageupload/dto/ImageUploadRequestDto.java
@@ -0,0 +1,8 @@
+package com.somemore.imageupload.dto;
+
+import org.springframework.web.multipart.MultipartFile;
+
+public record ImageUploadRequestDto(
+        MultipartFile imageFile
+) {
+}
diff --git a/src/main/java/com/somemore/imageupload/service/ImageUploadService.java b/src/main/java/com/somemore/imageupload/service/ImageUploadService.java
@@ -0,0 +1,63 @@
+package com.somemore.imageupload.service;
+
+import com.somemore.global.exception.ImageUploadException;
+import com.somemore.imageupload.dto.ImageUploadRequestDto;
+import com.somemore.imageupload.usecase.ImageUploadUseCase;
+import com.somemore.imageupload.util.ImageUploadUtils;
+import com.somemore.imageupload.validator.ImageUploadValidator;
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
+import software.amazon.awssdk.core.sync.RequestBody;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.PutObjectRequest;
+
+import java.io.IOException;
+
+import static com.somemore.global.exception.ExceptionMessage.UPLOAD_FAILED;
+
+@RequiredArgsConstructor
+@Service
+public class ImageUploadService implements ImageUploadUseCase {
+
+    private final S3Client s3Client;
+    private final ImageUploadValidator imageUploadValidator;
+
+    @Value("${cloud.aws.s3.bucket}")
+    private String bucket;
+
+    @Value("${cloud.aws.s3.base-url}")
+    private String baseUrl;
+
+    @Override
+    public String uploadImage(ImageUploadRequestDto requestDto) {
+        imageUploadValidator.validateFileSize(requestDto.imageFile());
+        imageUploadValidator.validateFileType(requestDto.imageFile());
+
+        try {
+            return uploadToS3(requestDto.imageFile());
+        } catch (IOException e) {
+            throw new ImageUploadException(UPLOAD_FAILED.getMessage());
+        }
+    }
+
+    private String uploadToS3(MultipartFile file) throws IOException {
+        String fileName = ImageUploadUtils.generateUniqueFileName(file.getOriginalFilename());
+
+        PutObjectRequest request = createPutObjectRequest(file, fileName);
+
+        s3Client.putObject(request, RequestBody.fromInputStream(file.getInputStream(), file.getSize()));
+
+        return ImageUploadUtils.generateS3Url(baseUrl, fileName);
+    }
+
+    private PutObjectRequest createPutObjectRequest(MultipartFile file, String fileName) {
+        return PutObjectRequest.builder()
+                .bucket(bucket)
+                .key(fileName)
+                .contentType(file.getContentType())
+                .build();
+    }
+
+}
diff --git a/src/main/java/com/somemore/imageupload/usecase/ImageUploadUseCase.java b/src/main/java/com/somemore/imageupload/usecase/ImageUploadUseCase.java
@@ -0,0 +1,7 @@
+package com.somemore.imageupload.usecase;
+
+import com.somemore.imageupload.dto.ImageUploadRequestDto;
+
+public interface ImageUploadUseCase {
+    String uploadImage(ImageUploadRequestDto requestDto);
+}
diff --git a/src/main/java/com/somemore/imageupload/util/ImageUploadUtils.java b/src/main/java/com/somemore/imageupload/util/ImageUploadUtils.java
@@ -0,0 +1,27 @@
+package com.somemore.imageupload.util;
+
+import java.util.UUID;
+
+import static com.somemore.global.exception.ExceptionMessage.INSTANTIATION_NOT_ALLOWED;
+
+public class ImageUploadUtils {
+
+    private ImageUploadUtils() {
+        throw new UnsupportedOperationException(INSTANTIATION_NOT_ALLOWED.getMessage());
+    }
+
+    public static String generateUniqueFileName(String originalFileName) {
+        String uuid = UUID.randomUUID().toString();
+        String fileExtension = extractFileExtension(originalFileName);
+        return uuid + fileExtension;
+    }
+
+    private static String extractFileExtension(String fileName) {
+        return fileName.substring(fileName.lastIndexOf("."));
+    }
+
+    public static String generateS3Url(String baseUrl, String fileName) {
+        return String.format("%s/%s", baseUrl, fileName);
+    }
+
+}
diff --git a/src/main/java/com/somemore/imageupload/validator/DefaultImageUploadValidator.java b/src/main/java/com/somemore/imageupload/validator/DefaultImageUploadValidator.java
@@ -0,0 +1,39 @@
+package com.somemore.imageupload.validator;
+
+import com.somemore.global.exception.ImageUploadException;
+import org.springframework.stereotype.Component;
+import org.springframework.web.multipart.MultipartFile;
+
+import static com.somemore.global.exception.ExceptionMessage.*;
+
+@Component
+public class DefaultImageUploadValidator implements ImageUploadValidator {
+
+    private static final long MAX_FILE_SIZE = 8L * 1024 * 1024; // 8MB
+
+    public void validateFileSize(MultipartFile file) {
+        if (file == null || file.isEmpty()) {
+            throw new ImageUploadException(EMPTY_FILE.getMessage());
+        }
+
+        if (file.getSize() > MAX_FILE_SIZE) {
+            throw new ImageUploadException(FILE_SIZE_EXCEEDED.getMessage());
+        }
+    }
+
+    public void validateFileType(MultipartFile file) {
+        String contentType = file.getContentType();
+        if (!isAllowedImageType(contentType)) {
+            throw new ImageUploadException(INVALID_FILE_TYPE.getMessage());
+        }
+    }
+
+    private boolean isAllowedImageType(String contentType) {
+        return contentType != null && (
+                contentType.equals("image/jpeg") ||
+                        contentType.equals("image/png") ||
+                        contentType.equals("image/gif") ||
+                        contentType.equals("image/webp")
+        );
+    }
+}
diff --git a/src/main/java/com/somemore/imageupload/validator/ImageUploadValidator.java b/src/main/java/com/somemore/imageupload/validator/ImageUploadValidator.java
@@ -0,0 +1,9 @@
+package com.somemore.imageupload.validator;
+
+import org.springframework.web.multipart.MultipartFile;
+
+public interface ImageUploadValidator {
+
+    void validateFileSize(MultipartFile file);
+    void validateFileType(MultipartFile file);
+}
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
@@ -2,6 +2,20 @@ app:
   front-url: ${FRONT_URL}
   back-url: ${BACK_URL}
 
+# AWS S3
+cloud:
+  aws:
+    credentials:
+      access-key: ${S3_ACCESS_KEY}
+      secret-key: ${S3_SECRET_KEY}
+    region:
+      static: ${BUCKET_REGION}
+    s3:
+      bucket: ${BUCKET_NAME}
+      base-url: ${IMG_BASE_URL}
+    stack:
+      auto: false
+
 spring:
   datasource:
     driver-class-name: com.mysql.cj.jdbc.Driver
@@ -47,6 +61,12 @@ spring:
     locale: ko_KR
     locale-resolver: fixed
 
+  servlet:
+    multipart:
+      max-file-size: 8MB
+      max-request-size: 8MB
+
+
 #swagger
 springdoc:
   swagger-ui:
diff --git a/src/test/java/com/somemore/imageupload/service/ImageUploadServiceTest.java b/src/test/java/com/somemore/imageupload/service/ImageUploadServiceTest.java
diff --git a/src/test/java/com/somemore/imageupload/util/ImageUploadUtilsTest.java b/src/test/java/com/somemore/imageupload/util/ImageUploadUtilsTest.java
diff --git a/src/test/java/com/somemore/imageupload/validator/DefaultImageUploadValidatorTest.java b/src/test/java/com/somemore/imageupload/validator/DefaultImageUploadValidatorTest.java
diff --git a/src/test/resources/application-test.yml b/src/test/resources/application-test.yml
