Feat/#464 이미지 s3 도입

backend/build.gradle

@@ -75,6 +75,11 @@ dependencies {
 	// flyway 추가
 	implementation 'org.flywaydb:flyway-mysql'
 	implementation 'org.flywaydb:flyway-core'
+
+	//s3
+	implementation platform('software.amazon.awssdk:bom:2.20.56')
+	implementation 'software.amazon.awssdk:s3:'
+
 }
 
 tasks.named('test') {

backend/src/main/java/edonymyeon/backend/comment/application/CommentService.java

@@ -8,10 +8,10 @@
 import edonymyeon.backend.comment.repository.CommentRepository;
 import edonymyeon.backend.global.exception.EdonymyeonException;
 import edonymyeon.backend.global.exception.ExceptionInformation;
-import edonymyeon.backend.image.ImageFileUploader;
+import edonymyeon.backend.image.application.ImageService;
+import edonymyeon.backend.image.application.ImageType;
 import edonymyeon.backend.image.commentimage.domain.CommentImageInfo;
 import edonymyeon.backend.image.commentimage.repository.CommentImageInfoRepository;
-import edonymyeon.backend.image.domain.Domain;
 import edonymyeon.backend.member.application.dto.MemberId;
 import edonymyeon.backend.member.domain.Member;
 import edonymyeon.backend.member.repository.MemberRepository;
@@ -38,12 +38,10 @@ public class CommentService {
 
     private final CommentImageInfoRepository commentImageInfoRepository;
 
-    private final ImageFileUploader imageFileUploader;
+    private final ImageService imageService;
 
     private final ApplicationEventPublisher publisher;
 
-    private final Domain domain;
-
     @Transactional
     public long createComment(final MemberId memberId, final Long postId, final CommentRequest commentRequest) {
         final Post post = postRepository.findById(postId)
@@ -68,7 +66,7 @@ private CommentImageInfo extractCommentImageInfo(final MultipartFile image) {
         if (image == null || image.isEmpty()) {
             return null;
         }
-        final CommentImageInfo commentImageInfo = CommentImageInfo.from(imageFileUploader.uploadFile(image));
+        final CommentImageInfo commentImageInfo = CommentImageInfo.from(imageService.save(image, ImageType.COMMENT));
         commentImageInfoRepository.save(commentImageInfo);
         return commentImageInfo;
     }
@@ -102,6 +100,6 @@ private String convertToImageUrl(final CommentImageInfo commentImageInfo) {
             return null;
         }
         final String imageFileName = commentImageInfo.getStoreName();
-        return domain.convertToImageUrl(imageFileName);
+        return imageService.convertToImageUrl(imageFileName, ImageType.COMMENT);
     }
 }

backend/src/main/java/edonymyeon/backend/global/config/S3Config.java

@@ -0,0 +1,20 @@
+package edonymyeon.backend.global.config;
+
+import static software.amazon.awssdk.regions.Region.AP_NORTHEAST_2;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import software.amazon.awssdk.auth.credentials.InstanceProfileCredentialsProvider;
+import software.amazon.awssdk.services.s3.S3Client;
+
+@Configuration
+public class S3Config {
+
+    @Bean
+    public S3Client s3Client() {
+        return S3Client.builder()
+                .credentialsProvider(InstanceProfileCredentialsProvider.builder().build())
+                .region(AP_NORTHEAST_2)
+                .build();
+    }
+}

backend/src/main/java/edonymyeon/backend/global/exception/ExceptionInformation.java

@@ -13,6 +13,7 @@ public enum ExceptionInformation {
     REQUEST_FILE_SIZE_TOO_LARGE(2, "첨부 파일의 용량이 제한을 초과하였습니다."),
     CACHE_NOT_FOUND(100, "캐싱된 값이 없습니다."),
     INVALID_SETTING_MANAGER_ASSIGNED(201, "잘못된 설정 매니저가 매핑되었습니다"),
+    UNSUPPORTED_METHOD_CALL(202, "현재 지원하지 않는 기능입니다"),
 
     // 클래스이름_필드명_틀린내용
     // 1___: 인증 관련
@@ -59,6 +60,10 @@ public enum ExceptionInformation {
     IMAGE_EXTENSION_INVALID(5000, "등록할 수 없는 이미지 확장자입니다."),
     IMAGE_DOMAIN_INVALID(5001, "이미지의 url 경로가 잘못되었습니다."),
     IMAGE_STORE_NAME_INVALID(5002, "유효하지 않은 이미지 이름이 포함되어 있습니다."),
+    IMAGE_GET_BYTE_FAILED(5003, "이미지 파일을 byte로 변환할 수 없습니다."),
+    IMAGE_ORIGINAL_DIRECTORY_INVALID(5004, "기존 이미지 파일 디렉터리를 읽을 수 없습니다."),
+    IMAGE_CONTENT_TYPE_FAIL(5005, "기존 이미지의 content type을 알 수 없습니"),
+    IMAGE_DELETION_FAIL(5006, "이미지 삭제를 실패하였습니다"),
 
     // 6___: 소비, 절약 관련
     CONSUMPTION_POST_ID_ALREADY_EXIST(6000, "이미 소비, 절약 여부가 확정된 게시글입니다."),

backend/src/main/java/edonymyeon/backend/image/application/ImageClient.java

@@ -0,0 +1,12 @@
+package edonymyeon.backend.image.application;
+
+import org.springframework.web.multipart.MultipartFile;
+
+public interface ImageClient {
+
+    void upload(final MultipartFile image, final String directory, final String storeName);
+
+    boolean supportsDeletion();
+
+    void delete(final String imagePath);
+}

backend/src/main/java/edonymyeon/backend/image/application/ImageMigrationClient.java

@@ -0,0 +1,8 @@
+package edonymyeon.backend.image.application;
+
+import java.io.File;
+
+public interface ImageMigrationClient {
+
+    void migrate(final File image, final String directory, final String storeName);
+}

backend/src/main/java/edonymyeon/backend/image/application/ImageMigrationService.java

@@ -0,0 +1,77 @@
+package edonymyeon.backend.image.application;
+
+import static edonymyeon.backend.global.exception.ExceptionInformation.IMAGE_ORIGINAL_DIRECTORY_INVALID;
+import static java.util.Objects.isNull;
+
+import edonymyeon.backend.global.exception.BusinessLogicException;
+import edonymyeon.backend.image.commentimage.domain.CommentImageInfo;
+import edonymyeon.backend.image.commentimage.repository.CommentImageInfoRepository;
+import edonymyeon.backend.image.postimage.domain.PostImageInfo;
+import edonymyeon.backend.image.postimage.repository.PostImageInfoRepository;
+import java.io.File;
+import java.io.FilenameFilter;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.jetbrains.annotations.NotNull;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+
+@RequiredArgsConstructor
+@Service
+public class ImageMigrationService {
+
+    private final PostImageInfoRepository postImageInfoRepository;
+
+    private final CommentImageInfoRepository commentImageInfoRepository;
+
+    private final ImageMigrationClient imageMigrationClient;
+
+    @Value("${image.root-dir}")
+    private String newDir;
+
+    @Value("${file.dir}")
+    private String originalDir;
+
+    public void migrate() {
+        File[] files = new File(originalDir).listFiles(getFilter());
+        if (isNull(files)) {
+            throw new BusinessLogicException(IMAGE_ORIGINAL_DIRECTORY_INVALID);
+        }
+
+        final List<PostImageInfo> postImages = postImageInfoRepository.findAllImages();
+        final List<CommentImageInfo> commentImages = commentImageInfoRepository.findAllImages();
+        //todo: 프로필 이미지 꺼내오기
+
+        for (File file : files) {
+            final String name = file.getName();
+            // 게시글 이미지인지 판단
+            if (isPostImage(postImages, name)) {
+                imageMigrationClient.migrate(file, newDir + ImageType.POST.getSaveDirectory(), name);
+            }
+            // 댓글 이미지인지 판단
+            if (isCommentImage(commentImages, name)) {
+                imageMigrationClient.migrate(file, newDir + ImageType.COMMENT.getSaveDirectory(), name);
+            }
+            // todo: 프로필 이미지라면 -> cloudfront의 profile 폴더로 이동
+            // todo: 어디에도 해당되지 않는 경우(db에 정보가 없는!) -> 삭제
+        }
+    }
+
+    @NotNull
+    private FilenameFilter getFilter() {
+        return new FilenameFilter() {
+            @Override
+            public boolean accept(final File dir, final String name) {
+                return !name.equals("edonymyeon-firebase.json");
+            }
+        };
+    }
+
+    private boolean isPostImage(final List<PostImageInfo> postImages, final String name) {
+        return postImages.stream().anyMatch(each -> each.getStoreName().equals(name));
+    }
+
+    private boolean isCommentImage(final List<CommentImageInfo> commentImages, final String name) {
+        return commentImages.stream().anyMatch(each -> each.getStoreName().equals(name));
+    }
+}

backend/src/main/java/edonymyeon/backend/image/application/ImageService.java

@@ -0,0 +1,96 @@
+package edonymyeon.backend.image.application;
+
+import static edonymyeon.backend.global.exception.ExceptionInformation.IMAGE_EXTENSION_INVALID;
+
+import edonymyeon.backend.global.exception.EdonymyeonException;
+import edonymyeon.backend.image.ImageExtension;
+import edonymyeon.backend.image.ImageFileNameStrategy;
+import edonymyeon.backend.image.domain.Domain;
+import edonymyeon.backend.image.domain.ImageInfo;
+import java.util.List;
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+import org.springframework.web.multipart.MultipartFile;
+
+@Service
+@RequiredArgsConstructor
+public class ImageService {
+
+    private final ImageClient imageClient;
+
+    private final ImageFileNameStrategy imageFileNameStrategy;
+
+    private final Domain domain;
+
+    @Value("${image.root-dir}")
+    private String rootDirectory; //todo: 어디다 두는게 좋을까?
+
+    public ImageInfo save(final MultipartFile image, final ImageType imageType) {
+        final String originalFileName = image.getOriginalFilename();
+        validateExtension(originalFileName);
+        final String storeName = imageFileNameStrategy.createName(originalFileName);
+        final ImageInfo imageInfo = new ImageInfo(storeName); //todo: imageType에 따라 imageInfo 변환
+        imageClient.upload(
+                image,
+                rootDirectory + imageType.getSaveDirectory(),
+                storeName
+        );
+        return imageInfo; //todo: 생성된 imageInfo 저장 및 반환
+    }
+
+    public List<ImageInfo> saveAll(final List<MultipartFile> images, final ImageType imageType) {
+        return images.stream()
+                .map(each -> save(each, imageType))
+                .toList();
+    }
+
+    private void validateExtension(final String originalFileName) {
+        final String ext = ImageExtension.extractExt(originalFileName);
+        if (ImageExtension.contains(ext)) {
+            return;
+        }
+        throw new EdonymyeonException(IMAGE_EXTENSION_INVALID);
+    }
+
+    /**
+     * @param storeName 이미지의 이름
+     * @param imageType 이미지 사용처
+     * @return 리소스가 저장된 실제 경로
+     */
+    private String findResourcePath(final String storeName, final ImageType imageType) {
+        return rootDirectory + imageType.getSaveDirectory() + storeName;
+    }
+
+    /**
+     * @param fileName 예를 들면 post/name.png 처럼 이미지 타입까지 같이 들어온다
+     * @return 리소스가 저장된 실제 경로
+     */
+    public String findResourcePath(final String fileName) {
+        return rootDirectory + fileName;
+    }
+
+    /**
+     * @param imageType 이미지 사용처
+     * @return 사용자에게 보여줄 이미지 도메인 주소(단 이미지 파일 이름은 제외, 예를 들어 https://localhost:8080/images/post/)
+     */
+    public String findBaseUrl(final ImageType imageType) {
+        return domain.getDomain() + imageType.getSaveDirectory();
+    }
+
+    public void removeImage(final ImageInfo imageInfo, final ImageType imageType) {
+        if(!imageClient.supportsDeletion()){
+            return;
+        }
+        //todo: 이미지 삭제?
+        imageClient.delete(findResourcePath(imageInfo.getStoreName(), imageType));
+    }
+
+    public String convertToImageUrl(final String fileName, final ImageType imageType) {
+        return domain.convertToImageUrl(imageType.getSaveDirectory() + fileName);
+    }
+
+    public List<String> removeDomainFromUrl(final List<String> originalImageUrls, final ImageType imageType) {
+        return domain.removeDomainFromUrl(originalImageUrls, imageType.getSaveDirectory());
+    }
+}

backend/src/main/java/edonymyeon/backend/image/application/ImageType.java

@@ -0,0 +1,18 @@
+package edonymyeon.backend.image.application;
+
+public enum ImageType {
+
+    POST("post/"),
+    COMMENT("comment/"),
+    PROFILE("profile/");
+
+    private final String saveDirectory;
+
+    ImageType(final String saveDirectory) {
+        this.saveDirectory = saveDirectory;
+    }
+
+    public String getSaveDirectory() {
+        return saveDirectory;
+    }
+}