S04L04 - बिल्ड फ़ाइल अपलोड एपीआई, स्प्रिंग बूट

html

Spring Boot के साथ एक मजबूत File Upload API बनाना
सामग्री

परिचय
Spring Boot प्रोजेक्ट सेट अप करना
AlbumController डिजाइन करना
Upload Photo Endpoint लागू करना
Multipart File Uploads संभालना
API दस्तावेज़ीकरण के लिए Swagger कॉन्फ़िगर करना
File Storage और Size Limits प्रबंधित करना
निष्कर्ष


परिचय
आधुनिक वेब परिदृश्य में, फाइल अपलोड और प्रबंधन की क्षमता कई अनुप्रयोगों के लिए एक बुनियादी सुविधा है। चाहे वह फोटो गैलरी, दस्तावेज़ भंडारण, या मीडिया शेयरिंग प्लेटफॉर्म के लिए हो, एक मजबूत File Upload API आवश्यक है। यह eBook Spring Boot का उपयोग करके एक व्यापक File Upload API बनाने में गहराई से व्यस्त है, जिसे शुरुआती और बुनियादी ज्ञान वाले डेवलपर्स के लिए तैयार किया गया है।
महत्व और उद्देश्य
File upload functionalities उपयोगकर्ता अनुभव को बढ़ाती हैं जिससे सहज फाइल प्रबंधन की अनुमति मिलती है। इस सुविधा को सुरक्षित और कुशलतापूर्वक लागू करने से डेटा एकता और एप्लिकेशन विश्वसनीयता सुनिश्चित होती है।
फायदे और नुकसान


फायदे
नुकसान


उपयोगकर्ता इंटरैक्शन को बढ़ाता है
संभावित सुरक्षा कमजोरियाँ


डेटा प्रबंधन को सुविधाजनक बनाता है
बड़े फाइलों को ध्यानपूर्वक संभालने की आवश्यकता


उपयुक्त आर्किटेक्चर के साथ स्केलेबल
बढ़ा हुआ सर्वर लोड


कब और कहाँ उपयोग करें

Photo Galleries: उपयोगकर्ता द्वारा अपलोड की गई छवियों का प्रबंधन।
Document Management Systems: PDF, वर्ड दस्तावेज़, आदि को संभालना।
Media Sharing Platforms: उपयोगकर्ताओं को वीडियो और ऑडियो फाइलें अपलोड करने की अनुमति देना।


Spring Boot प्रोजेक्ट सेट अप करना
API कार्यान्वयन में गहराई से जाने से पहले, Spring Boot प्रोजेक्ट सेट अप करना महत्वपूर्ण है। Spring Boot न्यूनतम कॉन्फ़िगरेशन के साथ Java अनुप्रयोग बनाने के लिए एक सुव्यवस्थित दृष्टिकोण प्रदान करता है।
पूर्वापेक्षाएँ

Java Development Kit (JDK) 8 या उच्चतर
Maven या Gradle Build Tool
Integrated Development Environment (IDE) जैसे IntelliJ IDEA या VS Code

एक नया Spring Boot प्रोजेक्ट बनाना

Spring Initializr का उपयोग करते हुए:

Spring Initializr पर जाएं।
निम्नलिखित चुनें:

Project: Maven Project
Language: Java
Spring Boot: 2.7.x या उच्चतर
Dependencies: Spring Web, Spring Security, Spring Data JPA, Lombok, Swagger


Generate पर क्लिक करके प्रोजेक्ट ज़िप डाउनलोड करें।


IDE में आयात करना:

डाउनलोड की गई ज़िप को निकालें।
अपने 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: इस क्लास को एक controller के रूप में चिह्नित करता है जहां हर method एक domain object लौटाता है न कि view।
@RequestMapping("/api/v1/albums"): सभी एल्बम-संबंधी endpoints के लिए बेस URI।
@PostMapping("/photos"): फोटो अपलोड करने के लिए endpoint।


Upload Photo Endpoint लागू करना
uploadPhotos method एक एल्बम में कई फोटो अपलोड करने में सुविधा प्रदान करता है।
Method Breakdown

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 File Uploads संभालना
Multipart file uploads फॉर्म डेटा के साथ फाइलों के स्थानांतरण को सक्षम बनाते हैं। Spring Boot मौलिक रूप से multipart uploads को संभालने के लिए व्यापक समर्थन प्रदान करता है।
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 Layer कार्यान्वयन




		
		
			
			
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 {
                // फाइल को स्थानीय रूप से या किसी storage service में सहेजें
                // उदाहरण: 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 {
                // फाइल को स्थानीय रूप से या किसी storage service में सहेजें
                // उदाहरण: 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 Dependencies जोड़ना
सुनिश्चित करें कि Swagger dependencies pom.xml में शामिल हैं।




		
		
			
			
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 दस्तावेज़ीकरण को देखें और इंटरैक्ट करें।

File Storage और Size Limits प्रबंधित करना
प्रभावी फाइल स्टोरेज प्रबंधन सुनिश्चित करता है कि एप्लिकेशन अपलोड को संभाल सके बिना प्रदर्शन में गिरावट के।
अधिकतम फाइल आकार सेट करना
जैसा कि पहले 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
 
					
				
			
		


Storage स्थान संभालना
निर्णय लें कि अपलोड की गई फाइलों को कहां स्टोर करना है:

Local File System: छोटे अनुप्रयोगों या विकास वातावरण के लिए उपयुक्त।
Cloud Storage Services: स्केलेबिलिटी और विश्वसनीयता के लिए अनुशंसित (जैसे AWS S3, Google Cloud Storage)।

Storage के लिए Service Layer अपडेट करना




		
		
			
			
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 uploads को संभालने और सुरक्षित फाइल स्टोरेज सुनिश्चित करने तक। सर्वोत्तम प्रथाओं का पालन करके और Spring Boot की मजबूत विशेषताओं का लाभ उठाकर, डेवलपर्स अपने एप्लिकेशन की आवश्यकताओं के अनुरूप स्केलेबल और सुरक्षित File Upload functionalities बना सकते हैं।
मुख्य निष्कर्ष

API Design: स्पष्ट और संक्षिप्त endpoints की संरचना करके अनावश्यकता से बचें।
Multipart Handling: फाइल अपलोड को कुशलतापूर्वक संभालने के लिए multipart सेटिंग्स को सही तरीके से कॉन्फ़िगर करें।
Documentation: इंटरैक्टिव और व्यापक API दस्तावेज़ीकरण के लिए Swagger का उपयोग करें।
Security: संभावित कमजोरियों से बचाव के लिए आवश्यक validations और सुरक्षा उपाय लागू करें।

SEO Optimized Keywords: 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.

Note: यह लेख AI द्वारा जनरेट किया गया है।
फायदे	नुकसान
उपयोगकर्ता इंटरैक्शन को बढ़ाता है	संभावित सुरक्षा कमजोरियाँ
डेटा प्रबंधन को सुविधाजनक बनाता है	बड़े फाइलों को ध्यानपूर्वक संभालने की आवश्यकता
उपयुक्त आर्किटेक्चर के साथ स्केलेबल	बढ़ा हुआ सर्वर लोड