Feat: [Photo] 이미지 업로드 및 조회 (#64)

kjunh972 · web-flow · commit 7e4207ca4f96 · 2025-10-10T21:03:20.000+09:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -50,6 +50,7 @@ jobs:
       Firebase_ID: ${{ secrets.FIREBASE_PROJECT_ID }}
       GOOGLE_MAP_API_KEY: ${{ secrets.GOOGLE_MAP_API_KEY }}
       SPRING_DOMAIN: ${{ secrets.SPRING_DOMAIN }}
+      FILE_UPLOAD_DIR: ./uploads
 
     steps:
       - name: Checkout source code
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -42,6 +42,7 @@ jobs:
             echo "KAKAO_CLIENT_ID=${{ secrets.KAKAO_CLIENT_ID }}" >> .env
             echo "KAKAO_REDIRECT_URI=${{ secrets.KAKAO_REDIRECT_URI }}" >> .env
             echo "SPRING_DOMAIN=${{ secrets.SPRING_DOMAIN }}" >> .env
+            echo "FILE_UPLOAD_DIR=/app/uploads" >> .env
 
             mkdir -p ./src/main/resources/firebase
             echo '${{ secrets.FCM_JSON }}' > ./src/main/resources/${{ secrets.FIREBASE_SERVICE_ACCOUNT_KEY }}
diff --git a/runtracker/build.gradle b/runtracker/build.gradle
@@ -52,6 +52,10 @@ dependencies {
 	// Logstash
 	implementation 'net.logstash.logback:logstash-logback-encoder:7.4'
 
+	// Image Processing
+	implementation 'com.sksamuel.scrimage:scrimage-core:4.1.1'
+	implementation 'com.sksamuel.scrimage:scrimage-webp:4.1.1'
+
 	compileOnly 'org.projectlombok:lombok'
 	developmentOnly 'org.springframework.boot:spring-boot-devtools'
 	runtimeOnly 'com.mysql:mysql-connector-j'
diff --git a/runtracker/docker-compose.yml b/runtracker/docker-compose.yml
@@ -13,6 +13,7 @@ services:
       - .env # DB, Redis 접속 정보 등을 담을 파일
     volumes:
       - ./firebase:/app/secrets
+      - uploads:/app/uploads
     depends_on:
       mysql:
         condition: service_healthy
@@ -65,3 +66,4 @@ services:
 volumes:
   mysql-data:
   redis-data:
+  uploads:
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/controller/UploadController.java b/runtracker/src/main/java/com/runtracker/domain/upload/controller/UploadController.java
@@ -0,0 +1,46 @@
+package com.runtracker.domain.upload.controller;
+
+import com.runtracker.domain.upload.service.FileStorageService;
+import com.runtracker.global.response.ApiResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.core.io.Resource;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@RestController
+@RequestMapping("/api/upload")
+@RequiredArgsConstructor
+public class UploadController {
+
+    private final FileStorageService fileStorageService;
+
+    @PostMapping("/image")
+    public ApiResponse<Map<String, String>> uploadImage(
+            @RequestParam("file") MultipartFile file) {
+
+        String fileUrl = fileStorageService.uploadImage(file);
+
+        Map<String, String> response = new HashMap<>();
+        response.put("url", fileUrl);
+
+        return ApiResponse.ok(response);
+    }
+
+    @GetMapping("/image/{filename:.+}")
+    public ResponseEntity<Resource> getImage(@PathVariable String filename) {
+
+        Resource resource = fileStorageService.loadFileAsResource(filename);
+        String contentType = fileStorageService.determineContentType(resource);
+
+        return ResponseEntity.ok()
+                .contentType(MediaType.parseMediaType(contentType))
+                .header(HttpHeaders.CONTENT_DISPOSITION, "inline; filename=\"" + resource.getFilename() + "\"")
+                .body(resource);
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/enums/UploadErrorCode.java b/runtracker/src/main/java/com/runtracker/domain/upload/enums/UploadErrorCode.java
@@ -0,0 +1,21 @@
+package com.runtracker.domain.upload.enums;
+
+import com.runtracker.global.code.ResponseCode;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public enum UploadErrorCode implements ResponseCode {
+
+    FILE_IS_EMPTY("UP001", "File is empty"),
+    INVALID_FILE_TYPE("UP002", "Invalid file type. Only image files are allowed"),
+    INVALID_FILE_NAME("UP003", "Invalid file name"),
+    FILE_STORAGE_FAILED("UP004", "Failed to store file"),
+    FILE_NOT_FOUND("UP005", "File not found"),
+    IMAGE_CONVERSION_FAILED("UP006", "Failed to convert image to WebP format"),
+    IMAGE_RESIZE_FAILED("UP007", "Failed to resize image");
+
+    private final String statusCode;
+    private final String message;
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/exception/FileIsEmptyException.java b/runtracker/src/main/java/com/runtracker/domain/upload/exception/FileIsEmptyException.java
@@ -0,0 +1,14 @@
+package com.runtracker.domain.upload.exception;
+
+import com.runtracker.domain.upload.enums.UploadErrorCode;
+import com.runtracker.global.exception.CustomException;
+
+public class FileIsEmptyException extends CustomException {
+    public FileIsEmptyException() {
+        super(UploadErrorCode.FILE_IS_EMPTY);
+    }
+
+    public FileIsEmptyException(String message) {
+        super(UploadErrorCode.FILE_IS_EMPTY, message);
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/exception/FileNotFoundException.java b/runtracker/src/main/java/com/runtracker/domain/upload/exception/FileNotFoundException.java
@@ -0,0 +1,14 @@
+package com.runtracker.domain.upload.exception;
+
+import com.runtracker.domain.upload.enums.UploadErrorCode;
+import com.runtracker.global.exception.CustomException;
+
+public class FileNotFoundException extends CustomException {
+    public FileNotFoundException() {
+        super(UploadErrorCode.FILE_NOT_FOUND);
+    }
+
+    public FileNotFoundException(String message) {
+        super(UploadErrorCode.FILE_NOT_FOUND, message);
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/exception/FileStorageFailedException.java b/runtracker/src/main/java/com/runtracker/domain/upload/exception/FileStorageFailedException.java
@@ -0,0 +1,14 @@
+package com.runtracker.domain.upload.exception;
+
+import com.runtracker.domain.upload.enums.UploadErrorCode;
+import com.runtracker.global.exception.CustomException;
+
+public class FileStorageFailedException extends CustomException {
+    public FileStorageFailedException() {
+        super(UploadErrorCode.FILE_STORAGE_FAILED);
+    }
+
+    public FileStorageFailedException(String message) {
+        super(UploadErrorCode.FILE_STORAGE_FAILED, message);
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/exception/ImageConversionFailedException.java b/runtracker/src/main/java/com/runtracker/domain/upload/exception/ImageConversionFailedException.java
@@ -0,0 +1,14 @@
+package com.runtracker.domain.upload.exception;
+
+import com.runtracker.domain.upload.enums.UploadErrorCode;
+import com.runtracker.global.exception.CustomException;
+
+public class ImageConversionFailedException extends CustomException {
+    public ImageConversionFailedException() {
+        super(UploadErrorCode.IMAGE_CONVERSION_FAILED);
+    }
+
+    public ImageConversionFailedException(String message) {
+        super(UploadErrorCode.IMAGE_CONVERSION_FAILED, message);
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/exception/InvalidFileNameException.java b/runtracker/src/main/java/com/runtracker/domain/upload/exception/InvalidFileNameException.java
@@ -0,0 +1,14 @@
+package com.runtracker.domain.upload.exception;
+
+import com.runtracker.domain.upload.enums.UploadErrorCode;
+import com.runtracker.global.exception.CustomException;
+
+public class InvalidFileNameException extends CustomException {
+    public InvalidFileNameException() {
+        super(UploadErrorCode.INVALID_FILE_NAME);
+    }
+
+    public InvalidFileNameException(String message) {
+        super(UploadErrorCode.INVALID_FILE_NAME, message);
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/exception/InvalidFileTypeException.java b/runtracker/src/main/java/com/runtracker/domain/upload/exception/InvalidFileTypeException.java
@@ -0,0 +1,14 @@
+package com.runtracker.domain.upload.exception;
+
+import com.runtracker.domain.upload.enums.UploadErrorCode;
+import com.runtracker.global.exception.CustomException;
+
+public class InvalidFileTypeException extends CustomException {
+    public InvalidFileTypeException() {
+        super(UploadErrorCode.INVALID_FILE_TYPE);
+    }
+
+    public InvalidFileTypeException(String message) {
+        super(UploadErrorCode.INVALID_FILE_TYPE, message);
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/domain/upload/service/FileStorageService.java b/runtracker/src/main/java/com/runtracker/domain/upload/service/FileStorageService.java
@@ -0,0 +1,95 @@
+package com.runtracker.domain.upload.service;
+
+import com.runtracker.domain.upload.exception.*;
+import com.runtracker.global.util.ImageConverter;
+import com.runtracker.global.config.FileUploadConfig;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.UrlResource;
+import org.springframework.stereotype.Service;
+import org.springframework.util.StringUtils;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.MalformedURLException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.util.UUID;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class FileStorageService {
+
+    private final FileUploadConfig fileUploadConfig;
+
+    // 이미지 파일을 업로드하고 URL을 반환
+    public String uploadImage(MultipartFile file) {
+        if (file.isEmpty()) {
+            throw new FileIsEmptyException();
+        }
+
+        String contentType = file.getContentType();
+        if (contentType == null || !contentType.startsWith("image/")) {
+            throw new InvalidFileTypeException();
+        }
+
+        return storeFile(file);
+    }
+
+    // 파일을 WebP 포맷으로 변환
+    private String storeFile(MultipartFile file) {
+        String originalFilename = StringUtils.cleanPath(file.getOriginalFilename());
+
+        if (originalFilename.contains("..")) {
+            throw new InvalidFileNameException();
+        }
+
+        try {
+            String storedFilename = UUID.randomUUID() + ".webp";
+
+            Path targetLocation = Paths.get(fileUploadConfig.getUploadDir()).resolve(storedFilename);
+
+            InputStream webpInputStream = ImageConverter.convertToWebP(file);
+
+            Files.copy(webpInputStream, targetLocation, StandardCopyOption.REPLACE_EXISTING);
+
+            return fileUploadConfig.getBaseUrl() + "/api/upload/image/" + storedFilename;
+
+        } catch (IOException ex) {
+            log.error("Failed to store file: {}", originalFilename, ex);
+            throw new FileStorageFailedException(originalFilename);
+        }
+    }
+
+    public Resource loadFileAsResource(String filename) {
+        try {
+            Path filePath = Paths.get(fileUploadConfig.getUploadDir()).resolve(filename).normalize();
+            Resource resource = new UrlResource(filePath.toUri());
+
+            if (resource.exists()) {
+                return resource;
+            } else {
+                throw new FileNotFoundException(filename);
+            }
+        } catch (MalformedURLException ex) {
+            log.error("Failed to load file: {}", filename, ex);
+            throw new FileNotFoundException(filename);
+        }
+    }
+
+    // 파일의 Content-Type을 결정
+    public String determineContentType(Resource resource) {
+        try {
+            String contentType = Files.probeContentType(resource.getFile().toPath());
+            return contentType != null ? contentType : "application/octet-stream";
+        } catch (IOException ex) {
+            log.info("Could not determine file type, using default");
+            return "application/octet-stream";
+        }
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/global/config/FileUploadConfig.java b/runtracker/src/main/java/com/runtracker/global/config/FileUploadConfig.java
@@ -0,0 +1,27 @@
+package com.runtracker.global.config;
+
+import lombok.Getter;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Configuration;
+
+import jakarta.annotation.PostConstruct;
+import java.io.File;
+
+@Getter
+@Configuration
+public class FileUploadConfig {
+
+    @Value("${file.upload-dir}")
+    private String uploadDir;
+
+    @Value("${file.base-url}")
+    private String baseUrl;
+
+    @PostConstruct
+    public void init() {
+        File uploadDirectory = new File(uploadDir);
+        if (!uploadDirectory.exists() && !uploadDirectory.mkdirs()) {
+            throw new IllegalStateException("Failed to create upload directory: " + uploadDir);
+        }
+    }
+}
diff --git a/runtracker/src/main/java/com/runtracker/global/config/SecurityConfig.java b/runtracker/src/main/java/com/runtracker/global/config/SecurityConfig.java
@@ -38,7 +38,8 @@ public class SecurityConfig {
             "/static/**", "/webjars/**",
             "/login/oauth2/**", "/oauth2/**",
             "/actuator/**", "/health", "/error", "/favicon.ico",
-            "/api/members/search-name", "/api/members/test-login", "/api/members/refresh"
+            "/api/members/search-name", "/api/members/test-login", "/api/members/refresh",
+            "/api/upload/image/**"
     );
 
     @Bean
diff --git a/runtracker/src/main/java/com/runtracker/global/util/ImageConverter.java b/runtracker/src/main/java/com/runtracker/global/util/ImageConverter.java
@@ -0,0 +1,49 @@
+package com.runtracker.global.util;
+
+import com.runtracker.domain.upload.exception.ImageConversionFailedException;
+import com.sksamuel.scrimage.ImmutableImage;
+import com.sksamuel.scrimage.webp.WebpWriter;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
+
+
+@Slf4j
+public class ImageConverter {
+
+    private static final int DEFAULT_QUALITY = 80;
+    private static final int MAX_WIDTH = 1920;
+    private static final int MAX_HEIGHT = 1920;
+
+    // MultipartFile을 WebP 포맷의 InputStream으로 변환
+    public static InputStream convertToWebP(MultipartFile file) {
+        return convertToWebP(file, DEFAULT_QUALITY);
+    }
+
+    // MultipartFile을 WebP 포맷의 InputStream으로 변환
+    public static InputStream convertToWebP(MultipartFile file, int quality) {
+        try {
+            ImmutableImage image = ImmutableImage.loader().fromBytes(file.getBytes());
+
+            if (image.width > MAX_WIDTH || image.height > MAX_HEIGHT) {
+                double scale = Math.min((double) MAX_WIDTH / image.width, (double) MAX_HEIGHT / image.height);
+                int newWidth = (int) (image.width * scale);
+                int newHeight = (int) (image.height * scale);
+                image = image.scaleTo(newWidth, newHeight);
+                log.info("Image resized from {}x{} to {}x{}",
+                    image.width, image.height, newWidth, newHeight);
+            }
+
+            WebpWriter writer = WebpWriter.DEFAULT.withQ(quality);
+            byte[] webpBytes = image.bytes(writer);
+
+            return new ByteArrayInputStream(webpBytes);
+
+        } catch (Exception e) {
+            log.error("Failed to convert image to WebP: {}", file.getOriginalFilename(), e);
+            throw new ImageConversionFailedException(file.getOriginalFilename());
+        }
+    }
+}
diff --git a/runtracker/src/main/resources/application.yml b/runtracker/src/main/resources/application.yml
diff --git a/runtracker/src/test/java/com/runtracker/domain/upload/controller/UploadControllerTest.java b/runtracker/src/test/java/com/runtracker/domain/upload/controller/UploadControllerTest.java
