[Java / Spring] 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 11. 파일 업로드

본 내용은 인프런 김영한님의
"스프링 MVC 2편 - 백엔드 웹 개발 활용 기술" 강의 내용을 정리한 것입니다.

---

 

📕 HTML 폼 전송 방식

📗 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이 추가되고 바이너리 데이터가 전송됨

 

Part 

multipart/form-data는 application/x-www-form-urlencoded와 비교해서 매우 복잡하고 각각의 부분( Part)로 나누어져 있음. 

그렇다면 이렇게 복잡한 HTTP 메시지를 서버에서 어떻게 사용할 수 있을까?

 

📕 서블릿과 파일 업로드

📗 ServletUploadControllerV1

@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 전송 방식에서 각각 나누어진 부분을 받아서 확인할 수 있음

 

테스트를 진행하기 전에 먼저 다음 옵션들을 추가

[application.properties]

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

이 옵션을 사용하면 HTTP 요청 메시지를 확인할 수 있음

실행해보면 logging.level.org.apache.coyote.http11 옵션을 통한 로그에서 

multipart/formdata 방식으로 전송된 것을 확인할 수 있음

 

Content-Type: multipart/form-data; boundary=----xxxx

------xxxx
Content-Disposition: form-data; name="itemName"

Spring
------xxxx
Content-Disposition: form-data; name="file"; filename="test.data"
Content-Type: application/octet-stream

sdklajkljdf...

 

📗 멀티파트 사용 옵션

업로드 사이드 제한

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

끄기 결과

request=org.apache.catalina.connector.RequestFacade@xxx
itemName=null
parts=[]

spring.servlet.multipart.enabled 옵션을 끄면 서블릿 컨테이너는 멀티파트와 관련된 처리를 하지 않음

 

켜기(기본 값)

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로 변한 것을 확인할 수 있음

 

📗 실제 파일 업로드

[application.properties]

file.dir=파일 업로드 경로 설정(예): /Users/kimyounghan/study/file/

주의

• 꼭 해당 경로에 실제 폴더를 미리 생성
• application.properties에서 설정할 때 마지막에 / (슬래시)가 포함된 것에 주의

 

[ServletUploadControllerV2]

@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";
    }
}

• 멀티파트 형식은 전송 데이터를 하나하나 각각 부분( Part )으로 나누어 전송한다.
• parts에는 이렇게 나누어진 데이터가 각각 담김.
• 서블릿이 제공하는 Part 는 멀티파트 형식을 편리하게 읽을 수 있는 다양한 메서드를 제공

 

Part 주요 메서드

• part.getSubmittedFileName() : 클라이언트가 전달한 파일명
• part.getInputStream() : Part의 전송 데이터를 읽음
• part.write(...) : Part를 통해 전송된 데이터를 저장

 

결과 로그

==== PART ====
name=itemName
header content-disposition: form-data; name="itemName"
submittedFileName=null
size=7
body=상품A
==== PART ====
name=file
header content-disposition: form-data; name="file"; filename="스크린샷.png"
header content-type: image/png
submittedFileName=스크린샷.png
size=112384
body=qwlkjek2ljlese...
파일 저장 fullPath=/Users/kimyounghan/study/file/스크린샷.png

 

📕 스프링과 파일 업로드

스프링은 MultipartFile이라는 인터페이스로 멀티파트 파일을 매우 편리하게 지원

[SpringUploadController]

@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";
    }
}

 

MultipartFile 주요 메서드 

• file.getOriginalFilename() : 업로드 파일 명
• file.transferTo(...) : 파일 저장

 

실행 로그

request=org.springframework.web.multipart.support.StandardMultipartHttpServletRequest@5c022dc6
itemName=상품A
multipartFile=org.springframework.web.multipart.support.StandardMultipartHttpServletRequest$StandardMultipartFile@274ba730
파일 저장 fullPath=/Users/kimyounghan/study/file/스크린샷.png

 

📗 예제로 구현하는 파일 업로드, 다운로드

요구사항

• 상품을 관리
  • 상품 이름
  • 첨부파일 하나
  • 이미지 파일 여러개
• 첨부파일을 업로드 다운로드 할 수 있다.
• 업로드한 이미지를 웹 브라우저에서 확인할 수 있다.

 

[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;
    }
}

• 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.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 : imageFiles) {
            if (!imageFile.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]

@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.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}")
    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="업로드 파일명" 값을 줌

 

[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>

 

[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>