[Spring] 파일 업로드

Notice

Recent Posts

Recent Comments

Link

« 2025/05 »
일	월	화	수	목	금	토
				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30	31

Tags more

Archives

Today

Total

관리 메뉴

hades

[Spring] 파일 업로드 본문

🏃🏻‍♂️ 기본훈련/Spring

[Spring] 파일 업로드

hades1 2024. 8. 13. 15:38

프로젝트를 진행하던 도중, 파일 업로드 기능이 필요하여 학습 후, 프로젝트를 기반으로 정리한 글이다. 본인은 게시글에 이미지 파일을 올리는 것을 목표로 하였고, 그로 인해 게시글과 파일 간의 연관관계가 있다.

Multipart

문자, 숫자 데이터는 기본적으로 application/x-www-form-urlencoded 방식을 이용한다. 하지만, 파일은 이들과 다르게 바이너리 데이터로 보내야 한다. 문자, 숫자, 파일을 동시에 보내야 하는 경우에 문제가 발생한다. 이를 해결하는 것이 Form 태그에 enctype="multipart/form-data" 를 추가하는 것이다.

Content-Disposition에 의해 구분되고, 파일은 추가적으로 filename과 Content-Type이 추가되고 바이너리 데이터가 전송된다.

스프링에서는 MultipartFile을 이용하여 Request로 전송된 파일을 전달받을 수 있다. MultipartFile은 아래 두 가지 기능을 제공한다.

file.getOriginalFileName() : 업로드 파일명
file.transferTo(PATH) : PATH에 파일 저장

업로드 파일 정보

UploadFile

@Entity
@Getter
@Setter
public class UploadFile {
    @Id
    @GeneratedValue
    @Column(name = "FILE_ID")
    private Long id;

    private String uploadFileName;

    private String storeFileName;

    protected UploadFile() {
    }

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

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "POST_ID")
    private Post post;

}

uploadFileName은 사용자가 파일을 업로드했을 때, 실제 파일명이다.

storeFileName은 서버 컴퓨터에 저장되는 파일명이다. 여러 사용자가 서로 다른 파일을 같은 이름으로 저장할 경우, 문제가 발생할 수 있기 때문이다.

파일 저장 관련

UploadFileService

@Service
@RequiredArgsConstructor
@Transactional
public class UploadFileService {
    private final UploadFileRepository uploadFileRepository;

    @Value("${file.dir}")
    private String fileDir;

    public String getFullPath(String filename){
        return fileDir + filename;
    }
    
    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)));

        UploadFile uploadFile = new UploadFile(originalFilename, storeFilename);

        uploadFileRepository.save(uploadFile);

        return uploadFile;
    }

    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 void removeFile(Long id){
        UploadFile uploadFile = uploadFileRepository.findOne(id);
        uploadFileRepository.remove(uploadFile);
    }

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

@Value("${file.dir}")는 환경 변수에서 값을 가져온다. file.dir에는 파일명을 제외한 서버 컴퓨터에 저장될 위치가 저장되어 있다.

getFullPath는 파일이 서버 컴퓨터에 저장될 최종 위치를 반환한다.

storeFile에서는 multipartFile을 전달받아 서버 컴퓨터에 저장하고, 원래 파일명과 서버에 저장할 경로를 UploadFile에 저장하여 DB에 저장하고, 반환한다.

storeFiles에서는 multipartFiles를 받아 storeFile한다.

removeFile에서는 전달받은 id를 통해 데이터베이스에서 제거한다.

createStoreFilename은 파일이 서버 컴퓨터에서 저장될 때, 이름이 중복되지 않도록 UUID를 이용하여 새로운 파일명을 생성한다.

extractExt는 파일 확장자를 반환한다.

createPost.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
  <meta charset="UTF-8">
  <title>요리 인증 글 작성</title>
</head>
<body>
<h1>요리 인증 글 작성</h1>

<h2>내가 만든 요리 자랑하기</h2>
<form th:action="|/post/create/${foodId}|" method="post" enctype="multipart/form-data" th:object="${postDto}">
  <ul>
    <li>이미지 <input type="file" th:field="*{imageFiles}" multiple="multiple" required></li>
    <li>한마디 <input type="text" th:field="*{comment}" required></li>
  </ul>
  <button type="submit">등록</button>
</form>
</body>
</html>

PostController

@PostMapping("/post/create/{foodId}")
public String writePost(@PathVariable Long foodId, @ModelAttribute PostDto postDto, HttpServletRequest request) throws IOException {
    List<UploadFile> imageFiles = uploadFileService.storeFiles(postDto.getImageFiles());
    String comment = postDto.getComment();

    HttpSession session = request.getSession();
    Member loginMember = (Member)session.getAttribute("LOGIN_MEMBER");

    Food food = foodRepository.findOne(foodId);

    Post post = Post.createPost(loginMember, food, imageFiles, comment);

    postService.write(post);

    return "redirect:/food/foodInfo/" + foodId;
}

@ResponseBody
@GetMapping("/post/images/{filename}")
public UrlResource downloadImage(@PathVariable String filename) throws MalformedURLException {
    return new UrlResource("file:" + uploadFileService.getFullPath(filename));
}

writePost는 전달받은 imageFiles를 저장하고, UploadFile 리스트로 반환받아, Post에 연결시킨다.

downloadImage는 img 태그에서 이미지를 불러오기 위해 필요한 UrlResource를 생성한다. UrlResource에서 "file:"을 꼭 붙여야되나 했는데, 공식문서를 참조해보니 붙여야 한다.

https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/io/UrlResource.html

UrlResource (Spring Framework 6.1.11 API)

This delegate creates a java.net.URL, applying the given path relative to the path of the underlying URL of this resource descriptor.

docs.spring.io

'🏃🏻‍♂️ 기본훈련 > Spring' 카테고리의 다른 글

[Spring] 경로 설정 시 대소문자 구분의 중요성 (0)	2024.08.19
[Spring] 스프링 AI (0)	2024.08.14
[Spring] redirect 경로 설정 시 문자 사용 주의 (0)	2024.08.12
[Thymeleaf] 텍스트 리터럴 (0)	2024.08.05
[Thymeleaf] 템플릿 위치 (0)	2024.07.29

'🏃🏻‍♂️ 기본훈련/Spring' Related Articles

hades

[Spring] 파일 업로드 본문

[Spring] 파일 업로드

Multipart

업로드 파일 정보

파일 저장 관련

'🏃🏻‍♂️ 기본훈련 > Spring' 카테고리의 다른 글

티스토리툴바