S04L04 - 파일 업로드 API 구축, Spring Boot

html

Spring Boot를 사용한 강력한 파일 업로드 API 구축
목차

소개
Spring Boot 프로젝트 설정
AlbumController 설계
사진 업로드 엔드포인트 구현
Multipart 파일 업로드 처리
API 문서를 위한 Swagger 설정
파일 저장 및 크기 제한 관리
결론


소개
현대 웹 환경에서 파일을 업로드하고 관리하는 능력은 많은 애플리케이션의 기본 기능입니다. 사진 갤러리, 문서 저장소 또는 미디어 공유 플랫폼을 위해, 강력한 파일 업로드 API는 필수적입니다. 이 eBook은 초보자와 기본 지식을 가진 개발자들을 위해 Spring Boot를 사용하여 종합적인 File Upload API 구축에 대해 다룹니다.
중요성과 목적
File upload 기능은 원활한 파일 관리를 가능하게 하여 사용자 경험을 향상시킵니다. 이 기능을 안전하고 효율적으로 구현하면 데이터 무결성과 애플리케이션 신뢰성을 보장할 수 있습니다.
장점과 단점


장점
단점


사용자 상호 작용 향상
잠재적인 보안 취약점


데이터 관리 용이
대용량 파일의 신중한 처리가 필요


적절한 아키텍처 설정 시 확장 가능
서버 부하 증가


언제 어디에 사용할까

사진 갤러리: 사용자 업로드 이미지를 관리.
문서 관리 시스템: PDF, Word 문서 등을 처리.
미디어 공유 플랫폼: 사용자가 비디오 및 오디오 파일을 업로드할 수 있도록 허용.


Spring Boot 프로젝트 설정
API 구현에 앞서, Spring Boot 프로젝트 설정이 중요합니다. Spring Boot는 최소한의 설정으로 Java 애플리케이션을 구축할 수 있는 간소화된 접근 방식을 제공합니다.
필수 조건

Java Development Kit (JDK) 8 이상
Maven 또는 Gradle 빌드 도구
IntelliJ IDEA 또는 VS Code와 같은 통합 개발 환경 (IDE)

새 Spring Boot 프로젝트 생성

Spring Initializr 사용:

Spring Initializr로 이동합니다.
다음 항목을 선택합니다:

프로젝트: Maven Project
언어: Java
Spring Boot: 2.7.x 이상
의존성: Spring Web, Spring Security, Spring Data JPA, Lombok, Swagger


Generate 버튼을 클릭하여 프로젝트 zip 파일을 다운로드합니다.


IDE로 가져오기:

다운로드한 zip 파일을 추출합니다.
IDE를 열고 프로젝트를 Maven 프로젝트로 가져옵니다.



프로젝트 구조 개요




		
		
			
			
Java
			
			SpringRestdemo/
├── src/
│   ├── main/
│   │   ├── java/org/studyeasy/SpringRestdemo/
│   │   │   ├── controller/
│   │   │   ├── model/
│   │   │   ├── repository/
│   │   │   ├── service/
│   │   │   ├── config/
│   │   │   └── SpringRestdemoApplication.java
│   │   └── resources/
│   │       └── application.properties
│   └── test/
│       └── java/org/studyeasy/SpringRestdemo/
│           └── SpringRestdemoApplicationTests.java
├── pom.xml
└── mvnw
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
				
						SpringRestdemo/
├── src/
│   ├── main/
│   │   ├── java/org/studyeasy/SpringRestdemo/
│   │   │   ├── controller/
│   │   │   ├── model/
│   │   │   ├── repository/
│   │   │   ├── service/
│   │   │   ├── config/
│   │   │   └── SpringRestdemoApplication.java
│   │   └── resources/
│   │       └── application.properties
│   └── test/
│       └── java/org/studyeasy/SpringRestdemo/
│           └── SpringRestdemoApplicationTests.java
├── pom.xml
└── mvnw
					
				
			
		



AlbumController 설계
AlbumController는 사진 업로드를 포함한 앨범 관련 작업을 처리하는 데 중요한 역할을 합니다.
Controller 생성




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.controller;

import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import org.studyeasy.SpringRestdemo.service.AlbumService;
import java.util.List;

@RestController
@RequestMapping("/api/v1/albums")
public class AlbumController {

    private final AlbumService albumService;

    public AlbumController(AlbumService albumService) {
        this.albumService = albumService;
    }

    @PostMapping("/photos")
    public List<String> uploadPhotos(@RequestParam("files") MultipartFile[] files) {
        return albumService.savePhotos(files);
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
				
						package org.studyeasy.SpringRestdemo.controller;
 
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import org.studyeasy.SpringRestdemo.service.AlbumService;
import java.util.List;
 
@RestController
@RequestMapping("/api/v1/albums")
public class AlbumController {
 
    private final AlbumService albumService;
 
    public AlbumController(AlbumService albumService) {
        this.albumService = albumService;
    }
 
    @PostMapping("/photos")
    public List<String> uploadPhotos(@RequestParam("files") MultipartFile[] files) {
        return albumService.savePhotos(files);
    }
}
 
					
				
			
		


주요 구성 요소

@RestController: 모든 메소드가 뷰 대신 도메인 객체를 반환하는 컨트롤러로 클래스를 표시합니다.
@RequestMapping("/api/v1/albums"): 모든 앨범 관련 엔드포인트의 기본 URI입니다.
@PostMapping("/photos"): 사진 업로드를 위한 엔드포인트입니다.


사진 업로드 엔드포인트 구현
uploadPhotos 메소드는 앨범에 여러 사진을 업로드하는 것을 용이하게 합니다.
메소드 구성

Request Parameter:

@RequestParam("files") MultipartFile[] files: 클라이언트로부터 여러 파일을 수락합니다.


Service Layer Invocation:

파일 저장 프로세스를 AlbumService에 위임합니다.


Response:

확인용으로 저장된 파일 이름 목록을 반환합니다.



샘플 구현




		
		
			
			
Java
			
			@PostMapping("/photos")
public List<String> uploadPhotos(@RequestParam("files") MultipartFile[] files) {
    return albumService.savePhotos(files);
}

			
				
					
				
					1
2
3
4
5
				
						@PostMapping("/photos")
public List<String> uploadPhotos(@RequestParam("files") MultipartFile[] files) {
    return albumService.savePhotos(files);
}
 
					
				
			
		



Multipart 파일 업로드 처리
Multipart 파일 업로드는 폼 데이터와 함께 파일 전송을 가능하게 합니다. Spring Boot는 Multipart 업로드 처리를 위한 포괄적인 지원을 제공합니다.
Multipart 설정 구성
application.properties에서 최대 파일 크기 및 요청 크기를 구성합니다.




		
		
			
			
Java
			
			spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=20MB

			
				
					
				
					1
2
3
				
						spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=20MB
 
					
				
			
		


Service 레이어 구현




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.service;

import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

@Service
public class AlbumService {

    public List<String> savePhotos(MultipartFile[] files) {
        List<String> fileNames = new ArrayList<>();
        for (MultipartFile file : files) {
            try {
                // Save the file locally or to a storage service
                // Example: Files.write(Paths.get("uploads/" + file.getOriginalFilename()), file.getBytes());
                fileNames.add(file.getOriginalFilename());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return fileNames;
    }
}

			
				
					
				
					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
				
						package org.studyeasy.SpringRestdemo.service;
 
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
 
@Service
public class AlbumService {
 
    public List<String> savePhotos(MultipartFile[] files) {
        List<String> fileNames = new ArrayList<>();
        for (MultipartFile file : files) {
            try {
                // Save the file locally or to a storage service
                // Example: Files.write(Paths.get("uploads/" + file.getOriginalFilename()), file.getBytes());
                fileNames.add(file.getOriginalFilename());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return fileNames;
    }
}
 
					
				
			
		


설명

Loop Through Files: 업로드된 각 파일을 반복합니다.
Save Files: 파일을 원하는 위치에 실제로 저장하는 것을 처리합니다.
Collect File Names: 응답을 위해 성공적으로 저장된 파일 이름을 수집합니다.


API 문서를 위한 Swagger 설정
Swagger는 개발자 경험과 테스트의 용이성을 향상시키는 인터랙티브한 API 문서를 제공합니다.
Swagger 의존성 추가
pom.xml에 Swagger 의존성이 포함되었는지 확인합니다.




		
		
			
			
Java
			
			&lt;dependency>
    &lt;groupId>io.springfox&lt;/groupId>
    &lt;artifactId>springfox-boot-starter&lt;/artifactId>
    &lt;version>3.0.0&lt;/version>
&lt;/dependency>

			
				
					
				
					1
2
3
4
5
6
				
						&lt;dependency>
    &lt;groupId>io.springfox&lt;/groupId>
    &lt;artifactId>springfox-boot-starter&lt;/artifactId>
    &lt;version>3.0.0&lt;/version>
&lt;/dependency>
 
					
				
			
		


Swagger 설정




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
  
@Configuration
public class SwaggerConfig {                                    
    @Bean
    public Docket api() { 
        return new Docket(DocumentationType.OAS_30)  
          .select()                                  
          .apis(RequestHandlerSelectors.basePackage("org.studyeasy.SpringRestdemo.controller"))              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
				
						package org.studyeasy.SpringRestdemo.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
  
@Configuration
public class SwaggerConfig {                                    
    @Bean
    public Docket api() { 
        return new Docket(DocumentationType.OAS_30)  
          .select()                                  
          .apis(RequestHandlerSelectors.basePackage("org.studyeasy.SpringRestdemo.controller"))              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}
 
					
				
			
		


Swagger UI 접근하기
애플리케이션이 실행되면, http://localhost:8080/swagger-ui/index.html로 이동하여 API 문서를 보고 상호 작용할 수 있습니다.

파일 저장 및 크기 제한 관리
효과적인 파일 저장 관리는 애플리케이션이 성능 저하 없이 업로드를 처리할 수 있도록 보장합니다.
최대 파일 크기 설정
앞서 application.properties에서 구성한 대로:




		
		
			
			
Java
			
			spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=20MB

			
				
					
				
					1
2
3
				
						spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=20MB
 
					
				
			
		


저장 위치 처리
업로드된 파일을 저장할 위치를 결정합니다:

Local File System: 소규모 애플리케이션이나 개발 환경에 적합합니다.
Cloud Storage Services: 확장성과 신뢰성을 위해 권장됩니다 (예: AWS S3, Google Cloud Storage).

저장을 위한 Service 레이어 업데이트




		
		
			
			
Java
			
			public List<String> savePhotos(MultipartFile[] files) {
    List<String> fileNames = new ArrayList<>();
    for (MultipartFile file : files) {
        try {
            String filename = file.getOriginalFilename();
            Path path = Paths.get("uploads/" + filename);
            Files.write(path, file.getBytes());
            fileNames.add(filename);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    return fileNames;
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
				
						public List<String> savePhotos(MultipartFile[] files) {
    List<String> fileNames = new ArrayList<>();
    for (MultipartFile file : files) {
        try {
            String filename = file.getOriginalFilename();
            Path path = Paths.get("uploads/" + filename);
            Files.write(path, file.getBytes());
            fileNames.add(filename);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    return fileNames;
}
 
					
				
			
		


보안 고려사항

File Validation: 업로드된 파일이 허용된 유형 및 크기인지 확인합니다.
Storage Permissions: 무단 접근을 방지하기 위해 저장 디렉토리에 대한 접근을 제한합니다.
Virus Scanning: 악성 소프트웨어 업로드를 방지하기 위해 업로드된 파일을 스캔합니다.


결론
Spring Boot를 사용한 File Upload API 구축은 프로젝트 설정부터 Multipart 업로드 처리 및 안전한 파일 저장 보장에 이르기까지 여러 중요한 단계를 포함합니다. 모범 사례를 따르고 Spring Boot의 강력한 기능을 활용함으로써, 개발자들은 애플리케이션의 요구사항에 맞는 확장 가능하고 안전한 파일 업로드 기능을 만들 수 있습니다.
주요 내용

API 설계: 명확하고 간결한 엔드포인트 구조로 중복을 피합니다.
Multipart 처리: 파일 업로드를 효율적으로 처리하기 위해 multipart 설정을 적절히 구성합니다.
문서화: Swagger를 활용하여 인터랙티브하고 포괄적인 API 문서를 작성합니다.
보안: 잠재적인 취약점을 방지하기 위해 필요한 검증 및 보안 조치를 구현합니다.

SEO 최적화 키워드: Spring Boot file upload API, Spring Rest Controller, multipart file handling, Swagger API documentation, secure file storage, Spring Boot project setup, upload photos Spring Boot, handling multiple file uploads, Spring Boot security configuration, API endpoint design.

참고: 이 기사는 AI가 생성했습니다.
장점	단점
사용자 상호 작용 향상	잠재적인 보안 취약점
데이터 관리 용이	대용량 파일의 신중한 처리가 필요
적절한 아키텍처 설정 시 확장 가능	서버 부하 증가