📄 [문서] Spring 파일 업로드와 저장 방식

[nayoung04]

❌ 문제 상황

No response

📝 핵심 내용과 방향성

File vs. MultipartFile

1. File

• 자바의 java.io.File 클래스
• 파일 시스템에 존재하는 실제 파일
• 파일의 경로나 위치를 기반으로 파일을 읽거나 쓸 때 사용
• Spring에서 업로드된 파일을 다룰 때 사용되기보다는, 이미 서버에 존재하는 파일을 다룰 때 주로 사용

2. MultipartFile

• Spring 프레임워크에서 제공하는 인터페이스
• HTTP 요청을 통해 업로드된 임시 파일
• 실제로 파일이 업로드된 후 메모리에 임시로 보관되며, 필요에 따라 파일 시스템으로 전환할 수 있음
• MultipartResolver를 통해 처리된 파일로, 주로 파일 업로드 요청을 처리할 때 사용
• 파일을 업로드한 후 getInputStream(), getBytes(), transferTo(File dest) 등의 메서드를 사용하여 파일을 다룰 수 있음

업로드 과정에서의 차이점

• MultipartFile: HTTP 요청을 통해 전달된 파일. 아직 파일 시스템에 저장되지 않은 상태일 수 있음.
• File: MultipartFile로 전달된 파일을 서버의 특정 경로에 저장한 후, 그때부터 File 객체로 다룰 수 있음.

---

@RequestBody vs. @ModelAttribute

1. @RequestBody

• JSON(또는 XML) 형태의 데이터를 요청 본문에서 직접 바인딩.
• HTTP 요청의 Body에서 JSON 데이터를 읽어와 자바 객체로 변환.
• HTTP 메서드: 주로 POST, PUT, PATCH에서 사용.
• 파일 업로드는 불가(파일은 본문에 바이너리 형태로 들어올 수 없으므로).

예시:

{
  "name": "홍길동",
  "age": 25
}

@PostMapping("/user")
public ResponseEntity<String> createUser(@RequestBody UserDto user) {
    // JSON 데이터를 UserDto 객체로 바인딩
    return ResponseEntity.ok("User created: " + user.getName());
}

---

2. @ModelAttribute

• form-data(폼 형식)로 전달된 데이터를 객체 필드에 바인딩.
• multipart/form-data 방식도 지원하므로 파일 업로드가 가능.
• HTTP 요청의 폼 필드 이름과 자바 객체의 필드 이름을 매핑해서 객체를 생성.
• HTTP 메서드: GET, POST, PUT, PATCH 등 모두 사용.
• 파일 업로드 시 MultipartFile과 함께 사용할 수 있음.

예시:

<form action="/user" method="post" enctype="multipart/form-data">
    <input type="text" name="name" />
    <input type="number" name="age" />
    <input type="file" name="profileImage" />
</form>

@PostMapping("/user")
public ResponseEntity<String> createUser(@ModelAttribute UserDto user, @RequestParam("profileImage") MultipartFile image) {
    // form-data 데이터를 UserDto 객체로 바인딩
    // 파일 업로드도 함께 처리 가능
    return ResponseEntity.ok("User created: " + user.getName());
}

• @RequestParam: 파일 단독 업로드 시 사용.
• @ModelAttribute: 파일 + 다른 폼 데이터 함께 업로드 시 사용.

---

MultipartFile의 주요 메서드

• getOriginalFilename(): 원본 파일명 가져오기
• getSize(): 파일 크기
• getContentType(): MIME 타입
• isEmpty(): 비어 있는지 확인
• getBytes(): 바이트 배열로 파일 내용 가져오기
• getInputStream(): 파일 내용을 스트림으로 읽기
• transferTo(): 파일을 지정 경로에 저장

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;

@RestController
@RequestMapping("/file")
public class FileController {

    @PostMapping("/upload")
    public ResponseEntity<String> uploadFile(@RequestParam("file") MultipartFile multipartFile) {
        try {
            // 1. 원본 파일명 가져오기
            String originalFileName = multipartFile.getOriginalFilename();

            // 2. 파일 크기 가져오기
            long fileSize = multipartFile.getSize();

            // 3. 파일 MIME 타입 가져오기
            String contentType = multipartFile.getContentType();

            // 4. 파일이 비어 있는지 확인
            if (multipartFile.isEmpty()) {
                return ResponseEntity.badRequest().body("파일이 비어 있습니다.");
            }

            // 5. 파일 내용을 바이트 배열로 가져오기
            byte[] fileBytes = multipartFile.getBytes();

            // 6. 파일 내용을 InputStream으로 가져오기
            InputStream inputStream = multipartFile.getInputStream();

            // 7. 파일을 지정 경로에 저장하기
            String uploadDir = "/path/to/your/upload/directory/";
            File dest = new File(uploadDir + originalFileName);
            multipartFile.transferTo(dest);

            // 파일 정보 출력
            String responseMessage = "파일 업로드 성공!\n" +
                    "파일명: " + originalFileName + "\n" +
                    "파일 크기: " + fileSize + " 바이트\n" +
                    "MIME 타입: " + contentType + "\n" +
                    "저장 경로: " + dest.getAbsolutePath();

            return ResponseEntity.ok(responseMessage);

        } catch (IOException e) {
            return ResponseEntity.status(500).body("파일 업로드 실패: " + e.getMessage());
        }
    }
}

---

1. Amazon S3

특징

• AWS에서 제공하는 클라우드 객체 스토리지 서비스
• 파일, 이미지, 영상 등 대용량 데이터를 안정적이고 확장성 있게 저장하고 관리할 수 있으며, REST API 기반으로 접근 가능

장점

• 자동 백업과 높은 내구성으로 데이터를 안전하게 보관
• 사용량이 증가해도 무제한 확장 가능
• IAM(권한 관리)로 세부적인 접근 제어 가능
• CDN(CloudFront)과 연동해 빠른 배포 가능
• 사용한 만큼만 비용을 지불하는 구조로 초기 비용 없음

단점

• 데이터 전송량(Out) 증가 시 비용 증가
• 인터넷 연결이 없으면 접근 불가
• S3 버킷 설정, 권한 관리 등 초기 세팅에 학습 필요

2. 외부 서버(자체 구축 서버)

특징

• 기업이나 개인이 직접 서버를 구축하여 파일을 저장하고 관리
• 온프레미스(내부망) 또는 외부 서버(호스팅) 형태로 사용

장점

• 모든 설정과 접근을 직접 관리할 수 있음
• 서버를 임대하면 고정 비용으로 사용 가능
• 내부망 사용 시 속도가 매우 빠름

단점

• 보안, 백업, 유지보수 등 관리를 모두 직접 해야 함
• 하드웨어나 네트워크 환경에 따라 확장성에 한계 있음
• 서버 구매나 임대 시 초기 비용 필요

3. FTP(File Transfer Protocol)

특징

• 파일을 전송하는 오래된 프로토콜 중 하나
• 파일 서버와 클라이언트 간에 FTP 클라이언트를 사용해 파일을 업로드하고 다운로드
• 사진을 저장할 수 있는 서버로 파일을 전송

장점

• 구조가 간단해 FTP 서버만 설치하면 바로 사용 가능
• 빠른 전송 속도와 간단한 인증 방식

단점

• 기본 FTP는 평문(Plain Text)으로 인증과 전송이 이루어지기 때문에 보안이 취약함(SFTP 필요)
• API 지원이 부족해 웹 애플리케이션과의 연동이 어려움
• 대규모 서비스에는 적합하지 않음

📚 트러블슈팅 및 기대효과

No response

🔗 관련 자료

No response

🙋‍ 담당자

• 백엔드: 이름
• 프로트엔드: 이름
• 디자인: 이름