상품 설계 및 등록하기

상품 엔티티

@Entity
@Getter@Setter
public class Item {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "item_id")
    private Long id;
    private String itemName;
    private int price;
    private String itemDetail;
    private String type;
    @Enumerated(EnumType.STRING)
    private ItemSellStatus itemSellStatus;
}

ItemSellStatus

• 품절/판매 상태를 나타내는 Enum Class

상품 이미지

application.properties 설정

# 파일 한 개당 최대 사이즈
spring.servlet.multipart.max-file-size=20MB

# 요청당 최대 파일 크기
spring.servlet.multipart.max-request-size=100MB

# 상품 이미지 업로드 경로
itemImgLocation=/Users/yun/Desktop/YUN/Spring/YunCase/src/main/resources/static/images/items
uploadPath=/Users/yun/Desktop/YUN/Spring/YunCase/src/main/resources/static/images

@Entity
@Getter
@Setter
public class ItemImage {
    @Id
    @Column(name = "item_img_id")
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Long id;
    private String imageName;
    private String originalImageName;
    private String imageUrl;
    private String repImgYn;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "item_id")
    private Item item;
}

Item과 다대일 단방향 관계로 매핑

---

ItemForm

• 상품 이미지 부분은 등록과 수정으로 나눔
• 상품 이미지 첨부를 선택했을 때 수행되는 스크립트

  function bindDomEvent(){
      $(".custom-file-input").on("change", function() {
        var fileName = $(this).val().split("\\").pop();  //이미지 파일명
        var fileExt = fileName.substring(fileName.lastIndexOf(".")+1); // 확장자 추출
        fileExt = fileExt.toLowerCase(); //소문자 변환

        if(fileExt != "jpg" && fileExt != "jpeg" && fileExt != "gif" && fileExt != "png" && fileExt != "bmp"){
          alert("이미지 파일만 등록이 가능합니다.");
          return;
        }

        $(this).siblings(".custom-file-label").html(fileName);
      });
    }

• 상품 상태를 "판매중" 또는 "품절" 선택 가능
• <div class="form-group"> <select th:field="*{itemSellStatus}" class="custom-select"> <option value="SELL">판매중</option> <option value="SOLD_OUT">품절</option> </select> </div>

application.properties 설정

파일 크기 및 경로 지정

WebMvcConfigure 설정

public class MvcConfiguration implements WebMvcConfigurer {

    @Value("${uploadPath}")
    String uploadPath;


    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/templates/", "classpath:/static/");

        registry.addResourceHandler("/images/**")
                .addResourceLocations(uploadPath);

    }
}

• /images/** 패턴의 URL은 uploadPath를 기준으로 탐색함을 설정

FileService - 상품 이미지 파일

• 파일을 처리하는 클래스
• 파일을 업로드하는 메서드(uploadFile) 과 삭제하는 메서드(deleteFile)
• 파일은 DB에 저장되는 것이 아니라서 Repository 불필요 (FileOutputStream이 대신 함)
• UUID : 서로 다른 개체들을 구별하기 위해서 이름을 부여할 때 사용

@Service
@Log
public class FileService {

    public String uploadFile(String uploadPath, String originalFileName, byte[] fileData) throws IOException {
        UUID uuid = UUID.randomUUID();
        String extension = originalFileName.substring(originalFileName.lastIndexOf("."));
        String savedFileName = uuid.toString() + extension;
        String fileUploadFullUrl = uploadPath + "/" + savedFileName;
        FileOutputStream fos = new FileOutputStream(fileUploadFullUrl);

        fos.write(fileData);
        fos.close();

        return savedFileName;
    }

    public void deleteFile(String filePath) {
        File deleteFile = new File(filePath);

        if (deleteFile.exists()) {
            deleteFile.delete();
            log.info("파일을 삭제했습니다.");
        } else {
            log.info("파일이 존재하지 않습니다.");
        }
    }
}

상품 등록 Controller

 @PostMapping(value = "/admin/item/new")
    public String itemPost(@Valid ItemFormDto itemFormDto, BindingResult bindingResult, Model model, @RequestParam("itemImageFile") List<MultipartFile> itemImageFileList) {
        if (bindingResult.hasErrors()) {
            return "items/itemForm";
        }

        if (itemImageFileList.get(0).isEmpty() && itemFormDto.getId() == null) {
            model.addAttribute("errorMessage", "첫번째 상품 이미지는 필수 입력 값 입니다.");
            return "items/itemForm";
        }

        try {
            itemService.saveItem(itemFormDto, itemImageFileList);
        } catch (Exception e) {
            model.addAttribute("errorMessage", "상품 등록 중 에러가 발생했습니다.");
            return "items/itemForm";
        }
        return "redirect:/";
    }

• 이미지 파일(itemImageFile) 을 MultipartFile 객체로 받음
• 입력값이 비정상이거나, 첫 번째 상품 이미지를 지정하지 않았으면 다시 상품 등록 페이지로 돌아감
• 입력값이 정상이면, itemService.saveItem(itemFormDto, itemImageFileList) 수행

상품 등록 Test

@SpringBootTest
@Transactional
@TestPropertySource(locations = "classpath:application-test.properties")
class ItemServiceTest {

    @Autowired
    ItemService itemService;
    @Autowired
    ItemRepository itemRepository;
    @Autowired
    ItemImageRepository itemImageRepository;

    List<MultipartFile> createMultipartFiles() {
        List<MultipartFile> multipartFileList = new ArrayList<>();

        for (int i = 0; i < 5; i++) {
            String path = "/Users/yun/Desktop/YUN/Spring/Shop/src/main/resources/static/";
            String imageName = "image" + i + ".jpg";
            MockMultipartFile multipartFile = new MockMultipartFile(path, imageName,
                    "image/jpg", new byte[]{1, 2, 3, 4});
            multipartFileList.add(multipartFile);
        }
        return multipartFileList;
    }


    @Test
    @WithMockUser(username = "admin", roles = "ADMIN")
    void saveItem() throws IOException {
        ItemFormDto itemFormDto = new ItemFormDto();
        itemFormDto.setItemName("test");
        itemFormDto.setPrice(1000);
        itemFormDto.setItemDetail("test");
        itemFormDto.setItemSellStatus(ItemSellStatus.SELL);
        itemFormDto.setType("IPHONE");

        List<MultipartFile> multipartFileList = createMultipartFiles();
        Long itemId = itemService.saveItem(itemFormDto, multipartFileList);

        List<ItemImage> itemImages =
                itemImageRepository.findByIdOrderByIdAsc(itemId);
        Item item = itemRepository.findById(itemId)
                .orElseThrow(EntityNotFoundException::new);

        assertEquals(itemFormDto.getItemName(), item.getItemName());
    }
}

실행 후, 저장 경로에 파일 생김

결과

상품 등록 동작 과정

1. ADMIN 권한을 가진 아이디로 상품 등록 페이지 GET 요청
2. ItemController에서 상품 등록 페이지를 반환하면서 ItemFormDto 객체도 전달
3. 상품 등록 페이지에서 상품 정보 및 이미지를 입력하고 저장 POST 요청
4. ItemController에서 입력값을 검증하고, ItemService.saveItem() 수행
   🙋‍♀️ 파라미터는 입력 받은 ItemFormDto 객체와 이미지 정보를 담은 itemImageFileList를 넘김
5. ItemService에서 ItemFormDto객체를 Item 엔티티로 변환하고, ItemRepository.save() 수행
6. ItemService에서 ItemImage 객체를 생성하고 ItemImageService.saveItemImage() 수행
   🙋‍♀️ 파라미터는 ItemImage 객체와 이미지 정보를 담고있는 ItemImageFileList.get(i) 객체
7. ItemImageService에서 상품 이미지가 존재한다면 FileService.uploadFile() 수행
   🙋‍♀️ 파라미터는 저장위치, 원래 파일명, 이미지 Byte 파일
8. FileService에서 UUID 객체를 이용해 파일명을 새로 만들고 FileOutputStream을 이용해 저장
9. ItemImageService에서 ItemImageRepository.save() 수행