파일 업로드
HTML에서 폼을 전송하는 방식은 application/x-www-form-urlencoded 와 multipart/form-data 이 있다.
application/x-www-form-urlencoded 방식
가장 기본적인 폼 전송 방식으로 HTTP body에 &로 구분하여 데이터를 전송한다.
가장 간단하고 편하지만 파일은 문자가 아니라 매우 긴 바이너리 데이터이기 때문에 해당 전송 방식으로 파일을 전송하기 에는 어려움이 있다.
multipart/form-data
복잡하긴 하지만 해당 방식을 사용하면 다른 종류의 여러 파일과 폼의 내용을 함께 전송할 수 있다.
서블릿에서의 멀티 파일 업로드
멀티 파트 형식은 전송 데이터를 각각 부분(part)로 나눠 전송한다.
application.properties 설정
file.dir=파일 업로드 경로 설정(예): /Users/files/
서블릿 컨트롤러
서블릿이 제공하는 Part통해 파일에 업로드를 한다.
@PostMapping("/upload")
public String saveFileV1(HttpServletRequest request) throws ServletException, IOException {
String itemName = request.getParameter("itemName");
Collection<Part> parts = request.getParts();
for (Part part : parts) {
//데이터 읽기
InputStream inputStream = part.getInputStream();
String body = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
//파일에 저장하기
if (StringUtils.hasText(part.getSubmittedFileName())) {
String fullPath = fileDir + part.getSubmittedFileName();
part.write(fullPath);
}
}
return "upload-form";
}
- request.getParts() : multipart/form-data 전송 방식에서 각각 나눠진 부분을 반환
- part.getSubmittedFileName() : 클라이언트가 전달한 파일명을 반환
- part.getInputStream() : Part의 전송 데이터를 로드
- part.write() : Part를 통해 전송된 데이터를 저장
스프링에서의 멀티 파일 업로드
스프링에서는 MutipartFile 이라는 인터페이스로 멀티 파일 파일을 매우 편리하게 지원한다.
MutipartFile 인터페이스
public interface MultipartFile {
// 파일의 이름을 반환 (폼 필드 이름)
String getName();
// 원본 파일 이름을 반환 (파일 시스템에 저장된 이름)
String getOriginalFilename();
// 파일의 MIME 타입을 반환
String getContentType();
// 파일 크기를 바이트 단위로 반환
long getSize();
// 파일이 비어 있는지 확인
boolean isEmpty();
// 파일의 내용을 바이트 배열로 반환
byte[] getBytes() throws IOException;
// 파일의 내용을 InputStream으로 반환
InputStream getInputStream() throws IOException;
// 파일을 주어진 경로에 저장
void transferTo(java.io.File dest) throws IOException, IllegalStateException;
}
스프링 컨트롤러
업로드하는 폼의 이름에 맞춰 파라미터를 적용하기만 하면 된다.
@PostMapping("/upload")
public String saveFile(@RequestParam String itemName, @RequestParam MultipartFile file) throws IOException {
if (!file.isEmpty()) {
String fullPath = fileDir + file.getOriginalFilename();
file.transferTo(new File(fullPath));
}
return "upload-form";
}
실제 파일 저장 적용
상품이 있고 첨부 파일 과 이미지 파일 여러개를 가진 폼을 전달하고 다운로드할 수 있는 기능을 적용해보자.
Item - 상품 도메인 정의
@Data
public class Item {
private Long id;
private String itemName;
private UploadFile attachFile;
private List<UploadFile> imageFiles;
}
ItemRepository - 상품 리포지토리 정의
@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 - 업로드 파일 정보를 보관할 클래스 정의
서로 다른 고객이 같은 파일이름을 업로드 하는 경우 기존 파일 이름과 충돌이 날 수 있기 때문에 각각 정의
@Data
public class UploadFile {
private String uploadFileName;
private String storeFileName;
public UploadFile(String uploadFileName, String storeFileName) {
this.uploadFileName = uploadFileName;
this.storeFileName = storeFileName;
}
}
ItemForm - form 정의
@Data
public class ItemForm {
private Long itemId;
private String itemName;
private List<MultipartFile> imageFiles;
private MultipartFile attachFile;
}
FileStore - 파일 저장과 관련된 업무 처리 정의
@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);
}
}
- createStoreFileName() : 서버 내부에서 관리하는 파일명이 충돌나지 않게 랜덤 UUID 값 사용
- extractExt() : 확장자를 추가로 붙여주는 함수
Item 컨트롤러 - 저장
폼을 저장하고 view 화면으로 리다이렉트
@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}";
}
Item 컨트롤러 - 이미지 조회
@ResponseBody
@GetMapping("/images/{filename}")
public Resource downloadImage(@PathVariable String filename) throws MalformedURLException {
return new UrlResource("file:" + fileStore.getFullPath(filename));
}
- UrlResource로 이미지 파일을 읽을 수 있다. 읽인 후 ResponseBody를 통해 이미지 바이너리 반환
Item 컨트롤러 - 파일 다운로드
id를 받아 권한 체크를 한 이후 파일 업로드
@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));
String encodedUploadFileName = UriUtils.encode(uploadFileName, StandardCharsets.UTF_8);
String contentDisposition = "attachment; filename=\"" +encodedUploadFileName + "\"";
return ResponseEntity.ok().header(HttpHeaders.CONTENT_DISPOSITION, contentDisposition) .body(resource);
}
'웹 개발' 카테고리의 다른 글
스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 스프링 타입 컨버터 (0) | 2024.06.01 |
---|---|
스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 예외 처리 (0) | 2024.05.30 |
스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 로그인 처리 (0) | 2024.05.30 |
스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 검증 (0) | 2024.05.30 |
intellij 단축키 (0) | 2024.04.16 |