파일 업로드

파일 업로드 소개

일반적으로 사용하는 HTML Form을 통한 파일업로드를 이해하려면 먼저 폼을 전송하는 다음 두가지 방식 차이를 이해해야 한다.

 

HTML 폼 전송방식

- application/x-www-form-urlencoded

- multipart/form-data

가장 기본적인 방법이다.

Form 태그에 별도의 enctype 옵션이 없으면 요청 HTTP 메세지의 헤더에

ContentType: application/x-www-form-urlencoded를 추가한다.

 

그리고 폼에 입력한 전송할 항목을 HTTP body에 문자로 username=kim&age=20와 같이 &로 구분해서 전송한다.

 

파일 업로드를 하려면 파일은 문자가 아니라 바이너리 데이터를 전송해야 한다. 문자를 전송하는 이 방식으로는 파일을 전송하기 어렵다.

이름, 나이, 첨부파일(뭐 프로필사진이라던지)를 전송한다고 했을 때, 이름과 나이는 문자로 전송, 첨부파일은 바이너리로 전송해야 하는데, 문제는 문자와 바이너리를 동시에 전송해야 하는 상황이다.

 

이 문제를 해결하기 위해 HTTP는 multipart/form-data라는 방식을 제공한다.

이 방식을 사용하려면 Form 태그에 별도의 enctype="multipart/form-data"를 지정해야 한다.

위 방식은 다른 종류의 여러 파일과 폼을 함께 전송할 수 있다.

 

HTTP 메세지를 보면 전송 항목이 구분되어있는데, Content-Disposition이라는 항목별 헤더가 추가되어 있고 여기에 부가정보가 있다.

username, age, file1이 각각 분리되어있고, 일반 데이터에는 각 항목별로 문자가 전송되고, 파일의 경우 파일 이름과 Content-type이 추가되고 바이너리 데이터가 전송된다.

 

multipart/form-data는 이렇게 각각의 항목을 구분해서 한번에 전송하는 것이다.

application/x-www-form-urlencoded와 비교했을때 매우 복잡해서 각각의 part로 나눠져있는데, 이렇게 복잡한 HTTP 메세지를 서버에서는 어떻게 사용할 수 있을까?

 

서블릿과 파일 업로드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";
    }
}

 

get.parts(): multipart/form-data 전송 방식에서 각각 나누어진 부분 (boundary로 나눈)을 받아서 확인할 수 있다.

 

multipart/form-data 방식으로 전송된것을 확인할 수 있다.

 

업로드 사이즈 제한

spring.servlet.multipart.max-file-size=1MB

spring.servlet.multipart.max-request-size=10MB

파일 하나의 사이즈 1MB 제한, 멀티파트 요청 하나에 여러파일을 업로드할 때 총 합의 용량 10MB 제한

 

spring.servlet.multipart.enabled 끄기

spring.servlet.multipart.enabled=false

멀티파트는 일반적인 요청보다 훨씬 복잡하다. 서버에서 x-www-form-urlencoded만 지원한다면 아예 멀티파트 관련된 처리를 하지 않도록 막아둘 수 있다. 기본값은 true이다.

 

옵션을 켜면 DispatcherServlet에서 MultipartResolver를 실행한다. 멀티파트 리졸버는 멀티파트 요청인 경우 서블릿 컨테이너가 전달하는 일반적인 HttpServletRequest를 MultipartHttpServletRequest로 변환한다. HttpServletRequest의 자식 인터페이스이고 멀티파트 관련된 기능을 제공한다.

 

스프링이 제공하는 MultipartResolver는 MultipartHttpServletRequest를 구현한 StandardMultipartHttpServletRequest를 반환한다. (알고만 있어라)

 

서블릿과 파일 업로드2

서블릿이 제공하는 Part에 대해 알아보고 실제 파일도 업로드해보자

 

먼저 파일이 저장되는 경로를 설정한다.

file.dir=/Users/sunghyeonkim/Desktop/ex/

 

application.properties에 설정해준다.

 

@Slf4j
@Controller
@RequestMapping("/servlet/v2")
public class ServletUploadControllerV2 {

    @Value("${file.dir}")
    public 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("${file.dir}) 로 설정한 값을 주입했다.

멀티파트 형식은 전송 데이터를 하나하나 각각 Part로 나누어 전송한다. parts에는 이렇게 나누어진 데이터가 각각 담긴다.

 

Part 주요 메서드

part.getSubmittedFileName() : 클라이언트가 전달한 파일 명

part.getInputStream() : Part의 전송데이터를 읽을 수 있다.

part.write() : Part를 통해 전송된 데이터를 저장

 

 

스프링과 파일 업로드

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

import java.io.File;
import java.io.IOException;

@Slf4j
@Controller
@RequestMapping("/spring")
public class SpringUploadController {

    @Value("${file.dir}")
    public 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

 

업로드 하는 HTML Form의 name에 맞추어 @RequestParam을 적용하면 된다. (@Modelattribute도 가능)

 

MultipartFile 주요 메서드

file.getOriginalFilename() : 업로드 파일 명

file.transferTo() : 파일 저장

 

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

요구사항

- 상품 관리

상품 이름

첨부파일 하나

이미지 파일 여러개

- 첨부파일 업로드, 다운로드

- 업로드 이미지 브라우저에서 확인

 

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

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

 

리포지토리

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:  서버 내부에서 관리하는 파일 명 (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 uuid = UUID.randomUUID().toString();
        String ext = extractExt(originalFileName);
        return uuid + "." + ext;
    }

    private String extractExt(String originalFileName) {
        int pos = originalFileName.lastIndexOf(".");
        return originalFileName.substring(pos + 1);
    }
}

 

멀티파트 파일을 서버에 저장하는 클래스

- createStoreName() : 파일명을 uuid로 변환

- extractExt() : 확장자를 추출해서 파일명에 붙여줌

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 MultipartFile attachFile;
    private List<MultipartFile> imageFiles;
}

 

Item 클래스랑 다름. 이미지 다중 업로드를 하기 위해 MultipartFile 사용

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

 

컨트롤러. 다운로드 하는 메서드도 포함됨. 천천히 읽어보기

 

아주 길지만 핵심은

1. 업로드 파일명/ 서버보관 파일명 분리 

- 충돌 방지

 

2. @RequestParam MultipartFile file

- 스프링이 multipart/form-data 요청을 파싱해서 MultipartFile 객체로 바꿔줌

- 우리가 직접 boundary나 파싱 신경 안써도 됨

 

3. TransferTo()

- 파일을 저장.

- DB에는 uploadFileName, storeFileName같이 기록해두면 관리 끝.

 

 

 

 

정리

 

1. 전송 방식 차이

• application/x-www-form-urlencoded→ 문자만 전송 가능 → 파일 업로드 불가
• → 일반 form 데이터 전송 (username=kim&age=20)
• multipart/form-data→ 각 part에는 Content-Disposition, Content-Type, 파일 이름 등이 포함됨
• → 문자 + 바이너리(파일) 데이터를 **part 단위(boundary 구분)**로 전송

2. 서블릿 파일 업로드

서블릿의 request.getParts() 로 각각의 Part(폼 필드, 파일 등)를 꺼낼 수 있음

• 주요 메서드
  • part.getSubmittedFileName() → 업로드된 원본 파일명
  • part.getInputStream() → 파일 데이터 읽기
  • part.write(path) → 서버에 저장

3. 스프링 파일 업로드

• 스프링은 MultipartResolver 로 요청을 파싱 → MultipartFile 제공
• @RequestParam MultipartFile file 만 쓰면 바로 파일 객체 사용 가능
• 주요 메서드
  • file.getOriginalFilename() → 원본 이름
  • file.transferTo(new File(path)) → 서버 저장

👉 서블릿 방식보다 훨씬 간단함

 

4. 파일 저장 전략

• 업로드 파일명(uploadFileName): 고객이 업로드한 원본 이름
• 저장 파일명(storeFileName): 서버에서 UUID + 확장자로 변환해 충돌 방지
• DB에는 두 값을 함께 저장 → 사용자에겐 원본명 보여주고, 서버에는 저장명 사용

5. 다운로드 처리

• 이미지: @ResponseBody + UrlResource → 브라우저에서 바로 렌더링
• 첨부파일: ResponseEntity<Resource> + Content-Disposition 헤더 → 파일 다운로드