'스프링 MVC 2편 - 백엔드 웹 개발 활용 기술' 수업을 듣고 정리한 내용입니다.
일반적으로 사용하는 HTML Form을 통한 파일 업로드를 이해하려면 먼저 폼을 전송하는 다음 두 가지 방식의 차이를 이해해야 한다!
HTML 폼 전송 방식
application/x-www-form-urlencoded
multipart/form-data
application/x-www-form-urlencoded
방식은 HTML 폼 데이터를 서버로 전송하는 가장 기본적인 방법이다. enctype
옵션이 없으면 웹 브라우저는 요청 HTTP 메시지의 헤더에 Content-Type: application/x-www-form-urlencoded
을 추가한다.username=kim&age=20
와 같이 &
로 구분해서 전송한다.
문제점
위 문제점을 해결하기 위해 HTTP는 multipart/form-data
라는 전송 방식을 제공한다.
enctype="multipart/form-data"
를 지정해야 한다.multipart/form-data
방식은 다른 종류의 여러 파일과 폼의 내용 함께 전송할 수 있다. (그래서 이름이 multipart
이다.)Content- Disposition
: 항목별 헤더Content-Type
이 추가되고 바이너리 데이터가 전송된다.➡️ multipart/form-data
는 이렇게 각각의 항목을 구분해서, 한번에 전송하는 것이다.
📣 Part
multipart/form-data
는application/x-www-form-urlencoded
와 비교해서 매우 복잡하고 각각의 부분(Part
)로 나누어져 있다.
💡 참고
multipart/form-data
와 폼 데이터 전송에 대한 더 자세한 내용은 모든 개발자를 위한 HTTP 웹 기본 지식 강의를 참고하기!
이렇게 복잡한 HTTP 메시지를 서버에서 어떻게 사용할 수 있을까?
첫 화면
서블릿을 통한 파일 업로드를 알아보자!
ServletUploadControllerV1
package hello.upload.controller;
import lombok.extern.slf4j.Slf4j;
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 javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
import java.io.IOException;
import java.util.Collection;
@Slf4j
@Controller
@RequestMapping("/servlet/v1")
public class ServletUploadControllerV1 {
@GetMapping("/upload")
public String newFile() {
return "upload-form";
}
@PostMapping("/upload")
public String saveFileV1(HttpServletRequest request) throws ServletException, IOException {
log.info("request={}", request);
String itemName = request.getParameter("itemName");
log.info("itemName={}", itemName);
Collection<Part> parts = request.getParts();
log.info("parts={}", parts);
return "upload-form";
}
}
request.getParts()
: multipart/form-data
전송 방식에서 각각 나누어진 부분을 받아서 확인할 수 있다.
resources/templates/upload-form.html
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="utf-8">
</head>
<body>
<div class="container">
<div class="py-5 text-center"> <h2>상품 등록 폼</h2>
</div>
<h4 class="mb-3">상품 입력</h4>
<form th:action method="post" enctype="multipart/form-data">
<ul>
<li>상품명 <input type="text" name="itemName"></li>
<li>파일<input type="file" name="file" ></li> </ul>
<input type="submit"/>
</form>
</div> <!-- /container -->
</body>
</html>
application.properties
logging.level.org.apache.coyote.http11=debug
실행 결과
결과 로그
logging.level.org.apache.coyote.http11
옵션을 통한 로그에서 multipart/form- data
방식으로 전송된 것을 확인할 수 있다.
✔️ 업로드 사이즈 제한
spring.servlet.multipart.max-file-size=1MB
spring.servlet.multipart.max-request-size=10MB
SizeLimitExceededException
)가 발생한다.max-file-size
: 파일 하나의 최대 사이즈, 기본 1MBmax-request-size
: 멀티파트 요청 하나에 여러 파일을 업로드 할 수 있는데, 그 전체 합이다. 기본 10MB
✔️ spring.servlet.multipart.enabled 끄기
멀티파트와 관련된 처리 끄기
spring.servlet.multipart.enabled=false
결과 로그
request=org.apache.catalina.connector.RequestFacade@xxx
itemName=null
parts=[]
application/x-www-form-urlencoded
보다 훨씬 복잡하다. spring.servlet.multipart.enabled
옵션을 끄면 서블릿 컨테이너는 멀티파트와 관련된 처리를 하지 않는다.request.getParameter("itemName")
, request.getParts()
의 결과가 비어있다.
✔️ spring.servlet.multipart.enabled 켜기
- 기본(default)
true
이다!- 서블릿 컨테이너에게 멀티파트 데이터를 처리하라고 설정
spring.servlet.multipart.enabled=true
결과 로그
request=org.springframework.web.multipart.support.StandardMultipartHttpServletRequest
itemName=Spring
parts=[ApplicationPart1, ApplicationPart2]
request.getParameter("itemName")
의 결과도 잘 출력되고, request.getParts()
에도 요청한 두 가지 멀티파트의 부분 데이터가 포함된 것을 확인할 수 있다. HttpServletRequest
객체가 RequestFacade
→ StandardMultipartHttpServletRequest
로 변한 것을 확인할 수 있다!
💡 참고
spring.servlet.multipart.enabled
옵션을 켜면 스프링의DispatcherServlet
에서 멀티파트 리졸버(MultipartResolver
)를 실행한다.- 멀티파트 리졸버는 멀티파트 요청인 경우 서블릿 컨테이너가 전달하는 일반적인
HttpServletRequest
를MultipartHttpServletRequest
로 변환해서 반환한다.MultipartHttpServletRequest
는HttpServletRequest
의 자식 인터페이스이고, 멀티파트와 관련된 추가 기능을 제공한다.
- 스프링이 제공하는 기본 멀티파트 리졸버는
MultipartHttpServletRequest
인터페이스를 구현한StandardMultipartHttpServletRequest
를 반환한다.- 이제 컨트롤러에서
HttpServletRequest
대신에MultipartHttpServletRequest
를 주입받을 수 있는데, 이것을 사용하면 멀티파트와 관련된 여러가지 처리를 편리하게 할 수 있다.➡️ 그런데, 이후 강의에서 공부할
MultipartFile
이라는 것을 사용하는 것이 더 편하기 때문에MultipartHttpServletRequest
를 잘 사용하지는 않는다. (더 자세한 내용은MultipartResolver
를 검색해보기!)
서블릿이 제공하는
Part
에 대해 알아보고 실제 파일도 서버에 업로드 해보자!
✔️ 파일 경로 지정
application.properties
file.dir=파일 업로드 경로 설정(예): /Users/kimyounghan/study/file/
/
(슬래시)가 포함된다.
ServletUploadControllerV2
package hello.upload.controller;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Collection;
@Slf4j
@Controller
@RequestMapping("/servlet/v2")
public class ServletUploadControllerV2 {
@Value("${file.dir}")
private String fileDir;
@GetMapping("/upload")
public String newFile() {
return "upload-form";
}
@PostMapping("/upload")
public String saveFileV1(HttpServletRequest request) throws ServletException, IOException {
log.info("request={}", request);
String itemName = request.getParameter("itemName");
log.info("itemName={}", itemName);
Collection<Part> parts = request.getParts();
log.info("parts={}", parts);
for (Part part : parts) {
log.info("==== PART ====");
log.info("name-{}", part.getName());
Collection<String> headerNames = part.getHeaderNames();
for (String headerName : headerNames) {
log.info("header {}: {}", headerName, part.getHeader(headerName));
}
// 편의 메서드
// content-disposition; filename
log.info("sumittedFilename={}", part.getSubmittedFileName());
log.info("size={}", part.getSize()); // part body size
// 데이터 읽기
InputStream inputStream = part.getInputStream();
String body = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
log.info("body={}", body);
// 파일 저장하기
if (StringUtils.hasText(part.getSubmittedFileName())) {
String fullPath = fileDir + part.getSubmittedFileName();
log.info("파일 저장 fullPath={}", fullPath);
part.write(fullPath);
}
}
return "upload-form";
}
}
@Value("${file.dir}")
private String fileDir;
application.properties
에서 설정한 file.dir
의 값을 주입한다.
💡 참고
- 멀티파트 형식은 전송 데이터를 하나하나 각각 부분(
Part
)으로 나누어 전송한다.parts
에는 이렇게 나누어진 데이터가 각각 담긴다.- 서블릿이 제공하는
Part
는 멀티파트 형식을 편리하게 읽을 수 있는 다양한 메서드를 제공한다.
✔️ Part 주요 메서드
part.getSubmittedFileName()
: 클라이언트가 전달한 파일명part.getInputStream()
: Part
의 전송 데이터를 읽을 수 있다. part.write(...)
: Part
를 통해 전송된 데이터를 저장할 수 있다.
실행 결과
💡 참고
- 큰 용량의 파일을 업로드를 테스트 할 때는 로그가 너무 많이 남아서 다음 옵션을 끄는 것이 좋다.
➡️logging.level.org.apache.coyote.http11=debug
- 다음 부분도 파일의 바이너리 데이터를 모두 출력하므로 끄는 것이 좋다.
➡️log.info("body={}", body);
- 서블릿이 제공하는
Part
는 편하기는 하지만,HttpServletRequest
를 사용해야 하고, 추가로 파일 부분만 구분하려면 여러가지 코드를 넣어야 한다.- 스프링은 이 부분을 편리하게 제공한다.
- 스프링은
MultipartFile
이라는 인터페이스로 멀티파트 파일을 매우 편리하게 지원한다.
SpringUploadController
package hello.upload.controller;
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 javax.servlet.http.HttpServletRequest;
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("multipartFile={}", file);
if (!file.isEmpty()) {
String fullPath = fileDir + file.getOriginalFilename();
log.info("파일 저장 fullPath={}", fullPath);
file.transferTo(new File(fullPath));
}
return "upload-form";
}
}
@RequestParam MultipartFile file
@RequestParam
을 적용하면 된다.@ModelAttribute
에서도 MultipartFile
을 동일하게 사용할 수 있다.
✔️ MultipartFile 주요 메서드
file.getOriginalFilename()
: 업로드 파일 명file.transferTo(...)
: 파일 저장
실행 결과
실제 파일이나 이미지를 업로드, 다운로드 할 때는 몇가지 고려할 점이 있는데, 구체적인 예제로 알아보자.
🔔 요구사항
- 상품을 관리
- 상품 이름
- 첨부파일 하나
- 이미지 파일 여러개
- 첨부파일을 업로드 다운로드 할 수 있다.
- 업로드한 이미지를 웹 브라우저에서 확인할 수 있다.
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;
}
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;
}
}
uploadFileName
: 고객이 업로드한 파일명 storeFileName
: 서버 내부에서 관리하는 파일명
FileStore - 파일 저장과 관련된 업무 처리
- 고객이 업로드한 파일명으로 서버 내부에 파일을 저장하면 안된다.
- 서로 다른 고객이 같은 파일이름을 업로드 하는 경우 기존 파일 이름과 충돌이 날 수 있다.
- 서버에서는 저장할 파일명이 겹치지 않도록 내부에서 관리하는 별도의 파일명이 필요하다!
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.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);
}
}
멀티파트 파일을 서버에 저장하는 역할을 담당한다.
createStoreFileName()
: 서버 내부에서 관리하는 파일명은 유일한 이름을 생성하는 UUID
를 사용해서 충돌하지 않도록 한다.extractExt()
: 확장자를 별도로 추출해서 서버 내부에서 관리하는 파일명에도 붙여준다. 예를 들어서 고객이 a.png
라는 이름으로 업로드 하면 51041c62-86e4-4274-801d-614a7d994edb.png
와 같이 저장한다.
ItemForm
package hello.upload.controller;
import lombok.Data;
import org.springframework.web.multipart.MultipartFile;
import java.util.List;
@Data
public class ItemForm {
private Long itemId;
private String itemName;
private List<MultipartFile> imageFiles;
private MultipartFile attachFile;
}
상품 저장용 폼이다.
List<MultipartFile> imageFiles
: 이미지를 다중 업로드 하기 위해 MultipartFile
를 사용했다.MultipartFile attachFile
: 멀티파트는 @ModelAttribute
에서 사용할 수 있다.
ItemController
package hello.upload.controller;
import hello.upload.domain.Item;
import hello.upload.domain.ItemRepository;
import hello.upload.domain.UploadFile;
import hello.upload.file.FileStore;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.io.Resource;
import org.springframework.core.io.UrlResource;
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}")
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);
}
}
@GetMapping("/items/new")
: 등록 폼을 보여준다.@PostMapping("/items/new")
: 폼의 데이터를 저장하고 보여주는 화면으로 리다이렉트 한다. @GetMapping("/items/{id}")
: 상품을 보여준다.@GetMapping("/images/{filename}")
: <img>
태그로 이미지를 조회할 때 사용한다. UrlResource
로 이미지 파일을 읽어서 @ResponseBody
로 이미지 바이너리를 반환한다. @GetMapping("/attach/{itemId}")
: 파일을 다운로드 할 때 실행한다. 예제를 더 단순화 할 수 있지만, 파일 다운로드 시 권한 체크같은 복잡한 상황까지 가정한다 생각하고 이미지 id
를 요청하도록 했다. 파일 다운로드시에는 고객이 업로드한 파일 이름으로 다운로드 하는게 좋다. 이때는 Content-Disposition
헤더에 attachment; filename="업로드 파일명"
값을 주면 된다.
✔️ ItemController 클래스에서 알게 된 내용
404 발생
404
가 발생한다.
(1) 이미지 띄우기 기능 추가한 메소드
@ResponseBody
@GetMapping("/images/{filename}")
public Resource downloadImage(@PathVariable String filename) throws MalformedURLException {
return new UrlResource("file:" + fileStore.getFullPath(filename));
}
stream
으로 반환한다.
추가 후 결과
이미지가 띄워진다.
(2) 첨부파일 다운로드 기능 추가한 메소드
@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);
return ResponseEntity.ok()
.body(resource);
}
// String contentDisposition = "attachment; filename=\"" + uploadFileName + "\"";
// .header(HttpHeaders.CONTENT_DISPOSITION,contentDisposition)
// 위 2개가 없을 때 웹에서 파일 자체가 열린다.
이와 같이 실행시
➡️ 현재는 파일이 웹에서 출력된다.
소스 추가
우리가 원하는 것은 다운로드를 받는 것이다
String contentDisposition = "attachment; filename=\"" + uploadFileName + "\"";
return ResponseEntity.ok()
.header(HttpHeaders.CONTENT_DISPOSITION,contentDisposition)
.body(resource);
// String contentDisposition = "attachment; filename=\"" + uploadFileName + "\""; 추가
// .header(HttpHeaders.CONTENT_DISPOSITION,contentDisposition) 추가
downloadAttach
메소드)에 이를 추가한다!
하지만,
String contentDisposition = "attachment; filename=\"" + uploadFileName + "\"";
이와 같이 할시 다운로드된 파일을 열어보면
깨진 결과를 받을 수 있다.
위를 해결하기 위해
String encodedUploadFileName = UriUtils.encode(uploadFileName, StandardCharsets.UTF_8);
String contentDisposition = "attachment; filename=\"" + encodedUploadFileName + "\"";
UTF-8
을 적용한다.
등록 폼 뷰
resources/templates/item-form.html
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="utf-8">
</head>
<body>
<div class="container">
<div class="py-5 text-center">
<h2>상품 등록</h2> </div>
<form th:action method="post" enctype="multipart/form-data">
<ul>
<li>상품명 <input type="text" name="itemName"></li> <li>첨부파일<input type="file" name="attachFile" ></li>
<li>이미지 파일들
<input type="file" multiple="multiple" name="imageFiles" >
</li>
</ul>
<input type="submit"/>
</form>
</div> <!-- /container -->
</body>
</html>
multiple="multiple"
옵션을 주면 된다.ItemForm
의 private List<MultipartFile> imageFiles;
코드에서 여러 이미지 파일을 받을 수 있다.
조회 뷰
resources/templates/item-view.html
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="utf-8">
</head>
<body>
<div class="container">
<div class="py-5 text-center">
<h2>상품 조회</h2>
</div>
상품명: <span th:text="${item.itemName}">상품명</span><br/>
첨부파일: <a th:if="${item.attachFile}" th:href="|/attach/${item.id}|" th:text="${item.getAttachFile().getUploadFileName()}"/> <br/>
<img th:each="imageFile : ${item.imageFiles}" th:src="|/images/${imageFile.getStoreFileName()}|" width="300" height="300"/>
</div> <!-- /container -->
</body>
</html>
<img>
태그를 반복해서 출력한다.
최종 실행 화면
실행시 하나의 첨부파일을 다운로드 업로드 하고, 여러 이미지 파일을 한번에 업로드 할 수 있다.
참고