스프링과 파일 업로드

 

스프링은 MultipartFile 인터페이스로 멀티파트 파일을 지원해준다.

 

1. Controller 작성

package hello.upload.controller;

import jakarta.servlet.http.HttpServletRequest;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.IOException;

@Slf4j
@Controller
@RequestMapping("/spring")
public class SpringUploadController {
    @Value("${file.dir}")
    private String fileDir;

    @GetMapping("/upload")
    public String newFile(){
        return "upload-form";
    }

    @PostMapping("/upload")
    public String saveFile(@RequestParam String itemName,
                           @RequestParam MultipartFile file, HttpServletRequest request) throws IOException {

        log.info("request={}",request);
        log.info("itemName={}",itemName);
        log.info("file={}",file);

        if(!file.isEmpty()){
            String fullPath = fileDir +file.getOriginalFilename();
            log.info("파일 저장 fullPath={}",fullPath);
            file.transferTo(new File(fullPath));
        }

        return "upload-form";

    }

}

업로드하는 HTML Form 의 name에 맞추어    @RequestParam MultipartFile file 적용

 

MultipartFile 메서드

file.getOriginalFilename();

1) 업로드 파일명

file.transferTo(...);

2) 파일 저장

 

2. Item 상품 도메인 작성

package hello.upload.domain;
import lombok.Data;
import java.util.List;
@Data
public class Item {
 private Long id;
 private String itemName;
 private UploadFile attachFile;
 private List<UploadFile> imageFiles;
}

3.ItemRepository 상품 리포지토리 작성

 

 

package hello.upload.domain;
import org.springframework.stereotype.Repository;
import java.util.HashMap;
import java.util.Map;
@Repository
public class ItemRepository {
 private final Map<Long, Item> store = new HashMap<>();
 private long sequence = 0L;
 public Item save(Item item) {
 item.setId(++sequence);
 store.put(item.getId(), item);
 return item;
 }
 public Item findById(Long id) {
 return store.get(id);
 }
}
UploadFile - 업로드 파일 정보 보관
package hello.upload.domain;
import lombok.Data;
@Data
public class UploadFile {
 private String uploadFileName;  // 고객이 업로드한 파일명
 private String storeFileName; // 서버 내부에서 관리하는 파일명
 public UploadFile(String uploadFileName, String storeFileName) {
 this.uploadFileName = uploadFileName;
 this.storeFileName = storeFileName;
 }
}

 

 * 파일명이 충돌이 날 수 있으므로 서버에는 저장할 파일명이 겹치지 않도록 별도로 파일명이 필요

 

package hello.upload.file;
import hello.upload.domain.UploadFile;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
@Component
public class FileStore {
 @Value("${file.dir}")
 private String fileDir;
 public String getFullPath(String filename) {
 return fileDir + filename;
 }
 public List<UploadFile> storeFiles(List<MultipartFile> multipartFiles)
throws IOException {
 List<UploadFile> storeFileResult = new ArrayList<>();
 for (MultipartFile multipartFile : multipartFiles) {
 if (!multipartFile.isEmpty()) {
 storeFileResult.add(storeFile(multipartFile));
 }
 }
 return storeFileResult;
 }
 public UploadFile storeFile(MultipartFile multipartFile) throws IOException 
{
 if (multipartFile.isEmpty()) {
 return null;
 }
 String originalFilename = multipartFile.getOriginalFilename();
 String storeFileName = createStoreFileName(originalFilename);
 multipartFile.transferTo(new File(getFullPath(storeFileName)));
 return new UploadFile(originalFilename, storeFileName);
 }
 private String createStoreFileName(String originalFilename) {
 String ext = extractExt(originalFilename);
 String uuid = UUID.randomUUID().toString();
 return uuid + "." + ext;  // 파일명을 추출해 내부 서버에서 관리하는 파일명에 붙여준다.
 }

 private String extractExt(String originalFilename) {  
 int pos = originalFilename.lastIndexOf(".");
 return originalFilename.substring(pos + 1);
 }
}

 

4. ItemController 작성 

package hello.upload.controller;
import hello.upload.domain.UploadFile;
import hello.upload.domain.Item;
import hello.upload.domain.ItemRepository;
import hello.upload.file.FileStore;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.io.*;
import org.springframework.http.HttpHeaders;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.support.RedirectAttributes;
import org.springframework.web.util.UriUtils;
import java.io.IOException;
import java.net.MalformedURLException;
import java.nio.charset.StandardCharsets;
import java.util.List;
@Slf4j
@Controller
@RequiredArgsConstructor
public class ItemController {
 private final ItemRepository itemRepository;
 private final FileStore fileStore;
 @GetMapping("/items/new")
 public String newItem(@ModelAttribute ItemForm form) {
 return "item-form";
 }
 @PostMapping("/items/new")
 public String saveItem(@ModelAttribute ItemForm form, RedirectAttributes 
redirectAttributes) throws IOException {
 UploadFile attachFile = fileStore.storeFile(form.getAttachFile());
 List<UploadFile> storeImageFiles =
fileStore.storeFiles(form.getImageFiles());
 //데이터베이스에 저장
 Item item = new Item();
 item.setItemName(form.getItemName());
 item.setAttachFile(attachFile);
 item.setImageFiles(storeImageFiles);
 itemRepository.save(item);
 redirectAttributes.addAttribute("itemId", item.getId());
 return "redirect:/items/{itemId}";
 }
 @GetMapping("/items/{id}")
 public String items(@PathVariable Long id, Model model) {
 Item item = itemRepository.findById(id);
 model.addAttribute("item", item);
 return "item-view";
 }
 @ResponseBody
 @GetMapping("/images/{filename}") // <img> 태그로 이미지를 조회. urlresouce로 이미지 파일을 읽어 @ResponseBody로 이미지 바이너리 반환
 public Resource downloadImage(@PathVariable String filename) throws
MalformedURLException {
 return new UrlResource("file:" + fileStore.getFullPath(filename));
 }
 @GetMapping("/attach/{itemId}") // 파일 다운로드 할 때 실행
 public ResponseEntity<Resource> downloadAttach(@PathVariable Long itemId)
throws MalformedURLException {
 Item item = itemRepository.findById(itemId);
 String storeFileName = item.getAttachFile().getStoreFileName();
 String uploadFileName = item.getAttachFile().getUploadFileName();
 UrlResource resource = new UrlResource("file:" +
fileStore.getFullPath(storeFileName));
 log.info("uploadFileName={}", uploadFileName);
 String encodedUploadFileName = UriUtils.encode(uploadFileName,
StandardCharsets.UTF_8);
 String contentDisposition = "attachment; filename=\"" +
encodedUploadFileName + "\"";  // 파일 다운로드 시 고객이 업로드한 파일 이름으로 다운로드하게 함.
 return ResponseEntity.ok()
 .header(HttpHeaders.CONTENT_DISPOSITION, contentDisposition)
 .body(resource);
 }
}