[AWS] S3(Simple Storage Service)서버와 Spring Boot 연동

진행중이던 프로젝트에 파일 업로드 기능이 있었습니다.

• ex) 게시글을 업로드 할 때 이미지도 함께 업로드, 회원정보를 수정할 때 프로필 이미지를 등록

파일 업로드의 경우, EC2 서버가 아닌 로컬 서버를 사용했을 때는 아래와 같이 yml에 제 개인 PC에 저장하도록 설정해주었는데, 배포를 시작하게 되면서 파일 관리를 위한 S3 서버를 사용하게 되었습니다.

upload:
  post:
    image:
      location: /Users/kdo6301/Desktop/sharing_platform_server/post/
  member:
    image:
      location: /Users/kdo6301/Desktop/sharing_platform_server/member/

 

이번 포스팅에서는 Spring Boot에서 AWS S3 서버를 이용하여 파일 관리를 하는 방법에 대해 알아보겠습니다.

---

1. S3 (Simple Storage Service) 란?

• AWS에서 지원하는 파일 관리 스토리지 서버입니다.
• 확장성과 내구성이 좋습니다.
• 가입일 기준 12개월간 무료로 사용할 수 있습니다.

2. 사전 준비

• S3 를 사용하기 위해서는 AWS에서 버킷과 IAM을 먼저 생성해주어야합니다.
• 버킷 : 다수의 객체를 관리하는 컨테이너 ( 파일을 관리할 수 있는 파일 시스템이라고 보면 됨 )
• IAM : S3에 접근하기 위한 사용자 정보

사용자(IAM) 생성

1. AWS 검색창에 iam 을 검색한 후 주요 기능 - 사용자 클릭

2. 원하는 사용자 이름 지정 - 다음 

3. 아래와 같이 권한 설정 - 다음

4. 검토 및 생성 - 사용자 생성

5. 액세스 키 설정 - 사용자 이름 클릭 

6. 요약 - 액세스 키 만들기

7. 액세스 키 사용 사례 선택 - 아무거나 선택 해도 ok

8. 원하는 태그 작성 ( 선택 ) 후 - 액세스 키 만들기

 

9. csv 파일 다운로드를 클릭합니다. ( 이 파일에는 공개키인 Access Key와 , 비밀키인 Secret Key 정보가 들어가 있기 때문에 파일 관리에 주의가 필요합니다 )

 

이제 S3에 접근하기 위한 IAM에 대한 설정이 완료되었습니다. 버킷을 생성해봅시다.

버킷 생성

1. 검색창에 s3 검색

2. 버킷 만들기 클릭

3. 일반 구성 - 버킷 이름 지정

4. Public Access 차단 해제 및 버킷 만들기 클릭

 

파일을 관리할 수 있는 하나의 버킷이 생성되었습니다. 이제 사전 준비가 모두 끝났습니다. 이제 Spring boot에 이 버킷과 연동해봅시다.

---

3. Spring Boot와 연동

1. build.gradle에 의존관계 추가

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

 

2.  IAM 생성에서 발급받은 csv 파일의 공개키와 비밀키, 그리고 버킷을 생성할 때 지정한 버킷 이름을 yml에 다음과 같이 설정해줍니다.

• 이 때 AccessKey와 SecretKey 정보는 github에 올라가게 되면 해킹으로 인한 과금 위험이 발생할 수 있으므로 yml 파일을 gitignore로 설정하여 반드시 github에 올라가지 않도록 합시다.
• cloud.aws.region.static: ap-northease2  : 지역 한국 고정

3) 스프링 설정 추가

@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 awsCredentials   = new BasicAWSCredentials(accessKey, secretKey);
        return (AmazonS3Client) AmazonS3ClientBuilder.standard()
                .withRegion(region)
                .withCredentials(new AWSStaticCredentialsProvider(awsCredentials))
                .build();
    }
}

---

4. 로컬 저장 ➡️ S3 서버의 버킷에 저장하도록  Refactoring

PostFileService

@Service
@RequiredArgsConstructor
public class PostFileService {

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


    public void upload(MultipartFile file, String filename) {
        try {
            ObjectMetadata metadata= new ObjectMetadata();
            metadata.setContentType(file.getContentType());
            metadata.setContentLength(file.getSize());
            amazonS3Client.putObject(BUCKET + "/post", filename, file.getInputStream(), metadata);
        } catch(IOException e) {
            throw new FileUploadFailureException();
        }
    }

    public void delete(String fileName){
        DeleteObjectRequest request = new DeleteObjectRequest(BUCKET + "/post", fileName);
        amazonS3Client.deleteObject(request);
    }
}

• 기존에는 upload()메소드에서 try/catch문으로 로컬에서 필드에 지정한 위치에 접근하여 파일을 저장하고, 만약 IOException으로 파일업로드에 실패하는 경우 Custom한 extended RuntimeException인 FileUploadException을 던지도록 구현했습니다.
• 기존에는 delete() 메소드도 필드에 지정한 위치에 접근하여 파일을 삭제하도록 구현했습니다.
• S3 스토리지 서버를 사용한 이후 부터는 위 코드와 같이 yml에 지정해준 BUCKET의 폴더에 접근하여 파일을 업로드하고, 지울 수 있도록 변경하였습니다.

---

5. Postman Test

업로드 테스트

1) 게시글 생성 요청 with 파일 

• 이 때 별도로 생성해둔 Post Image 데이터베이스에 파일의 originName과 uniqueName이 저장됩니다. (for 사용자가 파일을 생성하고, 삭제할 때 S3에 저장된 파일이 무엇인지 파악하기 위해서)

2) 버킷에 파일이 잘 저장된 것을 확인할 수 있습니다.

 

게시글 수정 테스트 - 이미지 파일 삭제 

1) 수정 요청

 

2) 버킷에서 삭제된 것을 확인할 수 있습니다. 

• 참고로 이미지 삭제는 내부적으로 게시글 수정 API에서 Post Image를 위한 별도의 데이터베이스를 이용하여 요청 API의 폼데이터에 deleteImageNames로 작성한 originName과 일치하는 파일의 uniqueName을 S3서버에서 삭제하도록 구현하였습니다)

 

<참고 자료>

[Spring boot] AWS S3 를 이용한 파일 업로드