RE-Heat 개발자 일지

스프링 MVC 2편 - [11] 파일 업로드 본문

백엔드/스프링

스프링 MVC 2편 - [11] 파일 업로드

RE-Heat 2023. 7. 29. 18:16

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

 

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

웹 애플리케이션 개발에 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. MVC 2편에서는 MVC 1편의 핵심 원리와 구조 위에 실무 웹 개발에 필요한 모든 활용 기술들을 학습할 수 있

www.inflearn.com

인프런 김영한님의 스프링 MVC 2편 강의를 토대로 정리한 내용입니다.

 

[1] 파일 업로드 소개

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

 

■ HTML Form 폼 전송방식 

  • application/x-www-form-urlencoded 
  • multipart/form-data

 

① application/x-www-form-unlencoded

HTML 폼 데이터를 서버로 전송하는 가장 기본적인 방법이다. Form 태그에 별도의 enctype(encoding type) 옵션이 없으면 웹 브라우저는 요청 HTTP 메시지의 헤더에 Content-Type: application/x-www-form-urlencoded를 추가한다.

 

폼에 입력한 전송항목은 HTTP Body에 기입되며 &로 구분해 전송한다. key=value&key=value 

 

여기서 문제는 파일은 기존의 문자가 아닌 '바이너리 데이터'로 전송해야 한다는 점이다. 그리고 보통 폼 전송에는 문자와 바이너리를 같이 전송하는 경우가 많다.

 

예시

- 이름

- 나이

- 첨부파일

 

여기서 이름과 나이는 문자, 첨부파일은 바이너리로 전송해야 한다. 그러면 문자와 첨부파일을 동시에 전송해야 해 기존의 application/x-www-form-unrlencoded로 전송할 수 없다. 그래서 HTTP는 multipart/form-data라는 전송방식을 제공한다.

 

② multipart/form-data

이 방식을 사용하라면 Form태그에 별도로 enctype="mulitpart/form-data"를 지정해야 한다. (default값은 application/x-www-form-unrlencoded)

 

이 폼의 결과로 입력된 HTTP 메시지를 보면 Content-Dispostion이라는 항목별 데이터가 추가돼 있고 부가 정보도 있다. 위에선 username, age, file1로 구분돼 있으며 파일의 경우 파일의 Content-Type과 바이너리 데이터가 있는 것을 확인할 수 있다.

 


[2] 프로젝트 생성

스프링부트 버전을 2.4.5로 맞춰야 [4] 서블릿과 파일 업로드 2에서 오류가 발생하지 않는다.

 

파일 업로드 오류 관련 인프런 답변 링크

필자의 경우 스프링부트의 버전을 2.7.14로 맞춰 오류가 발생했으며 build.gradle에서 강의 자료에 제시된 2.4.5로 바꿔주자 오류가 해결됐다.

 

버전을 바꿔준 후 코끼리 refresh 아이콘을 눌러주는 걸 잊지 말자

 

 

[3] 서블릿과 파일 업로드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";
    }
}

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

 

 

upload-form.html

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
</head>
<body>
<div class="container">
    <div class="py-5 text-center">
        <h2>상품 등록 폼</h2>
    </div>
    <h4 class="mb-3">상품 입력</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> <!-- /container -->
</body>
</html>

① Form태그에 enctype="multipart/form-data"를 지정해야 한다.

 

application.properties

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

=> 이 옵션을 사용하면 HTTP 요청 메시지를 확인할 수 있다.

 

 

결과로그

 

■ 멀티파트 사용 옵션

업로드 사이즈 제한

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

파일을 제한 없이 업로드하게 할 수없으므로 업로드 사이즈를 제한할 수 있다.

지정한 사이즈를 넘으면 SizeLimitExceededException 예외가 발생한다.

 

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

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

 

■ spring.servlet.multipart.enabled

이 옵션을 false로 지정하면 서블릿 컨테이너는 멀티파트 관련 처리를 하지 않는다. 기본값은 true

 

① spring.servlet.mulitpart.enabled=false

서블릿이 멀티파트를 처리하지 않게 하면 request.getParameter("itemName"), request.getParts()의 결과가 비어있는 걸 알 수 있다.

 

② spring.servlet.mulitpart.enabled=true (기본 true)

로그를 보면 request ①RequestFacade가 ②StandardMultipartHttpServletRequest로 변한 것을 확인할 수 있다.

 

 참고]  spring.servlet.multipart.enabled 옵션을 켜면 스프링의 DispatcherServlet에서 멀티파트 리졸버( MultipartResolver )를 실행한다. 멀티파트 리졸버는 멀티파트 요청인 경우 서블릿 컨테이너가 전달하는 일반적인 HttpServletRequest를 MultipartHttpServletRequest로 변환해서 반환한다.

 

이후 강의에서 사용할 MultipartFile을 사용하는 게 편리하므로 MultipartHttpServletRequest는 잘 사용되지 않는다.

 


[4] 서블릿과 파일 업로드2

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

 

■ 실제 파일이 저장되는 경로를 설정

application.properties

file.dir = 실제 경로 예시 /Users/kimyounghan/study/file/

=> 백 슬래시가 아니다.

 

주의점

1. 해당 경로에 폴더를 만들어 둬야 한다.

2. 경로 설정 시 마지막엔 꼭 /를 달아야 한다.

 

 

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

            //데이터 읽기
            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}")로 application.properties에 설정한 값을 주입

② 멀티파트 형식에선 전송데이터를 각각 부분으로 나누어 전송한다. Part엔 이렇게 나누어진 데이터가 담기며 서블릿이 제공하는 Part는 멀티파트 형식을 편리하게 읽을 수 있는 다양한 메서드를 제공한다.

 

Part 주요 메서드

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

 

실행로그

 

 

[5] 스프링과 파일 업로드

스프링은 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("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

    업로드하는 HTML Form의 이름에 맞춰 @RequestParam에 적용하면 된다.

    @ModelAttribute에서도 MultipartFile을 사용할 수 있다.

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

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

 

 

실행로그

 

 

[6] 예제로 구현하는 파일 업로드, 다운로드

목표 : 실제 파일을 업로드 후 다운로드까지 받아보자

 

요구사항

  • 상품을 관리
    • 상품 이름
    • 첨부파일 하나
    • 이미지 파일 여러 개
  • 첨부파일을 업로드 다운로드 할 수 있다.
  • 업로드한 이미지를 웹 브라우저에서 확인할 수 있다.

 

Item - 상품 도메인

@Data
public class UploadFile {
    private String uploadFileName;
    private String storeFileName;

    public UploadFile(String uploadFileName, String storeFileName) {
        this.uploadFileName = uploadFileName;
        this.storeFileName = storeFileName;
    }
}


UploadFile - 업로드 파일 정보 보관

@Data
public class UploadFile {
    private String uploadFileName;
    private String storeFileName;

    public UploadFile(String uploadFileName, String storeFileName) {
        this.uploadFileName = uploadFileName;
        this.storeFileName = storeFileName;
    }
}

uploadFileName : 고객이 업로드한 파일명

storeFileName : 서버 내부에서 관리하는 파일명

 

고객이 업로드한 파일명이 겹칠 수 있으므로 서버에 저장할 파일명을 따로 지정해 준다. 

 

 

FileStore - 파일 저장과 관련된 업무 처리

@Component
public class FileStore {
    @Value("${file.dir}")
    private String fileDir;

    public String getFullPath(String fileName){
        return fileDir + fileName;
    }

    public List<UploadFile> storeFiles(List<MultipartFile> multipartFiles) throws IOException {
        List<UploadFile> storeFileResult = new ArrayList<>();
        for (MultipartFile multipartFile : multipartFiles) {
            if(!multipartFile.isEmpty()){
                storeFileResult.add(storeFile(multipartFile));
            }
        }
        return storeFileResult;
    }

    public UploadFile storeFile(MultipartFile multipartFile) throws IOException {
        if (multipartFile.isEmpty()){
            return null;
        }

        String originalFilename = multipartFile.getOriginalFilename();
        String storeFileName = createStoreFileName(originalFilename);
        multipartFile.transferTo(new File(getFullPath(storeFileName)));

        return new UploadFile(originalFilename, storeFileName);
    }

    private String createStoreFileName(String originalFilename) {
        String uuid = UUID.randomUUID().toString();
        String ext = extractExt(originalFilename);//확장자명
        return uuid + "." + ext;
    }

    private String extractExt(String originalFilename) {
        int pos = originalFilename.lastIndexOf(".");
        return originalFilename.substring(pos+1);
    }

}

멀티파트 파일을 서버에 저장하는 역할을 담당

① createStoreFileName() : 서버 내부에서 관리하는 파일명은 UUID를 사용해 충돌하지 않도록 한다.

② extractExt() : 확장자를 별도로 추출해 서버 내부에서 관리하는 파일명에도 붙여준다. 

예시) a.png => 51041c62-86e4-4274-801d-614a7d994edb.png

 

 

ItemForm - 상품 저장용 폼

@Data
public class ItemForm {
    private Long itemId;
    private String itemName;
    private MultipartFile attachFile;
    private List<MultipartFile> imageFiles;
}

Item은 UploadFile, ItemForm은 MultipartFile을 쓰는 게 다르다.

List<MultipartFile> : 이미지 다중 업로드를 위해 MultipartFile을 사용

MultipartFile attachFile : 멀티파트는 @ModelAttribute에서도 사용 가능하다.

 

 

ItemController

@Slf4j
@Controller
@RequiredArgsConstructor
public class ItemController {

    private final ItemRepository itemRepository;
    private final FileStore fileStore;

    @GetMapping("/items/new")
    public String newItem(@ModelAttribute ItemForm form){
        return "item-form";
    }

    @PostMapping("/items/new")
    public String saveItem(@ModelAttribute ItemForm form, RedirectAttributes redirectAttributes) throws IOException {
        UploadFile attachFile = fileStore.storeFile(form.getAttachFile());
        List<UploadFile> storeImageFiles = fileStore.storeFiles(form.getImageFiles());

        //데이터베이스에 저장
        Item item = new Item();
        item.setItemName(form.getItemName());
        item.setAttachFile(attachFile);
        item.setImageFiles(storeImageFiles);
        itemRepository.save(item);

        redirectAttributes.addAttribute("itemId", item.getId());

        return "redirect:/items/{itemId}";
    }

    @GetMapping("/items/{itemId}")
    public String items(@PathVariable Long itemId, Model model){
        Item item = itemRepository.findById(itemId);
        model.addAttribute("item", item);
        return "item-view";
    }

    //이미지 보이게 하기
    @ResponseBody
    @GetMapping("/images/{filename}")
    public Resource downloadImage(@PathVariable String filename) throws MalformedURLException {
        //"file:/Users/../uuid.png"
        return new UrlResource("file:" + fileStore.getFullPath(filename));
    }

    //첨부파일 다운로드
    @GetMapping("/attach/{itemId}")
    public ResponseEntity<Resource> downloadAttach(@PathVariable Long itemId) throws MalformedURLException {
        Item item = itemRepository.findById(itemId);
        String storeFileName = item.getAttachFile().getStoreFileName();
        String uploadFileName = item.getAttachFile().getUploadFileName();

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

}

① @GetMapping("/items/new") : 등록폼을 보여준다.
② @PostMapping("/items/new") : 폼의 데이터를 저장하고 보여주는 화면으로 리다이렉트 한다. 
③ @GetMapping("/items/{itemId}") : 상품을 보여준다.
④ @GetMapping("/images/{filename}") : <img> 태그로 이미지를 조회할 때 사용한다. UrlResource로 이미지 파일을 읽어서 @ResponseBody로 이미지 바이너리를 반환한다.
⑤ @GetMapping("/attach/{itemId}") :

    - 파일을 다운로드할 때 실행한다.

    - 파일 다운로드 시 권한 체크 같은 복잡한 상황까지 가정한다 생각하고 이미지 id를 요청하도록 했다.

    - 파일 다운로드 시에는 고객이 업로드한 파일 이름으로 다운로드하는 게 좋다. (UTF-8)

    - Content-Disposition 헤더에 attachment; filename="업로드 파일명" 값을 주면 된다. ResponseEntity header에 전송.

Content-Dispostion에 attachment; filename="업로드 파일명"값을 줘야 브라우저에서 첨부파일을 다운로드하게 해준다.

 

 

item-form & item-view.html

① item-form.html

    1] 파일을 여러 개 업로드하려면 multiple="multiple" 옵션을 주면 된다.

② item-view.html

    첨부파일은 링크로 걸어두고 이미지는 <img>태그를 반복(th:each)해 출력한다.

 

 

실행화면

 

 

'백엔드 > 스프링' 카테고리의 다른 글

스프링 MVC 2편 - [10] 스프링 타입 컨버터  (0) 2023.07.28
스프링 MVC 2편 - [9] API 예외 처리  (0) 2023.07.27
스프링 MVC 2편 - [8] 예외 처리와 오류 페이지  (0) 2023.07.26
스프링 MVC 2편 - [7] 로그인 처리 2 - 필터·인터셉터  (0) 2023.07.22
스프링 MVC 2편 - [6] 로그인 처리 1 - 쿠키·세션(하편)  (0) 2023.07.21
'백엔드/스프링' Related Articles more