멋사 Backend Plus 40일차 🦁

오늘은 S3 버킷에 등록하기 위한 파일 업로드 로직에 대한 제네릭 적용을 하였고 프론트 엔드 조금, 테스트 코드 작성을 하였다

오전

문제 발견

AWS S3 버킷에 이미지를 등록하는 비즈니스 로직이 있었다.

	@Transactional
    public void uploadImage(Product requestType, MultipartFile file) throws IOException {
        String imageLocation = bucketUrl;
        String imageName = file.getOriginalFilename();
        String requestTypeSimpleName = "product" + "/";

        String imagePath = imageLocation + requestTypeSimpleName + imageName;

        String fileName = requestTypeSimpleName + file.getOriginalFilename();

        Image productImage = Product.
        		createProductImage(fileName, imagePath);

        imageRepository.save(productImage);
        createS3Bucket(fileName, file);
    }

이러한 로직은 오직 Product (상품) 객체에 대해서만 파일을 업로드 할수 있는 기능이였습니다.

하지만 프로젝트를 진행하면서, 파일 업로드를 공통적으로 사용해야할 부분이 게시글을 작성할때, 상품을 등록할때 였습니다.

➡ 이러한 문제점을 해결하기위해 Generic (제네릭) 타입을 사용할 필요성을 느끼게 되었습니다.

오후

@Service
@RequiredArgsConstructor
public class ImageServiceImpl implements ImageService {
    private final AmazonS3Client amazonS3Client;
    private final ImageRepository imageRepository;

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

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

    @Transactional
    public <T> Optional<Image> uploadImage(T requestType, MultipartFile file) throws IOException {
        String imageLocation = bucketUrl;
        String imageName = file.getOriginalFilename();
        String requestTypeSimpleName = requestType.getClass().getSimpleName() + "/";

        String imagePath = imageLocation + requestTypeSimpleName + imageName;

        String fileName = requestTypeSimpleName + file.getOriginalFilename();

        Optional<Image> image = Optional.empty();

        if (requestType instanceof Product) {
            Image productImage = Product.createProductImage(fileName, imagePath);
            image = Optional.of(productImage);
        }

        if (requestType instanceof Post) {
            Image postImage = Post.createProductImage(fileName, imagePath);
            image = Optional.of(postImage);
        }

        if (image.isPresent()) {
            imageRepository.save(image.get());
            createS3Bucket(fileName, file);
        }

        return image;
    }

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

코드를 하나 하나 뜯어 보겠습니다.

	private final AmazonS3Client amazonS3Client;
    private final ImageRepository imageRepository;

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

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

AmazonS3Client : AWS S3에 접근하기 위해 제공되는 객체
Value : yml 설정 파일에 작성한 AWS S3 버킷에 대한 정보

<T> Optional<Image> uploadImage(T requestType, MultipartFile file)

해당 파일 업로드에서 핵심적인 로직이라고 할 수 있다.

T : 다양한 타입을 매개변수로 받을 수 있다는 의미입니다,
즉 Product 객체와, Post 객체를 둘 다 받을수 있어, 코드에 재사용성을 높일 수 있습니다.

마무리

controller 에서 Post 요청으로 API 테스트 하게 되면 실제로 S3에 패키지가 만들어지고 패키지 안에 파일이 저장되게 됩니다.