[Spring] Spring Boot AWS S3 사진 업로드 하는 법

Spring Boot S3 파일 업로드 하는 법

이번 글에서는 Spring으로 AWS S3에 파일 업로드 하는 글을 정리해보겠습니다.(기존에 썼던 글은 잘못되거나 부족한 점이 많아서 이번 기회에 다시 써서 정리해보려 합니다.)

 

AWS S3 Bucket 생성하기

 

먼저 S3 버킷을 생성합니다. 버킷 이름만 설정한 후에 나머지 설정은 Default 설정 그대로 두고 생성하겠습니다.

 

 

IAM 사용자 S3 접근 권한 추가

먼저 IAM 사용자를 생성하겠습니다.

 

 

그리고 위와 같이 IAM 사용자 생성 후에 S3FullAccess 권한을 추가하겠습니다.

 

 

Spring Boot 파일 업로드

implementation "com.amazonaws:aws-java-sdk-s3:${awsJavaSdkVersion}"
ex) implementation "com.amazonaws:aws-java-sdk-s3:1.12.281

Spring Boot는 gradle 기반으로 이고 build.gradle에 위의 의존성을 추가하겠습니다.

 

 

application.yml 작성

cloud:
  aws:
    credentials:
      accessKey: ${AWS_ACCESS_KEY_ID}       # AWS IAM AccessKey 적기
      secretKey: ${AWS_SECRET_ACCESS_KEY}   # AWS IAM SecretKey 적기
    s3:
      bucket: 버킷 이름    # ex) marryting-gyunny
      dir: S3 디렉토리 이름 # ex) /gyunny
    region:
      static: ap-northeast-2
    stack:
      auto: false

application.yml에 위와 같이 작성을 하겠습니다.

 

 

AWS S3 Config

@Configuration
public class AwsConfig {

    @Value("${cloud.aws.credentials.accessKey}")
    private String accessKey;

    @Value("${cloud.aws.credentials.secretKey}")
    private String secretKey;

    @Value("${cloud.aws.region.static}")
    private String region;

    @Bean
    public AmazonS3 amazonS3() {
        AWSCredentials awsCredentials = new BasicAWSCredentials(accessKey, secretKey);
        return AmazonS3ClientBuilder.standard()
                .withRegion(region)
                .withCredentials(new AWSStaticCredentialsProvider(awsCredentials))
                .build();
    }
}

yml에 등록한 accessKey, secretKey, region을 Bean으로 등록해줍니다.

 

 

파일 업로드 코드

@RequiredArgsConstructor
@Service
public class S3Upload {

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

    private final AmazonS3 amazonS3;

    public String upload(MultipartFile multipartFile) throws IOException {
        String s3FileName = UUID.randomUUID() + "-" + multipartFile.getOriginalFilename();

        ObjectMetadata objMeta = new ObjectMetadata();
        objMeta.setContentLength(multipartFile.getInputStream().available());

        amazonS3.putObject(bucket, s3FileName, multipartFile.getInputStream(), objMeta);

        return amazonS3.getUrl(bucket, s3FileName).toString();
    }
}

Spring Boot로 AWS S3로 파일 업로드 하는 코드는 위의 코드가 전부입니다. 한 줄씩 코드의 의미를 간단하게 살펴보겠습니다.

 

String s3FileName = UUID.randomUUID() + "-" + multipartFile.getOriginalFilename();

S3에 저장되는 파일의 이름이 중복되지 않기 위해서 UUID로 생성한 랜덤 값과 파일 이름을 연결하여 S3에 업로드 하겠습니다.

 

ObjectMetadata objMeta = new ObjectMetadata();
objMeta.setContentLength(multipartFile.getInputStream().available());

그리고 Spring Server에서 S3로 파일을 업로드해야 하는데, 이 때 파일의 사이즈를 ContentLength로 S3에 알려주기 위해서 ObjectMetadata를 사용합니다.

 

s3Client.putObject(bucket, s3FileName, inputStream, objMeta);

그리고 이제 S3 API 메소드인 putObject를 이용하여 파일 Stream을 열어서 S3에 파일을 업로드 합니다.

 

amazonS3.putObject(bucket, s3FileName, multipartFile.getInputStream(), objMeta);

그리고 getUrl 메소드를 통해서 S3에 업로드된 사진 URL을 가져오는 방식입니다.

 

 

Controller Multipart 사용하기

@RequiredArgsConstructor
@RestController
public class FileUploadController {

    private final S3Upload s3Upload;

    @PostMapping("/upload")
    public ApiResponse<String> uploadFile(@RequestParam("images") MultipartFile multipartFile) throws IOException {
        return ApiResponse.success(
                HttpStatus.CREATED, s3Upload.upload(multipartFile.getInputStream(), multipartFile.getOriginalFilename(), fileSize)
        );
    }
}

Controller에서는 Multipart 타입을 사용해서 클라이언트로부터 파일을 받아오면 됩니다.

 

 

Postman으로 File Upload 하기

그리고 위와 같이 Body -> form-data -> File 변경 후 -> 파일 업로드를 통해서 서버로 요청을 보내면 위와 같이 정상적으로 응답을 받는 것을 확인할 수 있습니다.

 

 

S3에도 파일이 정상적으로 업로드된 것을 확인할 수 있습니다.

 

 

 

마무리 하기

여기까지 Spring Boot로 AWS S3로 파일 업로드 하는 법에 대해서 알아보았습니다. 궁금한 점이나 부족한 점이 있다면 답글로 첨언 부탁드리겠습니다.