스프링 MVC 2편(백엔드 웹 개발 활용 기술)

Ch11. 파일 업로드 - 서블릿과 파일 업로드

webmaster 2022. 3. 23. 12:17
728x90

Controller 제작

@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";
    }
}
  • Multipart를 읽어서 Log를 찍는 Controller
  • request.getParts()를 사용해서 multipart/form-data 전송 방식에서 각각 나누어진 부분을 받아서 확인할 수 있다.

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>

해당 옵션을 켜 HTTP 요청 메시지를 확인할 수 있다.

logging.level.org.apache.coyote.http11=debug

업로드 사이즈 제한

spring.servlet.multipart.max-file-size=1MB
spring.servlet.multipart.max-request-size=10MB
  • 큰 파일을 무제한 업로드하게 둘 수는 없으므로 업로드 사이즈를 제한할 수 있다.
  • 사이즈를 넘으면 예외( SizeLimitExceededException )가 발생한다.
  • max-file-size : 파일 하나의 최대 사이즈, 기본 1MB
  • max-request-size : 멀티파트 요청 하나에 여러 파일을 업로드할 수 있는데, 그 전체 합이다. 기본 10MB

spring.servlet.multipart.enabled 끄기

spring.servlet.multipart.enabled=false
  • 멀티파트는 일반적인 폼 요청(application/x-www-form-utlencoded ) 보다 훨씬 복잡하다.
  • spring.servlet.multipart.enabled 옵션을 끄면 서블릿 컨테이너는 멀티파트와 관련된 처리를 하지 않는다
  • 기본 값은 true이며 해당 값을 켜면 스프링 부트는 서블릿 컨테이너에게 멀티파트 데이터를 처리하라고 설정한다
  • 참고
    • spring.servlet.multipart.enabled 옵션을 켜면 스프링의 DispatcherServlet에서 멀티파트 리졸버( MultipartResolver )를 실행한다.
    • 멀티파트 리졸버는 멀티파트 요청인 경우 서블릿 컨테이너가 전달하는 일반적인 HttpServletRequest를 MultipartHttpServletRequest로 변환해서 반환한다. 
    • MultipartHttpServletRequest는 HttpServletRequest의 자식 인터페이스이고, 멀티파트와 관련된 추가 기능을 제공한다
    • 스프링이 제공하는 기본 멀티파트 리졸버는 MultipartHttpServletRequest 인터페이스를 구현한 StandardMultipartHttpServletRequest를 반환한다. 
    • 이제 컨트롤러에서 HttpServletRequest 대신에 MultipartHttpServletRequest를 주입받을 수 있는데, 이것을 사용하면 멀티파트와 관련된 여러 가지 처리를 편리하게 할 수 있다.
    • 그런데 이후 강의에서 설명할 MultipartFile이라는 것을 사용하는 것이 더 편하기 때문에 MultipartHttpServletRequest를 잘 사용하지는 않는다. 더 자세한 내용은 MultipartResolver를 검색해보자.

Servlet MultiPart 직접 사용하기

먼저 파일을 업로드를 하려면 실제 파일이 저장되는 경로가 필요하다.

application.properties

file.dir=C://Users/KimJunHo/Desktop/test/
  • 저장될 파일 경로 설정
  • application.properties 에서 설정할 때 마지막에 / (슬래시)가 포함된 것에 주의

FileUploadController 작성

@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";
    }
}
  • @Value를 통해 application.properties에서 설정한 file.dir값을 주입한다.
  • Part에는 partHeader가 독립적으로 존재한다
  • 멀티파트 형식은 전송 데이터를 하나하나 각각 부분( Part )으로 나누어 전송한다. parts 에는 이렇게 나누어진 데이터가 각각 담긴다.
  • 서블릿이 제공하는 Part는 멀티파트 형식을 편리하게 읽을 수 있는 다양한 메서드를 제공한다
  • Part 주요 메서드
    • part.getSubmittedFileName() : 클라이언트가 전달한 파일명
    • part.getInputStream(): Part의 전송 데이터를 읽을 수 있다.
    • part.write(...): Part를 통해 전송된 데이터를 저장할 수 있다
  • 서블릿이 제공하는 Part는 편하기는 하지만, HttpServletRequest 를 사용해야 하고, 추가로 파일 부분만 구분하려면 여러가지 코드를 넣어야 한다

 

 

 

728x90