🪣 S3 – 생성부터 Spring에서 활용까지

🤔 AWS S3 Outline

S3란?

Simple Storage Service의 약자로, 주로 파일 서버로 사용한다.

S3를 사용하는 이유

1. 확장성(Scalability)

파일 서버는 트래픽 증가에 따라 서버 인프라 및 용량 계획을 변경해야 한다. 하지만 S3는 확장 및 성능 부분을 대신 처리해주기 때문에 더 편리하게 사용할 수 있다.

2. 내구성(Durability)

S3는 여러 영역에서 여러 데이터 복사본을 저장하기 때문에 한 영역이 다운되더라도 데이터 사용 및 복구가 가능하다.

S3 terminology

• 객체(object)
  • 파일과 파일 정보로 구성된 저장 단위
  • 일반적으로 우리가 저장하는 파일이라고 생각하면 된다.
• 버킷(bucket)
  • 다수의 객체를 관리하는 컨테이너
  • 파일 시스템이라고 생각하면 된다.

🛠️ S3 bucket 생성 방법

bucket 생성

1. AWS console > S3 > 버킷 > 버킷 만들기
   
2. bucket 이름 입력 후 엑세스 차단 설정을 해제한다.
   
   

IAM 사용자 생성

S3에 접근하기 위해서는 IAM 사용자에게 S3 접근 권한을 주고, 엑세스 키를 만들어 엑세스 키와 비밀 키를 통해 접근해야 한다. 이미 IAM 사용자로 로그인해 있는 경우에는 생성하는 과정을 생략 후 바로 설정하면 된다.

1. AWS console > IAM > 액세스 관리 > 사용자 > 사용자 추가
   
2. 사용자 이름을 입력한다.
   
3. 직접 정책 연결을 선택하고, AmazonS3FullAccess를 선택한다.
   
4. 사용자 생성을 선택하면 사용자가 생성된 것을 확인할 수 있다.
   

액세스 키 생성

외부 서버에서 접속할 수 있도록 IAM 사용자의 엑세스 키를 생성해야 한다. 이때 엑세스 키와 비밀 키는 외부에 공개되어서는 안된다.

1. AWS console > IAM > 액세스 관리자 > 사용자 > 생성한 사용자 이름 선택 > 보안 자격 증명 > 액세스 키 만들기
   
2. 아무거나 선택하고 다음을 선택한다. (액세스 키 사용 사례와 대안을 하단에 띄워주는 기능만 하기 때문에 무엇을 골라도 무관하다.)
   
3. 태그를 입력하고 액세스 키 만들기를 선택한다.
   
4. 액세스 키 생성 완료 화면에서 생성된 공개키와 비밀키를 확인할 수 있다.

생성 완료 화면이 아니면 비밀키를 볼 수 없기 때문에 반드시 .csv 파일로 받아놓을 것을 권장한다.

🧭 의존성 설정

Gradle

dependencies {
	...
	implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
	...
}

application.yml

cloud:
	aws:
		s3:
			bucket: <S3 bucket name>
		stack:
			auto: false
		region:
			static: ap-northeast-2
			auto: false
		credentials:
			accessKey: <발급받은 accessKey>
			secretKey: <발급받은 secretKey>

S3Config.java

@Configuration
public class S3Config {

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

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

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

    @Bean
    public AmazonS3Client amazonS3Client() {
        BasicAWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey);

        return (AmazonS3Client) AmazonS3ClientBuilder
                .standard()
                .withRegion(region)
                .withCredentials(new AWSStaticCredentialsProvider(credentials))
                .build();
    }
}

🚀 How to use

File upload

@Service
@RequiredArgsConstructor
public class S3UploadService {

    private final AmazonS3 amazonS3;

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

    public String saveFile(MultipartFile multipartFile) throws IOException {
        String originalFilename = multipartFile.getOriginalFilename();

        ObjectMetadata metadata = new ObjectMetadata();
        metadata.setContentLength(multipartFile.getSize());
        metadata.setContentType(multipartFile.getContentType());

        amazonS3.putObject(bucket, originalFilename, multipartFile.getInputStream(), metadata);
        return amazonS3.getUrl(bucket, originalFilename).toString();
    }
}

File download

public ResponseEntity<UrlResource> downloadImage(String originalFilename) {
    UrlResource urlResource = new UrlResource(amazonS3.getUrl(bucket, originalFilename));

    String contentDisposition = "attachment; filename=\"" +  originalFilename + "\"";

    // header에 CONTENT_DISPOSITION 설정을 통해 클릭 시 다운로드 진행
    return ResponseEntity.ok()
            .header(HttpHeaders.CONTENT_DISPOSITION, contentDisposition)
            .body(urlResource);

}

File deletion

public void deleteImage(String originalFilename)  {
    amazonS3.deleteObject(bucket, originalFilename);
}

---

Reference : [Spring Boot] AWS S3를 이용한 파일 업로드, AWS S3 공식 문서