Spring Boot와 S3 연동

작성일 March 20, 2023

앞선 포스트에서 AWS와 스프링 부트에서 S3를 사용하기 위한 설정을 하고 정상적으로 파일이 업로드 되는지 테스트를 진행했다. (링크)

이제 본격적으로 파일 관련 부분에 대해 구현해보자.

우선, 현재 문제점은 파일이 사용자가 설정한 이름 그대로 업로드 된다는 점이다. 파일을 업로드 할때는 UUID를 사용해서 파일의 이름이 중복되지 않도록 하는 것이 좋다. 또한, 패키지 별로 파일을 분리하는 것이 향후 규모가 큰 프로젝트 진행 시 도움이 될 것이다.

package com.haedals.haedal.common;

import com.amazonaws.services.s3.AmazonS3Client;
import com.amazonaws.services.s3.model.CannedAccessControlList;
import com.amazonaws.services.s3.model.PutObjectRequest;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Optional;
import java.util.UUID;

@Component
@RequiredArgsConstructor
public class S3Uploader {

    private final AmazonS3Client amazonS3Client;

    @Value("${cloud.aws.s3.bucket}")
    private String bucket;

    public String uploadFiles(MultipartFile multipartFile, String dirName) throws IOException {
        File uploadFile = convert(multipartFile)
                .orElseThrow(() -> new IllegalArgumentException("error: MultipartFile -> File convert fail"));
        return upload(uploadFile, dirName);
    }

    public String upload(File uploadFile, String filePath) {
        String fileName = filePath + "/" + UUID.randomUUID() + uploadFile.getName();
        String uploadImageUrl = putS3(uploadFile, fileName);
        removeNewFile(uploadFile);
        return uploadImageUrl;
    }

    private String putS3(File uploadFile, String fileName) {
        amazonS3Client.putObject(new PutObjectRequest(bucket, fileName, uploadFile).withCannedAcl(CannedAccessControlList.PublicRead));
        return amazonS3Client.getUrl(bucket, fileName).toString();
    }

    private void removeNewFile(File targetFile) {
        if (targetFile.delete()) {
            return;
        }
    }

    private Optional<File> convert(MultipartFile file) throws IOException {
        File convertFile = new File(System.getProperty("user.dir") + "/" + file.getOriginalFilename());
        if (convertFile.createNewFile()) {
            try (FileOutputStream fos = new FileOutputStream(convertFile)) {
                fos.write(file.getBytes());
            }
            return Optional.of(convertFile);
        }
        return Optional.empty();
    }
}

위의 코드를 통해서 파일 이름을 랜덤하게 만들고 원하는 폴더에 생성할 수 있게 된다.

package com.haedals.haedal.file;

import com.haedals.haedal.common.S3Uploader;
import lombok.RequiredArgsConstructor;
import org.springframework.http.ResponseEntity;
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("/upload")
@RequiredArgsConstructor
public class FileController {

    private final S3Uploader s3Uploader;

    @PostMapping
    public ResponseEntity<String> uploadFile(@RequestParam("file") MultipartFile file) throws IOException {
        String filePath = s3Uploader.uploadFiles(file, "product");
        return ResponseEntity.ok(filePath);
    }
}

여기서는 product로 폴더명을 하드코딩 하였다. 향후 실제 파일을 저장하는 로직을 구현할 때는 원하는 폴더명을 작성하면 된다.

이제 작성한 코드가 잘 되는지 테스트해보겠다. 마찬가지로 Postman을 통해 테스트 진행했다. 역시나 오류가 발생했다.(오류가 발생하지 않으면 불안하다.) Access Denined 오류가 발생했는데 구글링 해보니 S3 설정 시 권한에서 모든 퍼블릭 액세스를 차단하면서 발생한 오류였다.

제일 위에 있는 권한은 체크 해제 후 다시 실행하니 파일이 잘 업로드 되는 것을 확인할 수 있었다.

승미