스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 20

인프런 강의 58일차.

 - 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 1 (김영한 강사님)

 - 1편에서 배운 MVC를 활용할 수 있는 기술 습득

 - 타입 컨버터, 파일 업로드, 활용, 쿠키, 세션, 필터, 인터셉터, 예외 처리, 타임리프, 메시지, 국제화, 검증 등등

 

 11.1 파일 업로드 - 파일 업로드 소개

  - HTML Form을 통한 파일 업로드를 이해하려면 먼저 폼을 전송하는 두 가지 방식의 차이를 이해해야 한다.

 

 * HTML 폼 전송 방식

  - application/x-www-form-urlencoded

  - multipart/form-data

 

application/x-www-form-urlencoded 방식

  - application/x-www-form-urlencoded 방식은 HTML 폼 데이터를 서버로 전송하는 가장 기본적인 방법이다.

  - Form 태그에 별도의 enctype 옵션이 없으면 웹 브라우저는 요청 HTTP 메시지의 헤더에 다음 내용을 추가한다.

    > Content-Type: application/x-www-form-urlencoded

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

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

  - 문자를 전송하는 이 방식으로 파일을 전송하기는 어렵다.

  - 그리고 또 한가지 문제가 더 있는데, 보통 폼을 전송할 때 파일만 전송하는 것이 아니라는 점이다

    > ex) 이름, 나이, 첨부파일 전송...

  - 문제는 이름과 나이는 문자로 전송하고, 첨부파일은 바이너리로 동시에 전송해야 한다는 점이다. 

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

 

multipart/form-data 방식

  - 사용방식 : Form 태그에 별도의 enctype="multipart/form-data" 를 지정해야 한다

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

  - 폼의 입력 결과로 생성된 HTTP 메시지를 보면 각각의 전송 항목이 구분이 되어있다.

    > ContentDisposition 이라는 항목별 헤더가 추가되어 있고 여기에 부가 정보가 있다.

    > 예제에서는 username , age , file1 이 각각 분리되어 있다

    > 폼의 일반 데이터는 각 항목별로 문자가 전송된다

    > 파일의 경우 파일 이름과 Content-Type이 추가되고 바이너리 데이터가 전송된다

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

 

 * Part

  - multipart/form-data 는 application/x-www-form-urlencoded 와 비교해서 매우 복잡하고 각각의 부분( Part )로 나누어져 있다. 그렇다면 이렇게 복잡한 HTTP 메시지를 서버에서 어떻게 사용할 수 있을까?

 

 11.2 파일 업로드 - 프로젝트 생성

  - https://start.spring.io

  - 프로젝트 선택 Project : Gradle Project

  - Language : Java

  - Spring Boot : 2.7.0

  - Group : hello

  - Artifact : upload

  - Name : upload

  - Package name : hello.upload

  - Packaging : Jar

  - Java : 11

  - Dependencies : Spring Web, Thymeleaf, Lombok

* gradle.build 실행 후 아래 오류 발생 시 gradle-wrapper.properties에서 gradle 버전을 6.9 이하로 변경해서 다운로드하자. (gradle-6.9-all.zip)

 > Unable to find method 'org.gradle.api.artifacts.result.ComponentSelectionReason.getDescription()Ljava/lang/String;'. Possible causes for this unexpected error include: Gradle's dependency cache may be corrupt (this sometimes occurs after a network connection timeout.) Re-download dependencies and sync project (requires network)

 

 11.3 파일 업로드 - 서블릿과 파일 업로드1

  - 서블릿을 통한 파일 업로드를 코드와 함께 알아보자.

 

package hello.upload.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
import java.io.IOException;
import java.util.Collection;

@Slf4j
@Controller
@RequestMapping("/servlet/v1")
public class ServletUploadControllerV1 {

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

    @PostMapping("/upload")
    public String saveFileV1(HttpServletRequest request) throws IOException, ServletException {
        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";
    }
}

 - hello.upload.controller.ServletUploadControllerV1.java

 - multipart/form-data를 처리하기 위한 컨트롤러 생성

 - request.getParts()메소드는 multipart/form-data 전송 방식에서 나누어진 부분을 받아서 확인할 수 있다

 

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

 - application.properties

 - 서버에 로그를 남기기 위해 debug 옵션 추가

 - 이 옵션을 사용하면 HTTP 요청 메시지를 서버 로그에서 확인할 수 있다.

 - 실행해보면 multipart/formdata 방식으로 전송된 것을 확인할 수 있다.

 

 * 실행 결과 로그

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

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

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

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

sadaaa...

 - 실행 시 -----x로 나뉘어졌음을 확인할 수 있다.

 

 * multipart 용량 처리 옵션

#파일 용량 옵션
spring.servlet.multipart.max-file-size=1MB
spring.servlet.multipart.max-request-size=10MB

# multipart 사용여부 옵션
spring.servlet.multipart.enabled=false

 - application.properties

 - 업로드 사이즈 제한 옵션 추가

 - 사이즈를 넘으면 예외( SizeLimitExceededException )가 발생한다

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

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

 

 * multipart 사용여부 옵션 

 - 멀티파트는 일반적인 폼 요청인 application/x-www-form-urlencoded 보다 훨씬 복잡하다.

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

 -  multipart 사용 false 후 실행 시 아래 로그가 표시된다.

   > request=org.apache.catalina.connector.RequestFacade@xxx

   > itemName=null

   > parts=[]

   > 결과 로그를 보면 RequestFacade가 사용되며, request.getParameter("itemName") , request.getParts() 의 결과가 비어있다.  

 -  multipart 사용 true 후 실행 시 아래 로그가 표시된다.

   > request=org.springframework.web.multipart.support.StandardMultipartHttpServletR equest

   > itemName=Spring

   > parts=[ApplicationPart1, ApplicationPart2]

   > 결과 로그를 보면 HttpServletRequest 객체가 RequestFacade -> StandardMultipartHttpServletRequest 로 변한 것을 확인할 수 있다

 

 * 참고 

  - spring.servlet.multipart.enabled 옵션을 켜면 스프링의 DispatcherServlet 에서 멀티파트 리졸버( MultipartResolver )를 실행한다.

  - 멀티파트 리졸버는 멀티파트 요청인 경우 서블릿 컨테이너가 전달하는 일반적인 HttpServletRequest 를 MultipartHttpServletRequest 로 변환해서 반환한다.

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

  - 스프링이 제공하는 기본 멀티파트 리졸버는 MultipartHttpServletRequest 인터페이스를 구현한 StandardMultipartHttpServletRequest 를 반환한다.

  - 이제 컨트롤러에서 HttpServletRequest 대신에 MultipartHttpServletRequest 를 주입받을 수 있는데, 이것을 사용하면 멀티파트와 관련된 여러가지 처리를 편리하게 할 수 있다.

  - 그런데 이후 강의에서 설명할 MultipartFile 이라는 것을 사용하는 것이 더 편하기 때문에 MultipartHttpServletRequest 를 잘 사용하지는 않는다.

  - 더 자세한 내용은 MultipartResolver 를 검색해보자.

 

 11.4 파일 업로드 - 서블릿과 파일 업로드2

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

  - 먼저 파일을 업로드를 하려면 실제 파일이 저장되는 경로가 필요하다.

  - 해당 경로에 실제 폴더를 만들고 default 경로를 입력해두자.

 

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

 - application.properties

 - 파일 업로드 경로 추가

   > 꼭 해당 경로에 실제 폴더를 미리 만들어두자.

   > application.properties 에서 설정할 때 경로 마지막에 / (슬래시)가 포함된 것에 주의하자

 

package hello.upload.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Collection;

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

	//application.properties에 설정한 file.dir의 값을 주입한다.
    @Value("${file.dir}")
    private String fileDir;

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

    @PostMapping("/upload")
    public String saveFileV1(HttpServletRequest request) throws IOException, ServletException {
        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());
            
            //Part 정보 출력
            Collection<String> headerNames = part.getHeaderNames();
            for (String headerName : headerNames) {
                log.info("header {} : {}", headerName, part.getHeader(headerName));
            }
            
            //편의 메소드 제공
            //content-disposition에 제공된 정보 get 가능
            //filename = part.getSubmittedFileName() 으로 획득
            log.info("getSubmittedFileName = {}", 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";
    }
}

 - hello.upload.controller.ServletUploadControllerV2.java

 - 멀티파트 형식은 전송 데이터를 하나하나 각각 부분( 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=D:/Study/upload/teststudy/스크린샷.png

 - 전송한 내용

   > itemName : 상품A

   > file : 스크릿샷.png

 - 파일 저장 경로에 가보면 실제 파일이 저장된 것을 확인할 수 있다. 

 - 서블릿이 제공하는 Part 는 편하기는 하지만, HttpServletRequest 를 사용해야 하고, 추가로 파일 부분만 구분하려면 여러가지 코드를 넣어야 한다.

 

 * 참고

  - 큰 용량의 파일을 업로드를 테스트 할 때는 로그가 너무 많이 남아서 다음 옵션을 끄는 것이 좋다.

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

  - body 출력도 파일의 바이너리 데이터를 모두 출력하므로 끄는 것이 좋다.

    > log.info("body={}", body);

 

 11.5 파일 업로드 - 스프링과 파일 업로드

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

package hello.upload.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;

@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));    //파일을 fullPath 경로에 저장
        }

        return "upload-form";
    }
}

 - hello.upload.controller.SpringUploadController.java

 - 스프링 답게 딱 필요한 부분의 코드만 작성하면 된다

 - @RequestParam MultipartFile file 업로드하는 HTML Form의 name에 맞추어 @RequestParam 을 적용하면 된다.

 - @ModelAttribute 에서도 MultipartFile 을 동일하게 사용할 수 있다.

 

 * 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=D:/Study/upload/teststudy/스크린샷.png

 - 전송한 내용

   > itemName : 상품A

   > file : 스크릿샷.png

 - StandardMultipartFile 이 호출됨을 확인