Spring에서의 파일업로드

hoyong.eom·2023년 8월 2일

Spring springMVC

스프링

목록 보기

26/59

Spring

파일 업로드

일반적인 form형식(Content-Type: application/x-www-form-urlencoded) 으로는 바이너리를 전달이 불가능하다.

따라서 이러한 문제를 해결하기 위해서는 아래의 타입을 사용해야한다.

multipart/form-data

method="post" enctype="multipart/form-data"

multipart/form-data를 사용하기 위해서는 enctype이라는 태그에 추가러 넣어줘야한다.

multipart/form-data방식은 다른 종류의 여러 파일과 폼의 내용을 함께 전달할 수 있다고 한다.

Http 메시지를 보면 Content-Disposition이라는 항목별 헤더가 추가되며, 전송하고자하는 바이너리와 데이터들이 구분되어 전송된다.

스프링에서 multipart 사용하기

스프링에서는 multipart-formdata 형식을 사용하기 위해서는 기본적으로 true 설정이 되어 있다.
하지만, application.properties 파일에서 이 설정을 변경할 수 도 있다.

spring.servlet.multipart.enabled=true

기본값은 true이지만, 이 옵션을 키게 되면 스프링부트는 서블릿 컨테이너에게 멀티파트 데이터를 처리하라고 설정한다.

파일을 업로드한 경우의 예시 컨트롤러는 아래와 같다.

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

StandardMultipartHttpServletRequest

일반적으로 multipart/form-data 형식을 처리하기 위해서 스프링은 HttpServletRequest에 StandardMultipartHttpServletRequest 구현체를 넣어서 처리한다.

MultipartHttpServletRequest는 HttpServletRequest의 자식 인터페이스이고, 멀티파트와 관련된 추가 기능을 제공한다.

파일 업로드

스프링에서 파일 업로드를 수행하는 예시 코드를 보면 아래와 같다.

@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 : @Value 애노테이션을 이용해서 application.properties에 정의된 값을 주입한다.
멀티 파트 형식은 전송 데이터를 하나하나 각 부분의 Part로 나누어 전송한다.
위 코드에서 parts에는 이렇게 나누어진 데이터가 저장된다.
서블릿이 제공하는 Part는는 멀티파트 형식을 편리하게 읽을 수 있는 다양한 메소드를 제공한다.

part 주요 메서드
part.getSumittedFileName() : 클라이언트가 전달한 파일명
part.getInputStream() : Part의 전송 데이터를 읽을 수 있다.
part.write(...) : Part를 통해서 전송된 데이터를 저장할 수 있다.

Spring에서의 파일업로드

서블릿에서 제공해주는 Part는 HttpServletRequest를 사용해야하고 추가로 파일 부분만 구분하기 위해서는 여러 코드를 넣어야한다.
이러한 점을 스프링에서는 좀더 편리하게 사용할 수 있도록 제공한다.

예시 코드

@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 MultipartFile file : 업로드하는 HtmlForm에 name에 맞추어 @RequestParam을 적용하면 된다. 추가로 @ModelAttribute도 MultipartFile을 동일하게 사용할 수 있다.

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

파일 업로드 및 다운로드 구현시 유의 사항

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

일반적으로 파일 다운로드를 수행하기 위해서는 위 소스 처럼 UrlResource라는 객체를 이용한다.
UrlResource 객체의 생성자에 파일 전체 경로를 포함해서 HttpMessageBody에 넘겨준다.