Feat/#386 image (#391)

* chore : S3 의존성 추가 * feat : Amazon S3 Component 추가 * feat : S3 에 업로드 될 Image 의 이름을 설정해주는 ImageName 과 UploadFile 추가 * feat : S3 에 업로드 될 Image 의 이름을 설정해주는 ImageNae 과 UploadFile 추가 * feat : 파일을 업로드하고 해당하는 URL 을 반환하는 Service 구현 * chore : s3 환경 설정 추가 * feat : String image -> MultipartFile image 로 변경 * feat : @RequestPart 적용 및 S3 upload 로직 추가 * chore : Test 시 Profile 설정 * test : 테스트 시 S3 에 접근하지 않도록 하기 위해 Profile 별로 S3Service Bean 구분 * test : 추가된 Image 저장 기능에 맞춰 일부 Test 수정 * chore : S3, CloudFront 환경설정 적용 * test : RestDocs 수정중
woowacourse-teams · Sep 11, 2023 · cc91595 · cc91595
1 parent 34f646e
commit cc91595
Show file tree

Hide file tree

Showing 28 changed files with 492 additions and 53 deletions.
diff --git a/backend/build.gradle b/backend/build.gradle
@@ -45,6 +45,10 @@ dependencies {
     testImplementation 'io.rest-assured:spring-mock-mvc'
     testImplementation 'org.assertj:assertj-core:3.19.0'
 
+    // S3
+    implementation platform('com.amazonaws:aws-java-sdk-bom:1.11.1000')
+    implementation 'com.amazonaws:aws-java-sdk-s3'
+
     compileOnly 'org.projectlombok:lombok'
     runtimeOnly 'com.h2database:h2'
 

diff --git a/backend/src/main/java/com/mapbefine/mapbefine/common/config/S3Config.java b/backend/src/main/java/com/mapbefine/mapbefine/common/config/S3Config.java
@@ -0,0 +1,19 @@
+package com.mapbefine.mapbefine.common.config;
+
+import com.amazonaws.regions.Regions;
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.AmazonS3ClientBuilder;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class S3Config {
+
+    @Bean
+    public AmazonS3 amazonS3() {
+        return AmazonS3ClientBuilder.standard()
+                .withRegion(Regions.AP_NORTHEAST_2)
+                .build();
+    }
+
+}
diff --git a/backend/src/main/java/com/mapbefine/mapbefine/pin/application/PinCommandService.java b/backend/src/main/java/com/mapbefine/mapbefine/pin/application/PinCommandService.java
@@ -21,6 +21,7 @@
 import com.mapbefine.mapbefine.pin.dto.request.PinUpdateRequest;
 import com.mapbefine.mapbefine.pin.exception.PinException.PinBadRequestException;
 import com.mapbefine.mapbefine.pin.exception.PinException.PinForbiddenException;
+import com.mapbefine.mapbefine.s3.application.S3Service;
 import com.mapbefine.mapbefine.topic.domain.Topic;
 import com.mapbefine.mapbefine.topic.domain.TopicRepository;
 import com.mapbefine.mapbefine.topic.exception.TopicException.TopicBadRequestException;
@@ -40,22 +41,24 @@ public class PinCommandService {
     private final TopicRepository topicRepository;
     private final MemberRepository memberRepository;
     private final PinImageRepository pinImageRepository;
+    private final S3Service s3Service;
 
     public PinCommandService(
             PinRepository pinRepository,
             LocationRepository locationRepository,
             TopicRepository topicRepository,
             MemberRepository memberRepository,
-            PinImageRepository pinImageRepository
+            PinImageRepository pinImageRepository,
+            S3Service s3Service
     ) {
         this.pinRepository = pinRepository;
         this.locationRepository = locationRepository;
         this.topicRepository = topicRepository;
         this.memberRepository = memberRepository;
         this.pinImageRepository = pinImageRepository;
+        this.s3Service = s3Service;
     }
 
-
     public long save(AuthMember authMember, PinCreateRequest request) {
         Topic topic = findTopic(request.topicId());
         validatePinCreateOrUpdate(authMember, topic);
@@ -138,8 +141,9 @@ public void removeById(AuthMember authMember, Long pinId) {
     public void addImage(AuthMember authMember, PinImageCreateRequest request) {
         Pin pin = findPin(request.pinId());
         validatePinCreateOrUpdate(authMember, pin.getTopic());
+        String image = s3Service.upload(request.image());
 
-        PinImage pinImage = PinImage.createPinImageAssociatedWithPin(request.imageUrl(), pin);
+        PinImage pinImage = PinImage.createPinImageAssociatedWithPin(image, pin);
         pinImageRepository.save(pinImage);
     }
 

diff --git a/backend/src/main/java/com/mapbefine/mapbefine/pin/dto/request/PinImageCreateRequest.java b/backend/src/main/java/com/mapbefine/mapbefine/pin/dto/request/PinImageCreateRequest.java
@@ -1,7 +1,9 @@
 package com.mapbefine.mapbefine.pin.dto.request;
 
+import org.springframework.web.multipart.MultipartFile;
+
 public record PinImageCreateRequest(
         Long pinId,
-        String imageUrl
+        MultipartFile image
 ) {
 }
diff --git a/backend/src/main/java/com/mapbefine/mapbefine/pin/presentation/PinController.java b/backend/src/main/java/com/mapbefine/mapbefine/pin/presentation/PinController.java
@@ -12,6 +12,7 @@
 import java.net.URI;
 import java.util.List;
 import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -21,7 +22,9 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RequestPart;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
 
 @RestController
 @RequestMapping("/pins")
@@ -92,9 +95,16 @@ public ResponseEntity<List<PinResponse>> findAllPinsByMemberId(
     }
 
     @LoginRequired
-    @PostMapping("/images")
-    public ResponseEntity<Void> addImage(AuthMember member, @RequestBody PinImageCreateRequest request) {
-        pinCommandService.addImage(member, request);
+    @PostMapping(
+            value = "/images",
+            consumes = {MediaType.MULTIPART_FORM_DATA_VALUE, MediaType.APPLICATION_JSON_VALUE}
+    )
+    public ResponseEntity<Void> addImage(
+            AuthMember member,
+            @RequestPart Long pinId,
+            @RequestPart MultipartFile image
+    ) {
+        pinCommandService.addImage(member, new PinImageCreateRequest(pinId, image));
 
         return ResponseEntity.status(HttpStatus.CREATED).build();
     }

diff --git a/backend/src/main/java/com/mapbefine/mapbefine/s3/application/S3Service.java b/backend/src/main/java/com/mapbefine/mapbefine/s3/application/S3Service.java
@@ -0,0 +1,11 @@
+package com.mapbefine.mapbefine.s3.application;
+
+import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
+
+@Service
+public interface S3Service {
+
+    String upload(MultipartFile multipartFile);
+
+}
diff --git a/backend/src/main/java/com/mapbefine/mapbefine/s3/application/S3ServiceImpl.java b/backend/src/main/java/com/mapbefine/mapbefine/s3/application/S3ServiceImpl.java
@@ -0,0 +1,43 @@
+package com.mapbefine.mapbefine.s3.application;
+
+import com.mapbefine.mapbefine.s3.domain.S3Client;
+import com.mapbefine.mapbefine.s3.domain.UploadFile;
+import java.io.IOException;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
+
+@Service
+@Profile("!test")
+public class S3ServiceImpl implements S3Service {
+
+    @Value("${prefix.upload.path}")
+    private String prefixUploadPath;
+    private final S3Client s3Client;
+
+    public S3ServiceImpl(S3Client s3Client) {
+        this.s3Client = s3Client;
+    }
+
+    @Override
+    public String upload(MultipartFile multipartFile) {
+        try {
+            UploadFile uploadFile = UploadFile.of(multipartFile);
+            s3Client.upload(uploadFile);
+            return getUploadPath(uploadFile);
+        } catch (IOException exception) {
+            throw new RuntimeException(exception);
+        }
+    }
+
+    private String getUploadPath(final UploadFile uploadFile) {
+        return String.join(
+                "/",
+                prefixUploadPath,
+                uploadFile.getOriginalFilename()
+        );
+    }
+
+}
+
diff --git a/backend/src/main/java/com/mapbefine/mapbefine/s3/domain/ImageName.java b/backend/src/main/java/com/mapbefine/mapbefine/s3/domain/ImageName.java
@@ -0,0 +1,34 @@
+package com.mapbefine.mapbefine.s3.domain;
+
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+public class ImageName {
+
+    private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("yyyyMMddHHmmssSSSSSS");
+    private static final String EXTENSION_DELIMITER = ".";
+
+    private final String fileName;
+
+    private ImageName(String fileName) {
+        this.fileName = fileName;
+    }
+
+    public static ImageName from(String originalFileName) {
+        String fileName = FORMATTER.format(LocalDateTime.now());
+        String extension = getExtension(originalFileName);
+
+        return new ImageName(fileName + extension);
+    }
+
+    private static String getExtension(String originalFileName) {
+        return originalFileName.substring(
+                originalFileName.lastIndexOf(EXTENSION_DELIMITER)
+        );
+    }
+
+    public String getFileName() {
+        return fileName;
+    }
+
+}
diff --git a/backend/src/main/java/com/mapbefine/mapbefine/s3/domain/S3Client.java b/backend/src/main/java/com/mapbefine/mapbefine/s3/domain/S3Client.java
@@ -0,0 +1,47 @@
+package com.mapbefine.mapbefine.s3.domain;
+
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.model.DeleteObjectRequest;
+import com.amazonaws.services.s3.model.PutObjectRequest;
+import java.io.File;
+import java.io.IOException;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
+import org.springframework.web.multipart.MultipartFile;
+
+@Component
+public class S3Client {
+
+    @Value("${s3.bucket}")
+    private String bucket;
+    private final AmazonS3 amazonS3;
+
+    public S3Client(AmazonS3 amazonS3) {
+        this.amazonS3 = amazonS3;
+    }
+
+    public void upload(MultipartFile multipartFile) {
+        File tempFile = null;
+
+        try {
+            tempFile = File.createTempFile("upload_", ".tmp");
+            multipartFile.transferTo(tempFile);
+            amazonS3.putObject(new PutObjectRequest(bucket, multipartFile.getOriginalFilename(), tempFile));
+        } catch (IOException e) { // TODO: 2023/09/07 Exception 을 수정
+            throw new RuntimeException(e);
+        } finally {
+            removeTempFileIfExists(tempFile);
+        }
+    }
+
+    private void removeTempFileIfExists(final File tempFile) {
+        if (tempFile != null && tempFile.exists()) {
+            tempFile.delete();
+        }
+    }
+
+    public void delete(String key) {
+        amazonS3.deleteObject(new DeleteObjectRequest(bucket, key));
+    }
+
+}
diff --git a/backend/src/main/java/com/mapbefine/mapbefine/s3/domain/UploadFile.java b/backend/src/main/java/com/mapbefine/mapbefine/s3/domain/UploadFile.java
@@ -0,0 +1,81 @@
+package com.mapbefine.mapbefine.s3.domain;
+
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import org.springframework.core.io.Resource;
+import org.springframework.web.multipart.MultipartFile;
+
+public class UploadFile implements MultipartFile {
+
+    private final String fileName;
+    private final byte[] bytes;
+
+    private UploadFile(
+            String fileName,
+            byte[] bytes
+    ) {
+        this.fileName = fileName;
+        this.bytes = bytes;
+    }
+
+    public static UploadFile of(
+            MultipartFile multipartFile
+    ) throws IOException {
+        ImageName imageName = ImageName.from(multipartFile.getOriginalFilename());
+        byte[] multipartFileBytes = multipartFile.getBytes();
+
+        return new UploadFile(imageName.getFileName(), multipartFileBytes);
+    }
+
+    @Override
+    public String getName() {
+        return fileName;
+    }
+
+    @Override
+    public String getOriginalFilename() {
+        return fileName;
+    }
+
+    @Override
+    public String getContentType() {
+        return null;
+    }
+
+    @Override
+    public boolean isEmpty() {
+        return false;
+    }
+
+    @Override
+    public long getSize() {
+        return 0;
+    }
+
+    @Override
+    public byte[] getBytes() throws IOException {
+        return bytes;
+    }
+
+    @Override
+    public InputStream getInputStream() throws IOException {
+        return new ByteArrayInputStream(bytes);
+    }
+
+    @Override
+    public Resource getResource() {
+        return MultipartFile.super
+                .getResource();
+    }
+
+    @Override
+    public void transferTo(File dest) throws IOException, IllegalStateException {
+        try (FileOutputStream fileOutputStream = new FileOutputStream(dest)) {
+            fileOutputStream.write(bytes);
+        }
+    }
+
+}
diff --git a/backend/src/main/java/com/mapbefine/mapbefine/topic/application/TopicCommandService.java b/backend/src/main/java/com/mapbefine/mapbefine/topic/application/TopicCommandService.java
@@ -14,6 +14,7 @@
 import com.mapbefine.mapbefine.pin.domain.PinRepository;
 import com.mapbefine.mapbefine.pin.exception.PinException.PinBadRequestException;
 import com.mapbefine.mapbefine.pin.exception.PinException.PinForbiddenException;
+import com.mapbefine.mapbefine.s3.application.S3Service;
 import com.mapbefine.mapbefine.topic.domain.Topic;
 import com.mapbefine.mapbefine.topic.domain.TopicRepository;
 import com.mapbefine.mapbefine.topic.dto.request.TopicCreateRequest;
@@ -35,15 +36,18 @@ public class TopicCommandService {
     private final TopicRepository topicRepository;
     private final PinRepository pinRepository;
     private final MemberRepository memberRepository;
+    private final S3Service s3Service;
 
     public TopicCommandService(
             TopicRepository topicRepository,
             PinRepository pinRepository,
-            MemberRepository memberRepository
+            MemberRepository memberRepository,
+            S3Service s3Service
     ) {
         this.topicRepository = topicRepository;
         this.pinRepository = pinRepository;
         this.memberRepository = memberRepository;
+        this.s3Service = s3Service;
     }
 
     public Long saveTopic(AuthMember member, TopicCreateRequest request) {
@@ -61,11 +65,12 @@ public Long saveTopic(AuthMember member, TopicCreateRequest request) {
 
     private Topic convertToTopic(AuthMember member, TopicCreateRequest request) {
         Member creator = findCreatorByAuthMember(member);
+        String image = s3Service.upload(request.image());
 
         return Topic.createTopicAssociatedWithCreator(
                 request.name(),
                 request.description(),
-                request.image(),
+                image,
                 request.publicity(),
                 request.permissionType(),
                 creator