🌱 Spring MVC (15) 파일 업로드1 (Multipart/form-data, MultipartFile)

Kim Dae Hyun·2021년 7월 25일

Spring spring mvc

Spring-MVC

목록 보기

13/13

Github 소스코드

🔎 Multipart/form-data

Sprint MVC의 파일 업로드에 대해 알아보기 전에 Multipart/form-data에 대해 먼저 알아야 합니다.

우리가 일반적으로 폼 데이터를 전송하면 application/x-www-form-urlencoded 의 형식으로 전송됩니다. HTTP body 에 바로 전송하고자 하는 데이터가 들어가는 형태입니다.
name=kim&age=26 과 같은 key-value 쌍이 body에 들어가는 것이지요.
이렇게 동일한 타입의 문자 데이터를 전송하는 것은 전혀 무리가 없습니다.

하지만 이런 key-value 형태의 문자데이터와 바이너리 형태의 파일 데이터가 함께 전송되어야 하는 경우엔 어떨까요 ?
body의 어디쯤에 여기부터는 파일이 전송되는 것이라고 알려주어야 할텐데 일반적인 application/x-www-form-urlencoded 타입으로는 불가능합니다.

전송되는 각 폼 데이터를 구분해주어야 합니다. 여기서 구분되는 한 단위를 part라고 하고 동시에 여러 단위의 part를 나눌 수 있기에 multipart라는 이름이 붙은 것 입니다.

형태는 아래와 같습니다.

============로 구분되는 일종의 구분자는 난수값으로 결정됩니다.

Content-Type을 multipart/form-data로 하기 위해서 form 태그에 enctype을 지정해주어야 합니다.

🔎 Multipart/form-data 파싱

Spring은 MultipartFile 타입을 제공합니다.
또한 감사하게도 @RequestParam, @ModelAttribute를 모두 사용할 수 있습니다.

먼저 실습을 위한 HTML파일을 작성하겠습니다.
상품명과 상품의 이미지를 입력받는 폼 입니다.
form 태그의 옵션으로 enctype을 설정해주여야 합니다.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div>
  <div>
    <h2>상품 등록 폼</h2>
  </div>
  <h4>상품 입력</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>
</body>
</html>

이제 폼 데이터를 받아줄 컨트롤러를 작성하겠습니다.
중요한건 @PostMapping 메서드입니다.
@RequestMappint을 이용해 상품명과 파일을 받고 있습니다. multipart/form-data가 전송되는 구조를 보면 각 파트마다 name을 갖고 있기 때문에 이런 식의 파싱이 가능한 것 같습니다.

itemName은 잘 넘어왔다고 가정하고 파일만 테스트를 해볼께요.
MultipartFile은 getOriginalFilename() 메서드를 지원합니다. 이 메서드는 파일명과 확장자까지 붙여서 문자열을 반환합니다.

저장할 파일의 파일명과 확장자까지 알았으니 이제 경로를 지정하고 저장해주면 됩니다. 파일을 저장하는 경로는 상단에 uploadDiR에 지정해두었습니다. 환경변수 등으로 빼는 것이 좋지만 간단한 실습을 위해 이렇게 했습니다.

저장할 경로와 파일의 이름을 붙여서 파일 저장에 대한 완전한 경로를 만들어 줍니다.

완전한 경로를 File객체로 만들어서 MultipartFile의 transferTo 메서드를 호출하면 파일 저장이 완료됩니다.

@Slf4j
@Controller
public class TestController {

    private final String uploadDir = "/Users/jeonhyeji/Documents/etc/file/";

    @GetMapping("/review/form")
    public String newForm() {
        return "upload-form";
    }

    @PostMapping("/review/form")
    public String form(@RequestParam String itemName,
                       @RequestParam MultipartFile file) throws IOException {

        if (!file.isEmpty()) {
            String filename = file.getOriginalFilename();
            log.info("file.getOriginalFilename = {}", filename);

            String fullPath = uploadDir + filename;
            file.transferTo(new File(fullPath));
        }
        return "upload-form";
    }
}

결과입니다.

이상으로 간단한 파일 업로드에 대해 알아보았습니다.
다음에는 조금 더 복잡한 예제를 구성해서 파일 업로드에 대해 깊게 알아볼께요.
감사합니다. 😄

Kim Dae Hyun

좀 더 천천히 까먹기 위해 기록합니다. 🧐

이전 포스트

🌱 Spring MVC (14) API 요청에 대한 예외처리 (@ExceptionHandler, @ControllerAdvice)

1개의 댓글

띠에러 래빗

2022년 8월 12일

저는 jsp를 통해서 코딩 중인데
form태그에 enctype을 입력하지 않아도 Controller에서 잘 받아지는 것 같더라구요.
왜 그런지 혹시 아시나요??

답글 달기