[Spring] 파일 업로드

내가 공부한것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼겸 상세히 기록하고 얕은부분들은 가겹게 포스팅 하겠습니다.

1. 파일 업로드 소개

기존의 HTML에서 form을 통해 데이터를 서버로 전달하던 방식은 Content-Type: application/x-www-form-urlencoded의 방식이다.

이 방식은 가장 기본적인 방법이기에, Form 태그에 별도의 enctype 옵션이 없으면 기본으로 사용한다.

또한 HTTP Body에 username=kim&age=20 와 같이 & 로 구분해서 전송한다.

 

하지만 파일을 업로드 하려면 파일은 문자가 아니기 때문에 바이너리 데이터를 전송해야 한다.

따라서 문자를 전송하는 방식으로는 파일을 전송하기 가 어렵다.

 

더 나아가 보통 파일을 전송할때는 파일만 전송하는것이 아니라는 문제도 있다.

이름, 나이, 사진(첨부파일) 등이 동시에 전송되야 한다. 즉, 문자와 바이너리 데이터를 동시에 전송해야 한다.

 

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

 

출처 - 인프런 김영한 스프링 MVC2

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

multipart 방식의 HTTP Body를 보면 -----XXX 로 여러 part가 나뉘어져 있다.

각 파트마다 해당되는 데이터에 대한 메타 정보와, 데이터 자체를 담고 있다.

 

이렇게 각각의 항목을 구분하여 한번에 전송하는 것 이다.

 

2. 서블릿과 파일 업로드1

서블릿을 통하여 파일 업로드 하는 과정을 살펴보자!

 

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

 

컨트롤러에 GetMapping시 처음 보여주는 화면 "upload-form"은 다음과 같다.

실행전에 application.properties 에 다음과 같이 설정해 주자.

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

 

이제 상품명과 파일을 추가하여 전송버튼을 눌러보자! 로그에는 다음과 같이 남게된다.

녹색 박스를 보면 각 각의 part로 나뉘어 진다. multiPart로 나뉘어진 것 이다.

 

위에는 상품명 Spring이 전달되고, 아래 박스에는 PNG 사진이 전달된다. 그 아래 이상한 특수문자들은 사진의 바이너리 데이터 이다!

 

● 업로드 사이즈 제한

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

 

위와같이 파일 사이즈를 제한할수 있다.

 

- max-file-size : 파일 하나의 최대 사이즈, 기본 1MB

- max-request-size : 멀티파트 요청 하나에 여러 파일을 업로드 할 수 있는데, 그 전체 합이다. 기본 10MB

 

● spring.servlet.multipart.enabled 끄기

spring.servlet.multipart.enabled=false

 

위와같이 멀티파트 기능을 끌수도 있다.

이렇게 멀티파트 기능을 끄고 이전과 같이 파일을 보낸다면, request.getParameter("itemName") , request.getParts() 의 결과가 비어게 된다.

- HttpServletRequest 객체가 RequestFacade 이다.

 

기본은 true로 켜있는 상태이다. 따라서 별다른 설정을 안하면 request.getParameter("itemName") 으로 원하는 결과를 갖어올수가 있다.

- HttpServletRequest 객체가 StandardMultipartHttpServletRequest 이다.

 

3. 서블릿과 파일 업로드 2

mac에서 결로로 이동하기 cmd + shift + G

 

서블릿의 기능을 사용하여 파일을 서버에 업로드 해보자!

 

먼저 파일을 저장하기 위해서는 저장할 경로가 필요하다. application.propterties를 통해 파일을 저장할 폴더 경로를 지정해 두자.

file.dir=/Users/zbqmgldjfh/study/file/

 

이제 V2 버전의 컨트롤러를 만들어 보자.

 

● 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 saveFileV2(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));
            }

            // 편의 메서드
            log.info("submittedFilename={}", part.getSubmittedFileName());
            log.info("size={}", part.getSize());

            // 데이터 읽기
            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}")
private String fileDir;

 

이제 fileDir 이라는 변수로 파일경로를 사용할수 있게되었다.

 

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

각각의 Part를 돌면서 이름, 헤더정보 등을 출력하였다. 다음 결과를 확인해 보자.

body정보까지 출력한 후, 최종적으로 file을 저장했다.

// 파일 저장하기
if(StringUtils.hasText(part.getSubmittedFileName())){
    String fullPath = fileDir + part.getSubmittedFileName();
    log.info("파일 저장 fullPath={}", fullPath);
    part.write(fullPath);
}

 

● Part 주요 메서드

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

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

- part.write(...): Part를 통해 전송된 데이터를 저장할 수 있다.

 

파일이 지정했던 폴더에 저장되는것을 확인할 수 있다.

 

4. 스프링과 파일 업로드

스프링은 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("itemNmae={}", 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 을 동일하게 사용할 수 있다.

 

MultipartFile 주요 메서드

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

- file.transferTo(...) : 파일 저장