[FightClub] S3 Bucket 적용 - 이미지 업로드

1. 개요

이번에 프로필 이미지를 저장하는 과정에서 s3 bucket을 사용하게 되었다.

기존에 이에 대한 블로그를 작성했었으나, 다시 보니까 부족한 점들이 보여서 다시 정리해서 적어보려 한다.

 

https://potatoscatteringsmile.tistory.com/192

[AWS] S3 스토리지 - 이미지 업로드

 

기존에 작성했던 블로그는 위와 같다.

뭔가.. 이해가 없이 작성한 게 ..ㅎㅎ 보여서 조금 부끄럽다.

 

위 포스트에서, 아키텍쳐 부분은 따라해도 아직은 잘 되는 것 같다. 이번 포스트에서는 코드 적용하는 부분에 방점을 두어서 확인해 보려고 한다.

아키텍쳐 구성 과정 중에서 조금 헤맸던 부분은 credentials를 추가하는 부분이었는데, 이렇게 수정해서 적용 가능하다.

 

2. 본문

코드 부분부분에 대한 설명이 요할 것 같아 주석으로 달아두려고 한다.

우선으로는, S3 config 파일을 구성해주어 S3 bucket에 대한 의존성을 추가해 주었다.

// S3 bucket에 대한 의존성 추가
@Configuration
public class AwsS3Config {

	// 지역
    @Value("${cloud.aws.region}")
    private String region;

	// 버킷 이름
    @Value("${cloud.aws.s3.bucket}")
    private String bucketName;

	// 위에서 가져온 value들을 바탕으로 amazonS3를 build 해주고 @Bean으로 등록해 준다.
    @Bean
    public AmazonS3 amazonS3() {
        return AmazonS3Client.builder()
                .withRegion(region)
                .build();
    }
}

 

다음으로 S3Service 코드를 작성해 주어, 파일 업로드 과정을 처리해 주었다.

@Slf4j
@Service
public class S3Service {

    private final AmazonS3 amazonS3;
    private final String bucketName;

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

    public String uploadFile(MultipartFile file, Long userId) throws IOException {
        // MultipartFile을 임시 파일로 변환 - 업로드 하기 전까지 저장되는 파일
        Path tempFile = Files.createTempFile("upload-", file.getOriginalFilename());
        try {
            // MultipartFile의 내용을 위에서 만든 임시 파일, tempFile에 저장한다.
            file.transferTo(tempFile.toFile());

            // 파일명을 유니크하게 설정
            String fileName = userId + "_" + System.currentTimeMillis() + "_" + file.getOriginalFilename();

            // S3에 파일 업로드
            // 버킷 이름, 파일명, 파일을 파라미터로 받고, 실제 S3에 업로드.
            amazonS3.putObject(new PutObjectRequest(bucketName, fileName, tempFile.toFile()));

            // 업로드 후 임시 파일 삭제
            Files.delete(tempFile);

			//유니크하게 만들었던 파일 이름을 저장해 두어 추후에 해당 파일을 찾을 때, 사용할 수 있도록 함.
            return fileName;
        } catch (IOException e) {
            // 업로드 실패 시 로그 출력
            log.error("Error uploading file to S3: ", e);
            throw new IOException("Failed to upload file to S3", e);  // 예외 처리
        }
    }

	// S3에 저장되어 있는 파일 이름을 가져옴. http://amazonS3 ... 이런 형식..?
    public String getFileUrl(String fileName) {
        return amazonS3.getUrl(bucketName, fileName).toString();
    }

	// MultipartFile을 일반 File 객체로 변환.
    // 이를 통해, MultipartFile의 내용을 새로운 File객체에 저장
    private File convertMultiPartToFile(MultipartFile file) throws IOException {
        File convertedFile = new File(file.getOriginalFilename());
        file.transferTo(convertedFile); //이 과정을 통해 메모리에서 파일을 디스크에 실제로 저장.
        return convertedFile;
    }

    public void deleteFile(String fileName) {
        amazonS3.deleteObject(bucketName, fileName);
    }
}

 

고유한 파일 이름으로 저장되는 것이 중요하다. 그래서 현재 시각을 기준으로 태그를 달아서, 저장을 해주었다.

 

다음으로 유저 이미지를 저장해주는 API를 작성해 주었다.

MultipartFile로 파일 이미지를 받는 것을 확인할 수 있다.

// controller
    @PostMapping("/user/image")
    public ResponseDto<Void> updateProfileImg(
            @AuthenticationPrincipal UserDetailsImpl userDetails,
            @RequestParam("file")MultipartFile file) {
            // RequestParam으로 파일을 받아와 줌.
        try {
            String imageFileName = s3Service.uploadFile(file, userDetails.getId());
			// s3Service.uploadFile을 통해 파일을 저장해줌.
            
   			// 서비스 코드 호출
            userService.updateProfileImage(userDetails.getId(), imageFileName);
            return ResponseDto.success(SuccessCode.IMAGE_UPLOADED);
        } catch (Exception e) {
            throw ServiceException.of(ErrorCode.IMAGE_UPLOAD_FAIL);
        }
    }
    
    
    //service
    
        public String uploadFile(MultipartFile file, Long userId) throws IOException {
        // MultipartFile을 임시 파일로 변환
        Path tempFile = Files.createTempFile("upload-", file.getOriginalFilename());
        try {
            // MultipartFile을 임시 파일로 저장
            file.transferTo(tempFile.toFile());

            // 파일명을 유니크하게 설정
            String fileName = userId + "_" + System.currentTimeMillis() + "_" + file.getOriginalFilename();

            // S3에 파일 업로드
            amazonS3.putObject(new PutObjectRequest(bucketName, fileName, tempFile.toFile()));

            // 업로드 후 임시 파일 삭제
            Files.delete(tempFile);

            return fileName;
        } catch (IOException e) {
            // 업로드 실패 시 로그 출력
            log.error("Error uploading file to S3: ", e);
            throw new IOException("Failed to upload file to S3", e);  // 예외 처리
        }
    }

 

파일 이미지를 가지고 올 땐 아래와 같은 코드로 가져와 주었다.

s3Service.getFileUrl(user.getProfileImg())