[POM-94] 가게 이미지 업로드 기능 추가

src/main/java/com/ray/pominowner/global/config/ImagePathProvider.java

@@ -0,0 +1,20 @@
+package com.ray.pominowner.global.config;
+
+import lombok.Getter;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
+
+@Getter
+@Component
+public class ImagePathProvider {
+
+    private final String storeImageRootPath;
+    private final String storeLogoImageSubPath;
+
+    public ImagePathProvider(@Value("${file.store.image.path}") String storeImageRootPath,
+                             @Value("${file.store.logo.path}") String storeLogoImageSubPath) {
+        this.storeImageRootPath = storeImageRootPath;
+        this.storeLogoImageSubPath = storeLogoImageSubPath;
+    }
+
+}

src/main/java/com/ray/pominowner/store/controller/StoreController.java

@@ -2,12 +2,13 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.ray.pominowner.store.controller.dto.CategoryRequest;
-import com.ray.pominowner.store.controller.dto.StoreInformationRequest;
 import com.ray.pominowner.store.controller.dto.PhoneNumberRequest;
+import com.ray.pominowner.store.controller.dto.StoreInformationRequest;
 import com.ray.pominowner.store.controller.dto.StoreRegisterRequest;
 import com.ray.pominowner.store.service.StoreService;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.PatchMapping;
@@ -16,8 +17,10 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
 
 import java.net.URI;
+import java.util.List;
 
 @RestController
 @RequestMapping("/api/v1/stores")
@@ -57,4 +60,9 @@ public void deleteInformation(@PathVariable Long storeId) {
         storeService.deleteInformation(storeId);
     }
 
+    @PostMapping(value = "/{storeId}/store-images", consumes = {MediaType.MULTIPART_FORM_DATA_VALUE})
+    public void saveStoreImage(@RequestBody List<MultipartFile> images, @PathVariable Long storeId) {
+        storeService.saveStoreImages(images, storeId);
+    }
+
 }

src/main/java/com/ray/pominowner/store/domain/Store.java

@@ -6,12 +6,20 @@
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.Id;
+import jakarta.persistence.OneToMany;
 import lombok.AccessLevel;
 import lombok.Builder;
+import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import org.springframework.util.Assert;
 
+import java.util.ArrayList;
+import java.util.List;
+
+import static jakarta.persistence.CascadeType.ALL;
+
 @Entity
+@EqualsAndHashCode(of = "id")
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 public class Store extends BaseTimeEntity {
 
@@ -29,14 +37,18 @@ public class Store extends BaseTimeEntity {
     @Embedded
     private PhoneNumber tel = new PhoneNumber();
 
+    @OneToMany(mappedBy = "store", cascade = ALL, orphanRemoval = true)
+    private List<StoreImage> images = new ArrayList<>();
+
     private Long ownerId;   // 추후 연관관계 설정 예정
 
     @Builder
-    private Store(Long id, RequiredStoreInfo requiredStoreInfo, Information info, PhoneNumber tel, Long ownerId) {
+    private Store(Long id, RequiredStoreInfo requiredStoreInfo, Information info, PhoneNumber tel, List<StoreImage> images, Long ownerId) {
         this.id = id;
         this.requiredStoreInfo = requiredStoreInfo;
         this.info = info;
         this.tel = tel;
+        this.images = images;
         this.ownerId = ownerId;
     }
 
@@ -60,6 +72,7 @@ public Store retrieveStoreAfterRegisteringPhoneNumber(String phoneNumber) {
                 .requiredStoreInfo(this.requiredStoreInfo)
                 .info(this.info)
                 .tel(new PhoneNumber(phoneNumber))
+                .images(this.images)
                 .ownerId(this.ownerId)
                 .build();
     }
@@ -70,6 +83,7 @@ public Store retrieveStoreAfterDeletingPhoneNumber() {
                 .requiredStoreInfo(this.requiredStoreInfo)
                 .info(this.info)
                 .tel(new PhoneNumber())
+                .images(this.images)
                 .ownerId(this.ownerId)
                 .build();
     }
@@ -80,6 +94,7 @@ public Store retrieveStoreAfterRegisteringInfo(String information) {
                 .requiredStoreInfo(this.requiredStoreInfo)
                 .info(new Information(information))
                 .tel(this.tel)
+                .images(this.images)
                 .ownerId(this.ownerId)
                 .build();
     }
@@ -90,6 +105,7 @@ public Store retrieveStoreAfterDeletingInfo() {
                 .requiredStoreInfo(this.requiredStoreInfo)
                 .info(new Information())
                 .tel(this.tel)
+                .images(this.images)
                 .ownerId(this.ownerId)
                 .build();
     }
@@ -105,4 +121,9 @@ public PhoneNumber getPhoneNumber() {
     public Information getInformation() {
         return info;
     }
+
+    public List<StoreImage> getImages() {
+        return images;
+    }
+
 }

src/main/java/com/ray/pominowner/store/domain/StoreImage.java

@@ -5,17 +5,51 @@
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.Id;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
+import lombok.Builder;
+import lombok.NoArgsConstructor;
+import org.springframework.util.Assert;
+
+import static jakarta.persistence.FetchType.LAZY;
+import static lombok.AccessLevel.PROTECTED;
 
 @Entity
+@NoArgsConstructor(access = PROTECTED)
 public class StoreImage extends BaseTimeEntity {
 
     @Id
     @Column(name = "STORE_IAMGE_ID")
     @GeneratedValue
     private Long id;
 
-    private String image;
+    private String path;
+
+    private String uploadName;
+
+    private String fileName;
+
+    @ManyToOne(fetch = LAZY)
+    @JoinColumn(name = "STORE_ID")
+    private Store store;
+
+    @Builder
+    private StoreImage(String path, String uploadName, String fileName, Store store) {
+        validateImage(path, uploadName, fileName);
+        this.path = path;
+        this.uploadName = uploadName;
+        this.fileName = fileName;
+        this.store = store;
+    }
+
+    private void validateImage(String path, String uploadName, String fileName) {
+        Assert.hasText(path, "경로는 빈 값일 수 없습니다.");
+        Assert.hasText(uploadName, "파일 이름은 빈 값일 수 없습니다.");
+        Assert.hasText(fileName, "파일 이름은 빈 값일 수 없습니다.");
+    }
 
-    private Long storeId;
+    public Store getStore() {
+        return store;
+    }
 
 }

src/main/java/com/ray/pominowner/store/repository/StoreImageRepository.java

@@ -0,0 +1,8 @@
+package com.ray.pominowner.store.repository;
+
+import com.ray.pominowner.store.domain.StoreImage;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface StoreImageRepository extends JpaRepository<StoreImage, Long> {
+
+}

src/main/java/com/ray/pominowner/store/service/StoreImageService.java

@@ -0,0 +1,76 @@
+package com.ray.pominowner.store.service;
+
+import com.ray.pominowner.global.config.ImagePathProvider;
+import com.ray.pominowner.store.domain.Store;
+import com.ray.pominowner.store.domain.StoreImage;
+import com.ray.pominowner.store.repository.StoreImageRepository;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+import org.springframework.util.Assert;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+import java.util.UUID;
+
+@Component
+@RequiredArgsConstructor
+public class StoreImageService {
+
+    private static final String DOT = ".";
+
+    private final ImagePathProvider imagePathProvider;
+
+    private final StoreImageRepository storeImageRepository;
+
+    public void saveImages(List<MultipartFile> images, Store store) {
+        Assert.noNullElements(images, "올바르지 못한 파일입니다.");
+        String rootPath = imagePathProvider.getStoreImageRootPath();
+        images.forEach(image -> saveEachFile(store, image, rootPath));
+    }
+
+    private void saveEachFile(Store store, MultipartFile image, String rootPath) {
+        String originalFilename = image.getOriginalFilename();
+        validateFileName(originalFilename);
+
+        String createdFileName = createFileName(originalFilename);
+        saveImageToPath(image, rootPath + createdFileName);
+
+        storeImageRepository.save(StoreImage.builder()
+                .path(rootPath + createdFileName)
+                .uploadName(originalFilename)
+                .fileName(createdFileName)
+                .store(store)
+                .build());
+    }
+
+    private void validateFileName(String originalFilename) {
+        Assert.notNull(originalFilename, "올바르지 못한 파일입니다.");
+
+        if (!originalFilename.contains(DOT)) {
+            throw new IllegalArgumentException("올바르지 못한 파일입니다.");
+        }
+    }
+
+    private void saveImageToPath(MultipartFile image, String path) {
+        try {
+            image.transferTo(new File(path));
+        } catch (IOException e) {
+            throw new RuntimeException("파일 저장에 실패했습니다.",e);
+        }
+    }
+
+    private String createFileName(String originalFilename) {
+        String fileExtension = extractFileExtension(originalFilename);
+        return UUID.randomUUID()
+                .toString()
+                .concat(fileExtension);
+    }
+
+    private String extractFileExtension(String originalFilename) {
+        int dotIndex = originalFilename.lastIndexOf(DOT);
+        return originalFilename.substring(dotIndex);
+    }
+
+}

src/main/java/com/ray/pominowner/store/service/StoreService.java

@@ -7,13 +7,14 @@
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
+import org.springframework.web.multipart.MultipartFile;
 
 import java.util.List;
 
 @Slf4j
 @Service
+@Transactional
 @RequiredArgsConstructor
-@Transactional(readOnly = true)
 public class StoreService {
 
     private final StoreServiceValidator storeServiceValidator;
@@ -22,43 +23,43 @@ public class StoreService {
 
     private final StoreCategoryService storeCategoryService;
 
-    @Transactional
+    private final StoreImageService storeImageService;
+
     public Long registerStore(Store store) throws JsonProcessingException {
         storeServiceValidator.validateBusinessNumber(store.getBusinessNumber());
 
         return storeRepository.save(store).getId();
     }
 
-    @Transactional
     public void registerCategory(List<String> categories, Long storeId) {
         storeServiceValidator.validateCategory(categories);
         storeCategoryService.saveCategories(findStore(storeId), categories);
     }
 
-    @Transactional
     public void registerPhoneNumber(String phoneNumber, Long storeId) {
         Store store = findStore(storeId).retrieveStoreAfterRegisteringPhoneNumber(phoneNumber);
         storeRepository.save(store);
     }
 
-    @Transactional
     public void deletePhoneNumber(Long storeId) {
         Store store = findStore(storeId).retrieveStoreAfterDeletingPhoneNumber();
         storeRepository.save(store);
     }
 
-    @Transactional
     public void registerInformation(String information, Long storeId) {
         Store store = findStore(storeId).retrieveStoreAfterRegisteringInfo(information);
         storeRepository.save(store);
     }
 
-    @Transactional
     public void deleteInformation(Long storeId) {
         Store store = findStore(storeId).retrieveStoreAfterDeletingInfo();
         storeRepository.save(store);
     }
 
+    public void saveStoreImages(List<MultipartFile> images, Long storeId) {
+        storeImageService.saveImages(images, findStore(storeId));
+    }
+
     private Store findStore(Long storeId) {
         return storeRepository.findById(storeId)
                 .orElseThrow(() -> new IllegalArgumentException("존재하지 않는 가게입니다."));

src/main/resources/dev/application-dev.yml

@@ -20,3 +20,16 @@ spring:
         highlight_sql: true
     defer-datasource-initialization: true
     open-in-view: false
+
+  servlet:
+    multipart:
+      max-file-size: 10MB
+      max-request-size: 10MB
+
+file:
+  store:
+    image:
+      path: src/main/resources/store-image/
+    logo:
+      path: src/main/resources/store-logo-image/
+

src/test/java/com/ray/pominowner/store/controller/StoreControllerTest.java

@@ -13,10 +13,13 @@
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.http.MediaType;
+import org.springframework.mock.web.MockMultipartFile;
 import org.springframework.security.test.context.support.WithMockUser;
 import org.springframework.test.web.servlet.MockMvc;
 
+import java.nio.charset.StandardCharsets;
 import java.util.List;
+import java.util.UUID;
 
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.BDDMockito.given;
@@ -130,4 +133,21 @@ void successRemoveInformation() throws Exception {
                 .andExpect(status().isOk());
     }
 
+    @Test
+    @WithMockUser
+    @DisplayName("가게 이미지 저장에 성공한다")
+    void successSaveImages() throws Exception {
+        // given
+        MockMultipartFile firstMultipartFile = new MockMultipartFile("TEST", "test1.png", MediaType.IMAGE_PNG_VALUE, UUID.randomUUID().toString().getBytes(StandardCharsets.UTF_8));
+        MockMultipartFile secondMultipartFile = new MockMultipartFile("TEST2", "test2.png", MediaType.IMAGE_PNG_VALUE, UUID.randomUUID().toString().getBytes(StandardCharsets.UTF_8));
+
+        // when, then
+        mvc.perform(multipart("/api/v1/stores/1/store-images")
+                        .file(firstMultipartFile)
+                        .file(secondMultipartFile)
+                        .contentType(MediaType.MULTIPART_FORM_DATA)
+                        .with(csrf()))
+                .andExpect(status().isOk());
+    }
+
 }