Spring - 파일 업로드

- HTML 폼 전송 방식

1. application/x-www-form-urlencoded

2. multipart/form-data

 

- 문자와 바이너리를 동시에 전송하기 위해서 HTTP는 "multipart/form-data"라는 전송 방식을 제공한다.

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

<form th:action method="post" enctype="multipart/form-data">

---

- 파일을 업로드하기 위해 실제 파일이 저장되는 경로가 필요하다.

 

- application.properties

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

- 주의

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

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

 

---

- 서블릿을 이용한 파일 업로드 세부사항 알아보기

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

    @Value("${file.dir}")
    private String fileDir;
// 파일이 디렉토리 경로를 지정하고 @Value를 통해 경로를 가져온다.

    @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()); //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);
            }
            inputStream.close();
        }
        return "upload-form";
    }
}

- application.properties 에서 설정한 file.dir 의 값을 주입한다.

 

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

- 서블릿이 제공하는 Part 는 멀티파트 형식을 편리하게 읽을 수 있는 다양한 메서드를 제공한다.

 

- Part 주요 메서드

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

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

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

---

- 스프링과 파일 업로드

 

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

@Slf4j
@Controller
@RequestMapping("/spring")
public class SpringUploadController {

    @Value("${file.dir}")
    private String fileDir;
    // application.propterties에 작성한 경로를 가져온다.

    @GetMapping("/upload")
    public String newFile() {
        return "upload-form";
    }
    // 해당 경로로 들어가면 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);
        // MultipartFile 인터페이스를 RequestParam으로 받아온다.

        if (!file.isEmpty()) {
            String fullPath = fileDir + file.getOriginalFilename(); // 업로드 파일 명
            //첨부파일에 파일명이 있을 것이기 때문에 해당 파일명을 포함한 전체 경로를 지정한다.
            log.info("파일 저장 fullPat={}", fullPath);
            file.transferTo(new File(fullPath)); // 파일을 저장하는 메서드
        }

        return "upload-form";
    }
}

---

- 예제로 구현하는 파일 업로드, 다운로드

 

- 요구사항

1. 상품을 관리

   1. 상품 이름

   2. 첨부파일 하나

   3. 이미지 파일 여러개

2. 첨부파일을 업로드 다운로드 할 수 있다.

3. 업로드한 이미지를 웹 브라우저에서 확인할 수 있다.

---

- Item - 상품 도메인

@Data
public class Item {

    private Long id;
    private String itemName;
    private UploadFile attachFile;
    private List<UploadFile> imageFiles;
}

 

- ItemRepository - 상품 리포지토리

@Repository
public class ItemRepository {

    private final Map<Long, Item> store = new HashMap<>();
    private long sequence = 0L;

    public Item save(Item item){
        item.setId(++sequence);
        store.put(item.getId(), item);
        return item;
    }

    public Item findById(Long id) {
        return store.get(id);
    }
}

 

- 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;
    }
    //파일명까지 포함된 FullPath의 경로를 저장한다.

    public List<UploadFile> storeFiles(List<MultipartFile> multipartFiles) throws IOException {
        List<UploadFile> storeFileResult = new ArrayList<>();
        //UploadFile를 참조형으로 하는 List storeFileResult를 생성한다.
        for (MultipartFile multipartFile : multipartFiles) {
        //여러개의 파일이 넘어오게 되면 for문을 통해 파일들을 리스트에 저장한다.
            if (!multipartFiles.isEmpty()) {
                UploadFile uploadFile = storeFile(multipartFile);
                // 아래 작성한 storeFile 메서드를 통해 파일들을 업로드 하기 위한 형태로 변환 시킨다.
                storeFileResult.add(uploadFile);
                // storeFileResult에 파일을 저장한다.
            }
        }
        return storeFileResult;
    }


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

        String originalFilename = multipartFile.getOriginalFilename();
        // 파일명을 가져온다.
        String storeFileName = createStoreFileName(originalFilename);
        // createStoreFileName 메서드를 통해 저장하기위한 파일 경로를 새롭게 생성한다.
        // 파일명이 동일할 수 있기 때문에 동일 파일명이 발생하지 않게하기 위해서다.
        multipartFile.transferTo(new File((getFullPath(storeFileName))));
        // 해당 경로에 파일의 내용을 저장한다.
        return new UploadFile(originalFilename, storeFileName);
        //파일의 원본이름과 저장용 이름을 함께 UploadFile 경로에 저장한다.

    }

    private String createStoreFileName(String originalFilename) {
        String uuid = UUID.randomUUID().toString();
        String ext = extractExt(originalFilename);
        return uuid + "." + ext;
        //uuid를 새롭게 생성하여 확장자명을 포함한 고유의 번호를 생성한다.
    }

    private String extractExt(String originalFilename) {
        int pos = originalFilename.lastIndexOf(".");
        return originalFilename.substring(pos + 1);
        // 확장자를 가져오기 위한 메서드이다.
    }
}

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

1. createStoreFileName() : 서버 내부에서 관리하는 파일명은 유일한 이름을 생성하는 UUID 를 사용해서 충돌하지 않도록 한다.

2. 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;
}

- 상품 저장용 폼이다.

- List<MultipartFile> imageFiles : 이미지를 다중 업로드 하기 위해 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";
        // 해당 경로로 요청이 들어오면 form을 보여준다.
    }

    @PostMapping("/items/new")
    public String saveItem(@ModelAttribute ItemForm form, RedirectAttributes
            redirectAttributes) throws IOException {
            // form을 통해 넘어온 값들을 ItemForm 객체에 값이 저장되고 
            // ModelAttribute를 통해 모델에 저장된다.
        UploadFile attachFile = fileStore.storeFile(form.getAttachFile());
        //form을 통해 넘어온 단일 파일들을 저장한다.
        List<UploadFile> storeImageFiles = fileStore.storeFiles(form.getImageFiles());
        //form을 통해 넘어온 다중 파일들을 저장한다.
        
        //데이터베이스에 저장
        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}";
        //데이터베이스에 저장하고 리다이렉트를 통해 클라이언트에게 새로운 URI를 응답해준다.
    }

    @GetMapping("/items/{id}")
    public String items(@PathVariable Long id, Model model) {
        Item item = itemRepository.findById(id);
        //Repository에 저장된 id에 대응하는 Item 객체를 가져온다. 
        model.addAttribute("item", item);
        //해당 객체를 model에 담아서 View에 전달한다.
        return "item-view";
    }

    @ResponseBody
    @GetMapping("/images/{filename}")
    public Resource downloadImage(@PathVariable String filename) throws MalformedURLException {
        return new UrlResource("file:" + fileStore.getFullPath(filename));
        //item-view에서 src를 통해 호출된 파일을 경로를 호출하여 파일을 불러오는 역할을 한다.
    }

    @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)
                //CONTENT_DISPOSITION을 통해 첨부파일을 다운받는 용도로 사용할 수 있다.
                // 이게 없으면 그냥 웹에 파일의 내용을 그대로 내보낸다
                .body(resource);
                // 내용은 body를 통해 실제 파일을 불러온다.
    }
}

- @GetMapping("/items/new") : 등록 폼을 보여준다.
- @PostMapping("/items/new") : 폼의 데이터를 저장하고 보여주는 화면으로 리다이렉트 한다.
- @GetMapping("/items/{id}") : 상품을 보여준다.
- @GetMapping("/images/{filename}") : <img> 태그로 이미지를 조회할 때 사용한다. UrlResource로 이미지 파일을 읽어서 @ResponseBody 로 이미지 바이너리를 반환한다.
- @GetMapping("/attach/{itemId}") : 파일을 다운로드 할 때 실행한다. 예제를 더 단순화 할 수 있지만,파일 다운로드 시 권한 체크같은 복잡한 상황까지 가정한다 생각하고 이미지 id 를 요청하도록 했다. 파일다운로드시에는 고객이 업로드한 파일 이름으로 다운로드 하는게 좋다. 이때는 Content-Disposition 해더에 attachment; filename="업로드 파일명" 값을 주면 된다.

 

- item-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>
    <form th:action method="post" enctype="multipart/form-data">
        <ul>
            <li>상품명 <input type="text" name="itemName"></li>
            <li>첨부파일<input type="file" name="attachFile" ></li>
            <li>이미지 파일들<input type="file" multiple="multiple" name="imageFiles" ></li>
        </ul>
        <input type="submit"/>
    </form>
</div> <!-- /container -->
</body>
</html>

 

- item-view.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>
    상품명: <span th:text="${item.itemName}">상품명</span><br/>
    첨부파일: <a th:if="${item.attachFile}" th:href="|/attach/${item.id}|" th:text="${item.getAttachFile().getUploadFileName()}" /><br/>
    <img th:each="imageFile : ${item.imageFiles}" th:src="|/images/${imageFile.getStoreFileName()}|" width="300" height="300"/>
</div> <!-- /container -->
</body>
</html>

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

출처 : 인프런 - 우아한 형제들 기술이사 김영한의 스프링 완전 정복 (스프링 핵심원리 - 기본 편)