Spring File 업로드 및 다운로드

Multipart

Multipart Request 예시

• Multipart란 파일업로드시 사용하는 enctype으로 , 하나의 요청에 대해 데이터를 전달하기 위한 공간을 여러개의 파트로 나눈 후 나눈 공간에 각 각의 데이터를 저장하여 요청을 보내는 기법이다.

• multipart 예시

POST /upload HTTP/1.1
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary

------WebKitFormBoundary
Content-Disposition: form-data; name="title"

제목입니다
------WebKitFormBoundary
Content-Disposition: form-data; name="file"; filename="sample.jpg"
Content-Type: image/jpeg

[바이너리 데이터...]
------WebKitFormBoundary--

• Multipart는 전달할 수 있는 데이터 타입에 File과 같은 바이너리 데이터를 저장하여 요청을 보낼 수 있어서 파일 업로드시 사용된다.

form태그의 기본 enctype은 application/x-www-form-urlencoded 이다.

이 설정은 text형태의 문자열데이터만 전달이 가능하며 바이너리데이터 전송을 지원하지 않는다. 따라서 파일업로드 기능을 이용하려면 form태그의 enctype을 multipart방식으로 수정해줘야한다.

<form enctype="multipart/form-data" >

input:file, input:text등 사용 가능

</form>

• 스프링의 매개변수 자동 데이터 바인딩 기능은 Multipart방식으로 들어온 요청에 대한 바인딩처리는 기본설정으로 지원하지 않는다.

• 스프링은 위와 같은 multipart방식의 요청을 처리하기 위한 클래스로 MultipartResolver라는 인터페이스를 제공하고 있으며 수업에서는 해당 인터페이스를 구현한 다양한 의존성 중 보편적으로 많이 사용되는 CommonsMultipartResolver 의존성을 통해 파일 업로드 기능을 구현할 것이다

Multipart방식의 요청을 처리하기 위한 설정(파일 업로드)

1) pom.xml설정

• CommonsMultipartResolver사용을 위한 구현체 추가

-- pom.xml파일 내부 --
<!-- 1) commons-fileupload
        파일 업로드를 위한 의존성(CommonsMultipartResolver 구현체)
-->
<!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.4</version>
</dependency>

<!-- 2) commons-io  
        파일 다운로드를 위한 의존성 
-->
<!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.11.0</version>
</dependency>

2) root-context.xml

• multipartResolver 빈 객체추가

<!-- 스프링 컨테이너는 Multipart요청 처리시  bean id 기준으로 multipartResolver라는 이름의
     객체가 존재하는지 찾는다. 이때 bean의 id에 오타가 있을 경우 multipartResolver가 없다고
     생각하고 프로세스가 진행되므로 "정확히" 타이핑해야한다. -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
 	<!--  인코딩 처리 -->
 	<property name="defaultEncoding" value="UTF-8"></property>
 	<!-- 
 		maxUploadSize : 한번에 업로드 되는 파일의 총 용량 설정 
 		maxInMemorySize : 디스크에 임시파일을 생성하기전에 메모리에 보관시킬 
                                  최대 바이트 크기. 이 크기를 벗어나면 드라이브에 보관한다.
 	 -->
 	 <property name="maxUploadSize"   value="10000000"></property>
 	 <property name="maxInMemorySize" value="10000000"></property>
 </bean>

3) HTML설정

<!--  enctype에 오타가 나지 않게끔 조심할것 -->
<form action="insert" method="post" enctype="multipart/form-data">
    <input type="file" name="upfile">
</form>

4) Controller 설정

@PostMapping("/insert")
public String insertBoard(
	@RequestParam(value="upfile" , required = false ) MultipartFile upfile , 
	) {

• dispatcherServlet은 클라이언트의 요청이 multipart/form-data인 경우 MultipartResolver를 통해 요청 내용을 파싱한다.

• 파싱은 HttpServletRequest객체를 MultipartRequest객체로 변환시키는 과정을 의미하며 MultipartRequest는 HttpServletRequest을 상속받아 파일 업로드에 대한 기능만 추가한 클래스이다.

• 파싱과정이 완료되면 서버는 전달받은 파일객체를 메모리에 임시 보관해 두었다가@RequestParam(value="upfile" , required = false ) MultipartFile upfile 에 보관중인 파일객체를 전달해준다. (MultipartFile은 http통신으로 전송된 파일을 처리하기위한 객체로 다양한 메서드를 가지고 있다)

5) 파일시스템에 파일 저장

• 파일저장은 메모리에 4번과정에서 얻어온 MultipartFile 객체를 통해서 진행될 것이며 , 저장시키기 위해서는 저장하고자하는 디렉토리 경로와 저장할 파일명이 추가로 필요하다.

• 디렉토리 경로는 정해진 규칙에 따라 작성하면 될것이다. EX) 게시판의 이미지를 저장하는 URL -> 프로젝트경로/resources/images/게시판/

• 저장할 파일명은 디렉토리 내에서 겹치지 않는 고유한 이름이 들어갈 수 있도록반드시 변경해줘야 한다. (하나의 디렉토리에 동일한 이름으로 파일이 들어가게 된다면 에러가 발생하기 때문)

//파일 저장 메서드
//MultipartFile의 transferTo 메서드를 통해 메모리에 보관중인 데이터를 파일 시스템의 드라이브로
//이동시킨다. 매개변수로는 디렉토리경로(마지막 위치에 /가 포함된) + 저장할 파일명이 들어간다.
upfile.transferTo(new File(디렉토리경로+저장할 파일명));

MultipartFile의 주요 메서드

반환형 메서드명	설명
String getName()	파라미터로 전달된 이름
String getOriginalFilename()	업로드 되는 파일의 이름
boolean isEmpty()	파일이 존재하는지 여부
long getSize()	업로드되는 파일의 크기
byte[] getBytes()	byte[]로 파일 데이터 반환
inputStream getInputStream()	파일데이터와 연결된 inputStream을 반환
transferTo(File file)	파일저장

6) 저장이후

• 서버의 파일시스템상에 첨부파일이 잘 등록 되었다면 핵심 업무로직에 맞춰서 비지니스 로직을 구상하면 된다. 보편적으로는 저장된 데이터를 관리하기 위해 db에 값을 기록해둘 것이다.

---

파일 다운로드

스프링 파일 다운로드 기능 요청 흐름

1. 클라이언트가 File Down요청을 보낸다

2. 요청을 처리할 컨트롤러의 Handler(메서드)는 클라이언트의 요청시 전달한 데이터를 바탕으로 어플리케이션에서 적절한 file을 load한다.

3. load한 파일을 클라이언트에게 출력스트림을 이용하여 직접 응답한다.

• 위 처리 흐름에서 주목할 점은 클라이언트에게 File을 직접 응답하는 부분이다. Spring Mvc 프로젝트는 View Resolver가 클라이언트의 응답화면 처리를 담당하는데 이를 무시하고 클라이언트에게 바로 파일을 전달하는게 포인트이다.

클라이언트의 File Down요청

<H1>첨부파일</h1>
<button type="button"
onclick="location.href='${contextPath}/board/fileDownload/${board.boardNo }'">
	${board.originName} - 다운로드
</button>
// 다운로드 받고자 하는 정보를 URL로 전달

서버의 File Down로드 처리 Handler

• 클라이언트가 요청한 파일을 검색

@GetMapping("/fileDownload/{boardNo}")
public ResponseEntity<Resource> fileDownload(@PathVariable("boardNo") int boardNo) {
	ResponseEntity<Resource> responseEntity = null;
	// db에서 board테이블에서 boardNo값과 일치하는 행의 파일정보 조회
	BoardExt b = boardService.selectBoard(boardNo);
	// 파일이 없는경우 응답상태 404로 설정후 반환
	if(b.getOriginName() == null) {
		return responseEntity.notFound().build();
	}
	...
}

ResouceLoader를 활용한 File load

ResouceLoader?

ResponseEntity를 활용한 File 응답

ResponseEntity