feat: 이미지 업로드 기능 구현

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

Author: 7zrv

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'

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();
+    }
+
+}

src/main/java/com/somemore/global/exception/ExceptionMessage.java

@@ -14,6 +14,9 @@ public enum ExceptionMessage {
     NOT_EXISTS_LOCATION("존재하지 않는 위치 ID 입니다."),
     NOT_EXISTS_RECRUIT_BOARD("존재하지 않는 봉사 모집글 ID 입니다."),
     UNAUTHORIZED_RECRUIT_BOARD("자신이 작성한 봉사 모집글이 아닙니다."),
+    UPLOAD_FAILED("파일 업로드에 실패했습니다."),
+    INVALID_FILE_TYPE("지원하지 않는 파일 형식입니다."),
+    FILE_SIZE_EXCEEDED("파일 크기가 허용된 한도를 초과했습니다."),
     ;
 
     private final String message;

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);
+    }
+}

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
+) {
+}

src/main/java/com/somemore/imageupload/service/ImageUploadService.java

@@ -0,0 +1,53 @@
+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 lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+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;
+
+    @Value("${cloud.aws.s3.bucket}")
+    private String bucket;
+
+    @Value("${cloud.aws.s3.base-url}")
+    private String baseUrl;
+
+    @Override
+    public String uploadImage(ImageUploadRequestDto requestDto) {
+
+        String fileName = ImageUploadUtils.generateUniqueFileName(requestDto.imageFile().getOriginalFilename());
+
+        PutObjectRequest request = PutObjectRequest.builder()
+                .bucket(bucket)
+                .key(fileName)
+                .contentType(requestDto.imageFile().getContentType())
+                .build();
+
+        try {
+            s3Client.putObject(request, RequestBody.fromInputStream(
+                    requestDto.imageFile().getInputStream(),
+                    requestDto.imageFile().getSize()
+            ));
+
+            return ImageUploadUtils.generateS3Url(baseUrl, fileName);
+        } catch (IOException e) {
+            throw new ImageUploadException(UPLOAD_FAILED.getMessage());
+        }
+    }
+
+}

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);
+}

src/main/java/com/somemore/imageupload/util/ImageUploadUtils.java

@@ -0,0 +1,25 @@
+package com.somemore.imageupload.util;
+
+import java.util.UUID;
+
+public final class ImageUploadUtils {
+
+    private ImageUploadUtils() {
+        throw new UnsupportedOperationException("인스턴스화 할 수 없는 클래스 입니다.");
+    }
+
+    public static String generateUniqueFileName(String originalFileName) {
+        String uuid = UUID.randomUUID().toString();
+        String fileExtension = extractFileExtension(originalFileName);
+        return uuid + fileExtension;
+    }
+
+    public 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);
+    }
+
+}

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: ${ACCESS_KEY}
+      secret-key: ${SECRET_KEY}
+    region:
+      static: ${BUCKET_REGION}
+    s3:
+      bucket: ${BUCKET_NAME}
+      base-url: ${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: 10MB
+      max-request-size: 10MB
+
+
 #swagger
 springdoc:
   swagger-ui:

src/test/java/com/somemore/imageupload/service/ImageUploadServiceTest.java

@@ -0,0 +1,77 @@
+package com.somemore.imageupload.service;
+
+import com.somemore.IntegrationTestSupport;
+import com.somemore.global.exception.ImageUploadException;
+import com.somemore.imageupload.dto.ImageUploadRequestDto;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.springframework.test.util.ReflectionTestUtils;
+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 java.io.InputStream;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+class ImageUploadServiceTest extends IntegrationTestSupport {
+
+    @Mock
+    private S3Client s3Client;
+
+    @InjectMocks
+    private ImageUploadService imageUploadService;
+
+    @Mock
+    private MultipartFile multipartFile;
+
+    @BeforeEach
+    void setUp() throws IOException {
+        imageUploadService = new ImageUploadService(s3Client);
+
+        ReflectionTestUtils.setField(imageUploadService, "bucket", "test-bucket");
+        ReflectionTestUtils.setField(imageUploadService, "baseUrl", "https://amazonaws.com/");
+
+        when(multipartFile.getOriginalFilename()).thenReturn("testImage.jpg");
+        when(multipartFile.getContentType()).thenReturn("image/jpeg");
+        when(multipartFile.getInputStream()).thenReturn(mock(InputStream.class));
+        when(multipartFile.getSize()).thenReturn(1000L);
+    }
+
+    @DisplayName("업로드 요청 이미지를 S3에 업로드 할 수 있다.")
+    @Test
+    void testUploadImage_success() {
+        // given
+        ImageUploadRequestDto requestDto = new ImageUploadRequestDto(multipartFile);
+
+        when(s3Client.putObject(any(PutObjectRequest.class), any(RequestBody.class)))
+                .thenReturn(null);
+
+        // when
+        String result = imageUploadService.uploadImage(requestDto);
+
+        // then
+        verify(s3Client, times(1)).putObject(any(PutObjectRequest.class), any(RequestBody.class));
+        assertNotNull(result);
+        assertTrue(result.startsWith("https://amazonaws.com/"));
+        assertTrue(result.endsWith(".jpg"));
+    }
+
+    @DisplayName("이미지 형식이 올바르지 않다면 업로드 할 수 없다.")
+    @Test
+    void testUploadImage_failure() throws IOException {
+        // given
+        when(multipartFile.getInputStream()).thenThrow(new IOException());
+
+        ImageUploadRequestDto requestDto = new ImageUploadRequestDto(multipartFile);
+
+        // when, then
+        assertThrows(ImageUploadException.class, () -> imageUploadService.uploadImage(requestDto));
+    }
+}