Merge pull request #29 from Project-Catcher/feat-cw-apply-upload-s3

Feat: S3에 파일을 업로드 할 수 있도록 서비스 구현

Author: cheolwon1994

build.gradle

@@ -55,6 +55,8 @@ dependencies {
 	//swagger
 	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
 
+	//s3
+	implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
 }
 
 dependencyManagement {

src/main/java/com/catcher/common/exception/BaseResponseStatus.java

@@ -22,13 +22,18 @@ public enum BaseResponseStatus {
     // Common
     RESPONSE_ERROR(false, 3000, "값을 불러오는데 실패하였습니다."),
 
-
     /**
      * 4000 : Database, Server 오류
      */
     DATABASE_ERROR(false, 4000, "데이터베이스 연결에 실패하였습니다."),
     REDIS_ERROR(false, 4002, "redis 연결에 실패하였습니다."),
 
+    /**
+     * 5000: AWS Error
+     */
+    S3UPLOAD_ERROR(false, 5000, "파일 업로드를 실패하였습니다."),
+    KMS_ERROR(false, 5001, "암호화 및 복호화 과정에서 실패하였습니다."),
+    AWS_IO_ERROR(false, 5002, "파일의 정보를 가져오는 데 실패했습니다.")
     ;
 
     private final boolean isSuccess;

src/main/java/com/catcher/core/domain/entity/BaseTimeEntity.java

@@ -4,12 +4,15 @@
 import lombok.Getter;
 import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
+import java.time.ZoneId;
 import java.time.ZonedDateTime;
 
 @EntityListeners(AuditingEntityListener.class)
 @MappedSuperclass
 @Getter
 public class BaseTimeEntity {
+    protected static ZoneId ZONE = ZoneId.of("Asia/Seoul");
+
     @Column(name = "created_at")
     private ZonedDateTime createdAt;
 
@@ -18,12 +21,12 @@ public class BaseTimeEntity {
 
     @PrePersist
     private void prePersist() {
-        this.createdAt = ZonedDateTime.now();
-        this.updatedAt = ZonedDateTime.now();
+        this.createdAt = ZonedDateTime.now(ZONE);
+        this.updatedAt = ZonedDateTime.now(ZONE);
     }
 
     @PreUpdate
     private void preUpdate() {
-        this.updatedAt = ZonedDateTime.now();
+        this.updatedAt = ZonedDateTime.now(ZONE);
     }
 }

src/main/java/com/catcher/core/domain/entity/CatcherItem.java

@@ -11,7 +11,6 @@
 @Getter
 @AllArgsConstructor(access = AccessLevel.PROTECTED)
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
-@Where(clause = "deleted_at IS NULL")
 @Table(name = "catcher_item")
 public class CatcherItem extends BaseTimeEntity {
     @Id

src/main/java/com/catcher/infrastructure/external/service/S3UploadService.java

@@ -0,0 +1,47 @@
+package com.catcher.infrastructure.external.service;
+
+import com.amazonaws.services.kms.model.AWSKMSException;
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.model.AmazonS3Exception;
+import com.amazonaws.services.s3.model.ObjectMetadata;
+import com.catcher.common.exception.BaseException;
+import com.catcher.common.exception.BaseResponseStatus;
+import com.catcher.infrastructure.utils.KmsUtils;
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.IOException;
+import java.util.UUID;
+
+@Service
+@RequiredArgsConstructor
+public class S3UploadService {
+    @Value("${cloud.aws.s3.bucket}")
+    private String bucket;
+
+    private final AmazonS3 amazonS3;
+    private final KmsUtils kmsUtils;
+
+    public String uploadFile(MultipartFile multipartFile) {
+        String fileName = UUID.randomUUID().toString();
+
+        try {
+            ObjectMetadata metadata = new ObjectMetadata();
+            metadata.setContentLength(multipartFile.getSize());
+            metadata.setContentType(multipartFile.getContentType());
+
+            String decryptedBucketName = kmsUtils.decrypt(bucket);
+            amazonS3.putObject(decryptedBucketName, fileName, multipartFile.getInputStream(), metadata);
+
+            return amazonS3.getUrl(decryptedBucketName, fileName).toString();
+        } catch (AWSKMSException awskmsException) {
+            throw new BaseException(BaseResponseStatus.KMS_ERROR);
+        } catch (AmazonS3Exception s3Exception) {
+            throw new BaseException(BaseResponseStatus.S3UPLOAD_ERROR);
+        } catch (IOException exception) {
+            throw new BaseException(BaseResponseStatus.AWS_IO_ERROR);
+        }
+    }
+}

src/main/java/com/catcher/infrastructure/utils/KmsUtils.java

@@ -1,7 +1,6 @@
 package com.catcher.infrastructure.utils;
 
 import com.amazonaws.auth.DefaultAWSCredentialsProviderChain;
-import com.amazonaws.auth.profile.ProfileCredentialsProvider;
 import com.amazonaws.regions.Regions;
 import com.amazonaws.services.kms.AWSKMS;
 import com.amazonaws.services.kms.AWSKMSClientBuilder;

src/main/java/com/catcher/infrastructure/utils/S3Config.java

@@ -0,0 +1,21 @@
+package com.catcher.infrastructure.utils;
+
+import com.amazonaws.auth.DefaultAWSCredentialsProviderChain;
+import com.amazonaws.regions.Regions;
+import com.amazonaws.services.s3.AmazonS3Client;
+import com.amazonaws.services.s3.AmazonS3ClientBuilder;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class S3Config {
+
+    @Bean
+    public AmazonS3Client amazonS3Client(){
+        return (AmazonS3Client) AmazonS3ClientBuilder
+                .standard()
+                .withRegion(Regions.AP_NORTHEAST_2)
+                .withCredentials(DefaultAWSCredentialsProviderChain.getInstance())
+                .build();
+    }
+}

src/main/java/com/catcher/resource/S3UploadController.java

@@ -0,0 +1,29 @@
+package com.catcher.resource;
+
+import com.catcher.common.response.CommonResponse;
+import com.catcher.infrastructure.external.service.S3UploadService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.IOException;
+
+@RestController
+@RequestMapping("/s3")
+@RequiredArgsConstructor
+public class S3UploadController {
+
+    private final S3UploadService uploadService;
+
+    @PostMapping(path = "/upload", consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
+    public CommonResponse<String> uploadFile(
+            @RequestParam(value = "file") MultipartFile file
+    ) throws IOException {
+        String savedUrl = uploadService.uploadFile(file);
+        return CommonResponse.success(200, savedUrl);
+    }
+}

src/main/resources/application-dev.properties

@@ -15,6 +15,9 @@ ssh.local-port=3306
 aws.kms.keyId=5d1c783d-6c8e-4661-a8ed-a12654aac8c3
 aws.kms.encryptionAlgorithm=SYMMETRIC_DEFAULT
 
+## s3
+cloud.aws.s3.bucket=AQICAHgxTvGwZVD/2MLMvR9/01Wy8IeL4nGHGGgc5XMYIhkQ2gHtX2l7w2o1cOCwj5+vyriHAAAAeDB2BgkqhkiG9w0BBwagaTBnAgEAMGIGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMgWN+1U9oZFD2pVW/AgEQgDUV7p6hnfU/Az/ZHSSJxg9O+Q7icBrADk1gdGuK6Mt+KlrHht5FdqHgXGPq8Av2fp71nENCmw==
+
 ## kakao
 kakao.api.key=AQICAHgxTvGwZVD/2MLMvR9/01Wy8IeL4nGHGGgc5XMYIhkQ2gHpQ9T3X8ABXTrlZfQaHCb6AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMzWswzD3/z9HQ1WWUAgEQgDtXvQXbxx434/7/6a/E7HS98MokawKTqdBkWY1eVid+ylY1AP38xkENY/RL6ER08Q4he8b6kZBL3iqq2w==
 

src/main/resources/application-local.properties

@@ -15,6 +15,9 @@ ssh.local-port=3306
 aws.kms.keyId=5d1c783d-6c8e-4661-a8ed-a12654aac8c3
 aws.kms.encryptionAlgorithm=SYMMETRIC_DEFAULT
 
+## s3
+cloud.aws.s3.bucket=AQICAHgxTvGwZVD/2MLMvR9/01Wy8IeL4nGHGGgc5XMYIhkQ2gHtX2l7w2o1cOCwj5+vyriHAAAAeDB2BgkqhkiG9w0BBwagaTBnAgEAMGIGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMgWN+1U9oZFD2pVW/AgEQgDUV7p6hnfU/Az/ZHSSJxg9O+Q7icBrADk1gdGuK6Mt+KlrHht5FdqHgXGPq8Av2fp71nENCmw==
+
 ## kakao
 kakao.api.key=AQICAHgxTvGwZVD/2MLMvR9/01Wy8IeL4nGHGGgc5XMYIhkQ2gHpQ9T3X8ABXTrlZfQaHCb6AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMzWswzD3/z9HQ1WWUAgEQgDtXvQXbxx434/7/6a/E7HS98MokawKTqdBkWY1eVid+ylY1AP38xkENY/RL6ER08Q4he8b6kZBL3iqq2w==