개요
내용 : 이제는 파일 업로드(multipar/form-data)에 대해 배워보자.
1. 파일 업로드 소개
일반적으로 사용하는 HTML Form을 통한 파일 업로드를 이해하려면 먼저 폼을 전송하는 다음 두 가지 방식의 차이를 이해해야 한다.
HTML 폼 전송 방식
application/x-www-form-urlencodedmultipart/form-dataapplication/x-www-form-urlencoded 방식
application/x-www-form-urlencoded방식은 HTML 폼 데이터를 서버로 전송하는 가장 기본적인 방법이다. Form 태그에 별도의 enctype 옵션이 없으면 웹 브라우저는 요청 HTTP 메시지의 헤더에 다음 내용을 추가한다.
Content-Type: application/x-www-form-urlencoded
- 그리고 폼에 입력한 전송할 항목을 HTTP Body에 문자로
username=kim&age=20와 같이 & 로 구분해서 전송한다.파일을 업로드 하려면 파일은 문자가 아니라 바이너리 데이터를 전송해야 한다. 문자를 전송하는 이 방식으로 파일을 전송하기는 어렵다. 그리고 또 한가지 문제가 더 있는데, 보통 폼을 전송할 때 파일만 전송하는 것이 아니라는 점이다.
이름과 나이도 전송해야 하고, 첨부파일도 함께 전송해야 한다. 문제는 이름과 나이는 문자로 전송하고, 첨부파일은 바이너리로 전송해야 한다는 점이다. 문자와 바이너리를 동시에 전송해야 하는 상황인 것이다.
이 문제를 해결하기 위해 HTTP는multipart/form/data라는 전송 방식을 제공한다.
multipart/form/data 방식
- 이 방식을 사용하려면 Form 태크에 별도의
enctype = "multipart.form-data"를 지정해야 한다.- multipart/form-data 방식은 다른 종류의 여러 파일과 폼의 내용 함께 전송할 수 있다.
- 폼의 입력 결과로 생성된 HTTP 메시지를 보면 각각의 전송 항목이 구분이 되어있다.
Content-Disposition 이라는 항목별 헤더가 추가되어 있고 여기에 부가 정보가 있다. 예제에서는 username,age , file1 이 각각 분리되어 있고, 폼의 일반 데이터는 각 항목별로 문자가 전송되고, 파일의 경우 파일 이름과 Content-Type이 추가되고 바이너리 데이터가 전송된다.multipart/form-data 는 이렇게 각각의 항목을 구분해서, 한번에 전송하는 것이다.
2. 서블릿과 파일 업로드1
먼저 서블릿을 통한 파일 업로드를 코드와 함께 알아보자.
@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 추가하면 HTTP 요청 메시지를 확인할 수 있다. 이를 통해 로그를 확인 가능하다.멀티 파트 사용 옵션(업로드 사이즈 제한)
spring.servlet.multipart.max-file-size=1MBspring.servlet.multipart.max-request-size=10MB
큰 파일을 무제한 업로드하게 둘 수는 없으므로 업로드 사이즈를 제한할 수 있다.
사이즈를 넘으면 예외가 발생한다.
max-request-size: 멀티파트 요청 하나에 여러 파일을 업로드 할 수 있는데, 그 전체 합이다. 기본 10MB
3. 서블릿과 파일 업로드2
서블릿이 제공하는
Part에 대해 알아보고 실제 파일도 서버에 업로드 해보자.
먼저 파일을 업로드 하려면 실제 파일이 저장되는 경로가 필요하다.
경로에 실제 폴더를 만들어주자.
application.properties
- file.dir=파일 업로드 경로 설정 (예): /Users/hyowon/study/file/
주의
1. 해당 경로에 실제 폴더를 미리 만들어주자.
2.application.properties에서 설정할 때 마지막에/가 포함된 것에 주의@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("submittedFileName={}", 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"; } }
application.properties에서 설정한file.dir의 값을 주입한다.- 멀티파트 형식은 전송 데이터를 하나하나 각각 부분으로 나누어 전송한다.
parts에는 이렇게 나누어진 데이터가 각각 담긴다. 서블릿이 제공하는Part는 멀티파트 형식을 편리하게 읽을 수 있는 다양한 메서드를 제공한다.- Part 주요 메서드
part.getSubmittedFileName(): 클라이언트가 전달한 파일명
part.getInputStream(): Part의 전송 데이터를 읽을 수 있다.
part.write(...): Part를 통해 전송된 데이터를 저장할 수 있다.
다음 내용을 전송했다.
- itemName : 상품A
- file : 스크릿샷.png
- 파일 저장 경로에 가보면 실제 파일이 저장된 것을 확인할 수 있다.
4. 스프링과 파일 업로드
스프링은
MultipartFile이라는 인터페이스로 멀티파트 파일을 매우 편리하게 지원한다.@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 MultiparFile file
업로드하는 HTML Form의 name에 맞추어@RequestParam을 적용하면 된다. 추가로
@ModelAttribute에서도MultipartFile을 동일하게 사용할 수 있다.
MultipartFile 주요 메서드
- file.getOriginalFilename() : 업로드 파일 명
- file.transferTo(...) : 파일 저장
