[AWS] 첨부파일 AWS S3에 저장 & 다운로드하기

과거 프로젝트에서 로컬에 이미지랑 파일을 저장, 조회, 다운로드 하는 기능을 구현한적 있다.

이걸 이제 S3에 저장해보고 싶어 한번 리팩토링을 해보았다.

 

---

우선 멀티파트(Multipart) 파일 관련 설정을 해줘야한다.

spring:
  servlet:
    multipart:
      enabled: true # 멀티파트 업로드 지원여부 (default: true)
      max-file-size: 100MB # 한개 파일의 최대 사이즈 (default: 1MB)
      max-request-size: 100MB #

 

 

이제 S3를 사용하기 위해 라이브러리를 추가해야한다.

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

 

그리고 S3 버킷를 만들어준다.

 

 

해당 버킷은 단순 프로젝트용이므로 보안을 간단하게 해주겠다.

보안이 필요한경우 퍼블릭 액세스를 차단하면 안된다.

버킷을 생성한후 IAM으로 가서 s3 역할을 부여받을 사용자를 만들어준다.

후에 이 사용자의 accesskey를 가지고 버킷에 업로드를 할것이다.

 

IAM 사용자를 만든후 S3FullAccess 정책을 부여한다.

생성한후 오른쪽 상단의 액세스 키를 만들기를 눌러 액세스키를 만들어준다.

발급받는 access-key, secret-key를 application.yml에 넣어준다.

 

cloud:
  aws:
    s3:
      bucket: <S3 버킷 이름>
    credentials:
      access-key: <저장해놓은 액세스 키>
      secret-key: <저장해놓은 비밀 액세스 키>
    region:
      static: ap-northeast-2
      auto: false
    stack:
      auto: false

 

cloud.aws.stack.auto=false

EC2에서 Spring Cloud 프로젝트를 실행시키면 기본으로 CloudFormation 구성을 시작하기 때문에 설정한 CloudFormation이 없으면 프로젝트 실행이 되지 않는다. 해당 기능을 사용하지 않도록 false로 설정한다.

 

 

S3Config.java

AWS S3(Simple Storage Service)와의 통신을 위한 AmazonS3Client 빈(bean)을 생성해야한다.

 

@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();
    }
}

 

 

Controller

    @ApiOperation(value = "게시글 등록", notes = "게시글을 등록합니다.")
    @PostMapping("save")
    public ResponseEntity<String> create(
            @RequestPart(value = "board") BoardRequest request,
            @RequestPart(value = "image", required = false) MultipartFile image,
            @RequestPart(value = "file", required = false) MultipartFile file){
        
        try {
            //s3
            String fileName= image.getOriginalFilename();
            String fileUrl= "https://" + bucket + "/image" +fileName;
            ObjectMetadata metadata= new ObjectMetadata();
            metadata.setContentType(file.getContentType());
            metadata.setContentLength(file.getSize());
            amazonS3Client.putObject(bucket,fileName,file.getInputStream(),metadata);
            return ResponseEntity.ok(fileUrl);
        } catch (IOException e) {
            throw new AppException(ErrorCode.INTERNAL_SERVER_ERROR, "저장에 실패하였습니다.");
        }
    }

 

S3에 이미지 파일을 업로드하고, 업로드된 이미지의 URL을 반환하는 기능을 수행한다.

 

• String fileName = image.getOriginalFilename();
  • 업로드한 파일의 원본 이름을 fileName 변수에 저장
• String fileUrl = "https://" + bucket + "/image" + fileName;
  • fileUrl 변수를 생성하여 업로드할 파일의 URL을 구성한다. 여기서 bucket은 S3 버킷의 이름이며, fileName은 업로드할 파일의 이름이다. "/image"는 파일을 저장할 S3 내의 경로를 나타낸다. 실제로 S3 버킷 내에서는 이 경로를 기반으로 파일이 저장된다.
• ObjectMetadata metadata = new ObjectMetadata();
  • ObjectMetadata 객체를 생성한다. 이 객체는 S3에 업로드할 파일과 관련된 메타데이터 정보를 포함한다.
• metadata.setContentType(file.getContentType());
  • 업로드할 파일의 컨텐츠 타입을 설정한다. file.getContentType() 메소드를 사용하여 업로드한 파일의 MIME 타입을 메타데이터에 설정한다. 예를 들어, 이미지 파일이면 image/jpeg 또는 image/png와 같은 값이 된다.
• metadata.setContentLength(file.getSize());
  • 업로드할 파일의 크기를 설정한다. file.getSize() 메소드를 호출하여 파일의 크기(바이트 단위)를 가져온 후, 이를 메타데이터의 컨텐츠 길이로 설정한다.
• amazonS3Client.putObject(bucket, fileName, file.getInputStream(), metadata);
  • AmazonS3Client의 putObject 메소드를 사용하여 파일을 S3 버킷에 업로드한다. 이 메소드는 버킷 이름(bucket), 저장될 파일 이름(fileName), 업로드할 파일의 InputStream(여기서는 file.getInputStream()), 그리고 파일과 관련된 메타데이터(metadata)를 매개변수로 받는다.

 

이제 S3 에서 파일을 다운로드하는 REST API 엔드포인트를 구현해보자

    @ApiOperation(value = "첨부파일 다운로드", notes = "S3에 저장된 첨부파일을 다운로드합니다.")
    @GetMapping("/s3/download/{fileName}")
    public ResponseEntity<byte[]> download(@PathVariable String fileName) throws IOException {
        S3Object o = amazonS3Client.getObject(new GetObjectRequest(bucket, fileName));
        S3ObjectInputStream objectInputStream = o.getObjectContent();
        byte[] bytes = IOUtils.toByteArray(objectInputStream);

        String encodedFileName = URLEncoder.encode(fileName, "UTF-8").replaceAll("\\+", "%20");
        HttpHeaders httpHeaders = new HttpHeaders();
        httpHeaders.setContentType(MediaType.APPLICATION_OCTET_STREAM);
        httpHeaders.setContentLength(bytes.length);
        httpHeaders.setContentDispositionFormData("attachment", encodedFileName);

        // 파일의 바이트 배열과 설정된 HTTP 헤더를 사용하여 ResponseEntity 객체를 직접 반환합니다.
        return new ResponseEntity<>(bytes, httpHeaders, HttpStatus.OK);
    }

• S3Object o = amazonS3Client.getObject(new GetObjectRequest(bucket, fileName));
  • S3 버킷에서 bucket은 S3 버킷의 이름, fileName은 다운로드하려는 파일의 이름으로 파일을 가져온다.
• S3ObjectInputStream objectInputStream = o.getObjectContent();:
  • 가져온 S3 객체에서 입력 스트림을 얻어, 파일의 데이터를 읽는다.
• byte[] bytes = IOUtils.toByteArray(objectInputStream);
  • Apache Commons IO 라이브러리의 IOUtils.toByteArray 메서드를 사용하여 입력 스트림을  파일의 실제 데이터를 담은 바이트 배열로 변환환다.
• String encodedFileName = URLEncoder.encode(fileName, "UTF-8").replaceAll("\\+", "%20");
  • 파일 이름을 URL 인코딩하여 HTTP 헤더에서 안전하게 사용할 수 있도록 한다. 공백은 %20으로 변환한다.
• httpHeaders.setContentType(MediaType.APPLICATION_OCTET_STREAM);
  • 응답의 콘텐츠 타입을 이진 데이터(APPLICATION_OCTET_STREAM)로 설정한다.
• httpHeaders.setContentLength(bytes.length);
  • 응답 본문의 길이(파일 데이터의 크기)를 설정한다.
• httpHeaders.setContentDispositionFormData("attachment", encodedFileName);
  • 브라우저가 응답을 파일 다운로드로 처리하도록 Content-Disposition 헤더를 설정합니다. 이 때, 인코딩된 파일 이름을 사용한다.
  •  

 

포스트맨에서 form-data형식으로 파일을 업로드하고 api를 호출해보자

 

 

 

잘 저장이 되었으면 S3에 저장된 이미지 URL이 반환되고

S3에도 잘 저장이 된다.

 

 

다운로드도 해보자

 

포스트맨으로 api 를 호출하면 200이 뜨고, 실제 웹에서 url를 입력하면 다운이 받아진다.

 

 

 

 

 

끝~!!