3 분 소요


파일 업로드, 다운로드 구현

요구 사항

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

상품 도메인

Item

@Data
public class Item {
    private Long id;
    private String itemName;
    private UploadFile attachFile;  // 첨부파일
    private List<UploadFile> imageFiles;  // 여러 이미지 파일
}

상품 Repository

ItemRepository는 save, findById가 예전과 동일하기 때문에 생략

업로드 파일 정보 보관

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 ext = extractExt(originalFilename);
        String uuid = UUID.randomUUID().toString();
        return uuid + "." + ext;
    }

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

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

  • createStoreFileName(): 서버 내부에서 관리하는 파일명은 UUID를 사용해서 충돌하지 않도록 한다.
  • extractExt(): 확장자를 별도로 추출해서 서버 내부에서 관리하는 파일명에도 붙여준다.

상품 저장용 폼

ItemForm

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

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

    @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.setImageFiles(storeImageFiles);
        // 생략..(itemRepository.save(item))

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

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

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

    @ResponseBody
    @GetMapping("/images/{filename}")
    public Resource downloadImage(
            @PathVariable String filename) throws MalformedURLException {

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

        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"): 폼의 데이터를 저장하고 보여주는 화면으로 리다이렉트 한다.
    • ItemForm객체에 저장된 첨부파일과 이미지 파일을 받아온 뒤 파일 저장관련 업무 처리 클래스로 보내서 원하는 타입으로 다시 값을 받아온다. 그 후에 데이터 베이스에 저장할때 사용된다.
  • @GetMapping("/items/{id}"): 상품을 보여준다.
  • @GetMapping("/images/{filename}"): 태그로 이미지를 조회할 때 사용한다.
    • UrlResource로 이미지 파일을 읽어서 @ResponseBody로 이미지 바이너리를 반환한다.
  • @GetMapping("/attach/{itemId}"): 파일을 다운로드 할 때 실행한다.
    • 파일 다운로드 시 권한 체크같은 복잡한 상황까지 가정한다 생각하고 이미지 id를 요청하도록 했다.
    • 파일 다운로드시에는 고객이 업로드한 파일 이름으로 다운로드 하는게 좋다. 이때는 Content-Disposition 해더에 attachment; filename="업로드 파일명"값을 주면 된다.

등록 폼 뷰

item-form.html

<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>

다중 파일 업로드를 하려면 multiple="multiple"옵션을 주면 된다.
ItemForm의 private List<MultipartFile> imageFiles; 코드 덕분에 여러 이미지 파일을 받을 수 있다.

조회 뷰

item-view.html

상품명: <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"/>

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


<출처 : 인프런 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술(김영한)>

댓글남기기

참고