멋사 Backend Plus 39일차 🦁

오늘은 오전 오후 동안 AWS의 S3 버킷에 이미지를 등록하는 기능을 구현을 하였고,
Spring Boot에서의 AWS S3 설정과 로직에 대한 정리를 해보려고 합니다.

AWS S3 개념 및 필요성

AWS S3는 간단히 생각하여 확장 가능한 클라우드 저장소 라고 생각 하면 될 것 같다.
(네이버 클라우드, I 클라우드 등)
팀 프로젝트를 하며, 이미지 (파일)을 서버를 통해 관리의 필요성을 느끼게 되어, AWS S3의 버킷을 활용하여 저장소로 활용 하려고 한다.

오전

1. AWS S3 만들기

AWS의 로그인 후 S3를 검색 하고, 접속 합니다.

버킷 만들기 버튼을 눌러 AWS S3의 대한 버킷 (컨테이너)를 만들어 줍니다.

버킷의 대한 이름을 지어주는 것이며, 버킷의 이름은 다른 사람들의 버킷 이름 까지 통틀어서 고유한 이름 이어야 합니다.

모든 퍼블릭 액세스를 차단하게 되면 인터넷 사용자들에게 공개되지 않으며, 특별한 경우일 때만, 체크를 해제 한다고 한다.

버킷의 버전 관리는 비활성화를 체크 합니다.

기본 설정대로 체크 하고 나서 버킷을 생성 합니다.

2. 사용자 생성

사용자를 생성 해야 하는 이유는 S3에 접근하기 위해 접근 권한을 주고, 엑세스 키 와 시크릿 엑세스를 생성하여 접근하기 위해서 입니다.

I AM 을 검색하여 접속 합니다.

사용자 생성 버튼을 눌러 진행 합니다.

사용자 이름을 작성하여 다음 버튼을 클릭 합니다.

직접 정책 연결 선택 후, S3 권한 정책을 선택하고 다음을 클릭 하게 되면,
사용자가 생성 됩니다.

3. 액세스 키 생성

외부에서 접속 하기 위한 사용자의 액세스 키를 생성 해야 합니다.

사용자 탭을 클릭 후, 생성했던 사용자를 클릭 합니다.

보안 자격 증명 탭 클릭후, 액세스 키 만들기를 클릭 합니다.

아무거나 클릭한 후 다음 버튼을 클릭 합니다.

액세스 키와 비밀 액세스 키가 생성 되는 것을 볼 수 있습니다.
(안내문구로 생성 화면에서만 키를 확인 할 수 있으며, .CSV 파일로 받아 두는 것을 권장한다. 따라하자.)

4.생성했던 S3에 권한 정책 설정

• 생성했던 S3에 권한을 설정하여 아래의 Json 형식에 맞춰 작성하고 저장하면 된다.
  

{
    "Version": "2012-10-17",
    "Id": "Policy1702863852313",
    "Statement": [
        {
            "Sid": "Stmt1702863805510",
            "Effect": "Allow",
            "Principal": "*",
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::만들었던 버킷 이름/*"
        }
    ]
}

오후

5. Spring Boot에서 S3 적용

1) build.gradle에 의존성 추가

dependencies {
	// 추가 의존성...
    implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
}

2) application.yml에 설정 추가
ap-northeast-2 : 설정 지역이 서울이라는 뜻

발급 받은 액세스 키, 비밀 액세스 키에 대해서는 깃허브에 올라가지 않게
.gitIgnore 설정 등을 통해 깃허브에 올라가지 않게 조심 해야 한다.

cloud:
  aws:
    s3:
      bucket: <버킷 이름>
      url: https://<버킷 이름>.s3.ap-northeast-2.amazonaws.com/
    stack.auto: false
    region.static: ap-northeast-2
    credentials:
      accessKey: <발급 받은 액세스 키>
      secretKey: <발급 받은 비밀 액세스 키>

3) Config 설정

yml 파일에서 설정한 값을 가져와 사용하는 설정 코드 입니다.

@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 코드

@RestController
@RequestMapping("/upload")
@RequiredArgsConstructor

public class FileUploadController {
   private final FileUploadService fileUploadService;
   
   @PostMapping
   public ResponseEntity<String> uploadFile(@ModelAttribute(
   								name = "images") MultipartFile images) {
   		fileUploadService.createFile(images);
        
        return ResponseEntity.ok("파일 업로드 성공")
      }
   }
}

service 코드

@Service
@RequiredArgsConstructor
public class ImageService {
    private final AmazonS3Client amazonS3Client;

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

    @Value("${cloud.aws.s3.url}")
    private String bucketUrl;
    
 	@Transactional
    public void uploadImage(MultipartFile file) throws IOException {
        String imageLocation = bucketUrl;
        String imageName = file.getOriginalFilename();
        String requestTypeSimpleName = "product" + "/";

        String imagePath = imageLocation + requestTypeSimpleName + imageName;

        String fileName = requestTypeSimpleName + file.getOriginalFilename();

        createS3Bucket(fileName, file);
    }

    private void createS3Bucket(String fileName, MultipartFile image) throws IOException {
        ObjectMetadata metadata = new ObjectMetadata();
        metadata.setContentType(image.getContentType());
        metadata.setContentLength(image.getSize());
        amazonS3Client.putObject(bucket, fileName, image.getInputStream(), metadata);
    }
    
}

AWS S3 버킷에 product 패키지로 잘 저장 되는 것을 확인 할 수 있습니다.

마무리

간단하게 AWS S3 버킷에 이미지를 업로드 할수 있는 방법에 대해 정리 해보았습니다.
마지막 비즈니스 로직에 대해서는 사용자에 맞게 커스텀해서 사용하면 좋을 것 같습니다. (기능 분리 등)