[Spring] Amazon S3 생성과 Spring Boot에서 사용하기

📑 개요

진행 중인 프로젝트에서 이미지를 저장해야 한다.

이미지를 Amazon S3에 저장하기로 하였고,

Amazon S3 생성부터 Spring Boot에서 이미지를 저장하는 것까지 작성해보려 한다.

 

📑 개발 환경

SpringBoot : 3.3.5
JDK : 17
build Tools : gradle
Editor : InteliJ

 

📑 Amazon S3 설정

👉 버킷 만들기

버킷 만들 때의 자세한 설정 정보는 이 블로그에 잘 나와있으니 참고하면 좋을 것 같다.

 

(아래에 작성되어 있는 설정 외의 설정은 디폴트 값으로 놔두고 따로 변경하지 않았다.)

 

위의 검색창에 S3를 검색하여 Amazon S3로 이동해주고 왼쪽 네비게이션바에서 버킷을 클릭

 

버킷 만들기 클릭

 

버킷 이름 작성

 

객체 소유권에서 ACL 활성화됨으로 변경

 

우리 프로젝트에서는 Spring 서버 쪽 소스코드를 이용하여 이미지 업로드 및 조회가 이루어지는데,

해당 처리를 할 때 IAM 계정을 생성하여 버킷에 접근하기 때문에 ACL 활성화로 선택준다.

 

모든 퍼블릭 엑세스를 차단하면 외부에서 파일을 읽지 못하게 한다는 의미이다.

 

우리는 S3에 저장된 이미지를 우리의 프로젝트에서 읽어와 띄워주어야하기 때문에

엑세스 차단 설정을 풀어주었다.

 

기본 암호화를 활성화 하면 버킷에 저장되는 모든 새 객체를 암호화해서 저장한다.

그리고 객체를 다운로드할 때 암호를 복호화해서 제공해준다.

 

(이 부분에 대해선 좀 더 자세히 알아봐야 할 것 같아 일단 일반적인 설정 방법을 따라 비활성화 했다.)

 

그리고 버킷 만들기 클릭

 

withbee-travel 버킷이 생성된 것을 확인 할 수 있다.

 

👉 이미지 업로드 테스트

생성한 버킷에 이미지를 업로드 해보고 잘 들어가지는지 확인해보자

 

위에서 만든 버킷 이름을 눌러준다.

 

업로드 클릭

 

아무 이미지나 드래그 해와 파일을 업로드 해준다.

 

파일 업로드 된 것을 확인한 후, 업로드 클릭

 

업로드가 잘 된 것을 확인한 후,

업로드한 파일을 클릭해 파일 상세로 이동해준다.

 

객체 URL을 복사해서, 이미지가 잘 띄워지는지 확인

 

그럼 이런 식으로 접근할 수 없다는 화면이 나온다.

 

버킷 정책을 설정해주어야 한다.

 

👉 버킷 정책 설정

버킷의 권한 탭으로 이동

 

밑으로 내리다보면 나오는 버킷 정책의 편집 클릭

 

버킷 ARN 복사 후 정책 생성기 클릭

 

다음의 정보들을 입력해준다.

Select Type of Policy: S3 Bucket Policy

Principal: *

Actions: GetObject

Amazon Resource Name: {복사한 ARN}/*

 

입력 후 Add Statement 클릭

 

밑에 생긴 정책을 확인 후, Generate Policy 클릭

 

그럼 json 형식으로 된 정책이 뜬다.

해당 json 복사

 

다시 버킷 정책 편집 창으로 돌아가서

여기에 복사한 거 붙여넣은 후 변경 사항 저장 클릭

 

그리고 다시 이미지 주소로 들어가보면

이미지가 잘 로드되는 것을 확인할 수 있다!

 

👉 IAM 사용자 생성하기/편집하기

생성하기

S3에 접근하기 위해서는 IAM 사용자에게 S3접근 권한을 부여하고

해당 사용자의 엑세스 키, 시크릿 키를 사용해야 한다.

 

위의 검색에 IAM을 검색 후 엑세스 관리 → 사용자로 이동 후 사용자 생성 클릭

 

사용자 이름 작성 후 다음 클릭

 

직접 정책 연결 선택 후 AmazonS3FullAccess 선택 후 다음 클릭

 

잘 선택 되었는지 검토 후 사용자 생성 클릭

 

편집하기

사실 나는 우리FIS 아카데미에서 제공해준 AWS 계정을 사용하고 있기 때문에 이미 IAM가 있었다.

그래서 이미 있는 IAM에 AmazonS3FullAccess 권한만 추가해줬다.

 

권한을 추가할 사용자 이름을 클릭

 

권한 추가 클릭

 

직접 정책 연결 선택 후 AmazonS3FullAccess 선택 후 다음 클릭

 

검토 후 권한 추가 클릭

 

👉 IAM 엑세스 키 생성하기

방금 생성한 사용자(or 권한 추가한 사용자) 이름을 눌러 상세에 들어온 후 엑세스 키 만들기 클릭

 

이 중에서 아무거나 하나 선택하고 다음 클릭

(나는 AWS 컴퓨팅 서비스에서 실행되는 애플리케이션을 선택했다.)

 

설명 태그 값은 선택 사항이라 적어주지 않아도 된다.

(나는 withbee-travel의 s3 버킷과 연결했다는 뜻으로 태그를 적어주었다.)

 

엑세스 키 만들기 클릭

 

만들어진 엑세스 키를 .csv 파일 다운로드를 클릭해서 다운 받아준다.

 

📑 Spring에 연동하기

👉 dependency 추가

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

 

👉 properties 추가

일단, aws 관련 properties를 따로 작성해주기 위해

application.properties에 aws.properties도 읽어주라고 작성해준다.

# properties 파일 추가
spring.config.import=aws.properties

 

그리고 aws.properties에 다음과 같은 내용들을 적어준다.

# IAM 액세스 키
cloud.aws.credentials.accessKey=

# IAM 비밀 액세스 키
cloud.aws.credentials.secretKey=

# 리전 정보
cloud.aws.region.static=ap-northeast-2

# 버킷 이름
cloud.aws.s3.bucket=withbee-travel

# 이미지 URL의 도메인 정보(이미지를 delete 하기 위해 필요함)
cloud.aws.s3.bucket.domain=https://{버킷 이름}.s3.{리전 정보}.amazonaws.com/

 

👉 Config 작성

package withbeetravel.config;

import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.AWSStaticCredentialsProvider;
import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3ClientBuilder;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration // 설정 파일을 읽기 위한 annotation
public class S3Config {

    @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 s3Client() {

        AWSCredentials credentials = new BasicAWSCredentials(accessKey, secretKey);

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

 

👉 S3Uploader 작성

package withbeetravel.service.global;

import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.model.CannedAccessControlList;
import com.amazonaws.services.s3.model.ObjectMetadata;
import com.amazonaws.services.s3.model.PutObjectRequest;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

@Service
public class S3Uploader {

    private final AmazonS3 amazonS3;
    private final String bucket;

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

    public S3Uploader(AmazonS3 amazonS3, @Value("${cloud.aws.s3.bucket}") String bucket) {
        this.amazonS3 = amazonS3;
        this.bucket = bucket;
    }

    // 이미지 저장
    // file := s3에 저장할 이미지 파일
    // dirName := 이미지 파일을 저장할 s3 디렉토리
    public String upload(MultipartFile file, String dirName) throws IOException {

        // 파일의 원래 이름에서 공백을 제거
        String originalFileName = file.getOriginalFilename().replaceAll("\\s", "_");

        // 유니크한 파일명을 만들기 위해 UUID를 파일명에 추가
        String uuid = UUID.randomUUID().toString();
        String uniqueFileName = uuid + "_" + originalFileName;

        // 디렉토리 위치와 파일명 합치기
        String fileName = dirName + "/" + uniqueFileName;

        // S3에 이미지 업로드
        String contentType = file.getContentType();
        if(contentType == null) contentType = "application/octet-stream";
        String uploadImageUrl = putS3(file.getInputStream(), fileName, file.getSize(), contentType);

        // S3에 저장된 이미지의 URL 리턴
        return uploadImageUrl;
    }

    // 이미지 삭제
    // filName := 삭제할 이미지명(URL 형식)
    public void delete(String fileName) {
        if(fileName.startsWith(bucketDomain)) {
            amazonS3.deleteObject(bucket, fileName.substring(bucketDomain.length()));
        }
    }

    // 이미지 수정
    // newFile := 새로 저장할 이미지 파일
    // oldFileName := 기존에 저장되어 있던 이미지명(URL 형식)
    // dirName := 이미지 파일을 저장할 s3 디렉토리
    public String update(MultipartFile newFile, String oldFileName, String dirName) throws IOException {
        // 기존 파일 삭제
        delete(oldFileName);
        // 새 파일 업로드
        return upload(newFile, dirName);
    }

    // S3에 이미지 업로드
    private String putS3(InputStream inputStream, String fileName, long contentLength, String contentType) {
        ObjectMetadata metadata = new ObjectMetadata();
        metadata.setContentLength(contentLength);
        metadata.setContentType(contentType); // Content-Type 설정

        amazonS3.putObject(new PutObjectRequest(bucket, fileName, inputStream, metadata)
                .withCannedAcl(CannedAccessControlList.PublicRead));
        return amazonS3.getUrl(bucket, fileName).toString();
    }
}

실질적으로 S3Uploader에서 호출되는 메서드는 upload, delete, update이다.

 

👉 Service에서 S3Uploader 사용

package withbeetravel.service.payment;

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.multipart.MultipartFile;
import withbeetravel.domain.SharedPayment;
import withbeetravel.domain.Travel;
import withbeetravel.dto.response.payment.SharedPaymentRecordResponse;
import withbeetravel.exception.CustomException;
import withbeetravel.exception.error.PaymentErrorCode;
import withbeetravel.exception.error.TravelErrorCode;
import withbeetravel.exception.error.ValidationErrorCode;
import withbeetravel.repository.SharedPaymentRepository;
import withbeetravel.repository.TravelRepository;
import withbeetravel.service.global.S3Uploader;

import java.io.IOException;

@Service
@RequiredArgsConstructor
public class SharedPaymentRecordServiceImpl implements SharedPaymentRecordService {

    private final S3Uploader s3Uploader;

    private final TravelRepository travelRepository;
    private final SharedPaymentRepository sharedPaymentRepository;

    // S3에 이미지를 저장할 경로
    private static final String SHARED_PAYMENT_IMAGE_DIR = "travels/";

    @Override
    @Transactional
    public void addAndUpdatePaymentRecord(
            Long travelId,
            Long sharedPaymentId,
            MultipartFile image,
            String comment,
            boolean isMainImage) {

        // SharedPayment Entity 가져오기
        SharedPayment sharedPayment = sharedPaymentRepository.findById(sharedPaymentId)
                .orElseThrow(() -> new CustomException(PaymentErrorCode.SHARED_PAYMENT_NOT_FOUND));

        // 여행 정보 찾아오기
        Travel travel = travelRepository.findById(travelId)
                .orElseThrow(() -> new CustomException(TravelErrorCode.TRAVEL_NOT_FOUND));

        // 이미지 추가, 수정, 삭제
        if(image != null && image.getSize() != 0) {
            String newImageUrl = uploadImage(travelId, sharedPayment, image);
            sharedPayment.updatePaymentImage(newImageUrl);
            // 메인 이미지로 설정했다면, 여행 메인 사진 바꿔주기
            if(isMainImage) {
                // 여행 이미지 수정
                travel.updateMainImage(newImageUrl);
            }
        }
        // 기존 이미지를 메인 이미지로 설정한 경우
        else if(isMainImage && sharedPayment.getPaymentImage() != null) {
            // 여행 이미지 수정
            travel.updateMainImage(sharedPayment.getPaymentImage());
        }

        // comment 정보 엔티티에서 변경
        sharedPayment.updatePaymentCommnet(comment);
    }

    // 이미지 추가, 수정, 삭제
    private String uploadImage(Long travelId, SharedPayment sharedPayment, MultipartFile image) {

        // 원래 이미지
        String paymentImage = sharedPayment.getPaymentImage();

        // 새로 추가한 이미지
        String newImage = null;

        // image가 새로 들어왔다면 S3에 저장
        if(!image.isEmpty()) {

            // 이미지 저장할 S3 디렉토리 정보
            String dirName = SHARED_PAYMENT_IMAGE_DIR + travelId;

            try {
                if(paymentImage != null) { // 해당 공동결제 내역에 이미 이미지가 있다면 업데이트
                    newImage = s3Uploader.update(image, paymentImage, dirName);
                } else { // 없다면 업로드
                    newImage = s3Uploader.upload(image, dirName);
                }
            } catch (IOException e) { // 이미지 저장에 실패했을 경우
                throw new CustomException(ValidationErrorCode.IMAGE_PROCESSING_FAILED);
            }
        }

        // 새로운 이미지 정보 반환
        return newImage;
    }
}

 

 

📑 참고

https://jforj.tistory.com/260

https://velog.io/@yes_jihyeon/AWS-%EC%9D%B4%EB%AF%B8%EC%A7%80-%EC%A0%80%EC%9E%A5%EC%9D%84-%EC%9C%84%ED%95%9C-S3-%EB%B2%84%ED%82%B7-%EC%83%9D%EC%84%B1%ED%95%98%EA%B8%B0-SpringBootGradle#4-%EC%8A%A4%ED%94%84%EB%A7%81%EC%97%90-%EC%97%B0%EB%8F%99%ED%95%98%EA%B8%B0