Firebase के लिए Cloud Storage की मदद से, Firebase की ओर से उपलब्ध कराई गई और मैनेज की गई Cloud Storage बकेट में फ़ाइलें तुरंत और आसानी से अपलोड की जा सकती हैं.
फ़ाइलें अपलोड करें
Cloud Storage में कोई फ़ाइल अपलोड करने के लिए, आपको सबसे पहले फ़ाइल के पूरे पाथ का रेफ़रंस बनाना होगा. इसमें फ़ाइल का नाम भी शामिल होता है.
// Create a storage reference from our app
final storageRef = FirebaseStorage.instance.ref();
// Create a reference to "mountains.jpg"
final mountainsRef = storageRef.child("mountains.jpg");
// Create a reference to 'images/mountains.jpg'
final mountainImagesRef = storageRef.child("images/mountains.jpg");
// While the file names are the same, the references point to different files
assert(mountainsRef.name == mountainImagesRef.name);
assert(mountainsRef.fullPath != mountainImagesRef.fullPath);
सही रेफ़रंस बनाने के बाद, Cloud Storage पर फ़ाइल अपलोड करने के लिए, putFile()
, putString()
या putData()
तरीके का इस्तेमाल करें.
Cloud Storage बकेट के रूट का रेफ़रंस देकर डेटा अपलोड नहीं किया जा सकता. आपका रेफ़रंस, चाइल्ड यूआरएल पर ले जाना चाहिए.
किसी फ़ाइल से अपलोड करना
किसी फ़ाइल को अपलोड करने के लिए, आपको सबसे पहले डिवाइस पर मौजूद उसकी जगह का ऐब्सलूट पाथ पता होना चाहिए. उदाहरण के लिए, अगर कोई फ़ाइल ऐप्लिकेशन के दस्तावेज़ डायरेक्ट्री में मौजूद है, तो फ़ाइल का पाथ जनरेट करने के लिए, आधिकारिक path_provider
पैकेज का इस्तेमाल करें और इसे putFile()
को पास करें:
Directory appDocDir = await getApplicationDocumentsDirectory();
String filePath = '${appDocDir.absolute}/file-to-upload.png';
File file = File(filePath);
try {
await mountainsRef.putFile(file);
} on firebase_core.FirebaseException catch (e) {
// ...
}
स्ट्रिंग से अपलोड करना
putString()
तरीके का इस्तेमाल करके, डेटा को रॉ, base64
, base64url
या data_url
एन्कोड की गई स्ट्रिंग के तौर पर अपलोड किया जा सकता है. उदाहरण के लिए, डेटा यूआरएल के तौर पर कोड में बदली गई टेक्स्ट स्ट्रिंग अपलोड करने के लिए:
String dataUrl = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==';
try {
await mountainsRef.putString(dataUrl, format: PutStringFormat.dataUrl);
} on FirebaseException catch (e) {
// ...
}
रॉ डेटा अपलोड करना
ऐसे मामलों में जहां स्ट्रिंग या File
अपलोड करना व्यावहारिक नहीं है, वहां Uint8List
के तौर पर टाइप किया गया लोअर-लेवल का डेटा अपलोड किया जा सकता है. इस मामले में, अपने डेटा के साथ putData()
तरीके को कॉल करें:
try {
// Upload raw data.
await mountainsRef.putData(data);
} on firebase_core.FirebaseException catch (e) {
// ...
}
डाउनलोड करने का यूआरएल पाना
फ़ाइल अपलोड करने के बाद, फ़ाइल डाउनलोड करने का यूआरएल पाने के लिए, Reference
पर getDownloadUrl()
तरीके का इस्तेमाल करें:
await mountainsRef.getDownloadURL();
फ़ाइल का मेटाडेटा जोड़ना
फ़ाइलें अपलोड करते समय, मेटाडेटा भी शामिल किया जा सकता है.
इस मेटाडेटा में, फ़ाइल के मेटाडेटा की सामान्य प्रॉपर्टी शामिल होती हैं. जैसे, contentType
(इसे आम तौर पर MIME टाइप कहा जाता है). putFile()
तरीके से, File
एक्सटेंशन से MIME टाइप का अपने-आप पता चल जाता है. हालांकि, मेटाडेटा में contentType
तय करके, अपने-आप पता चले टाइप को बदला जा सकता है. अगर आपने contentType
नहीं दिया है और Cloud Storage, फ़ाइल एक्सटेंशन से डिफ़ॉल्ट का अनुमान नहीं लगा सकता, तो Cloud Storage application/octet-stream
का इस्तेमाल करता है. फ़ाइल के मेटाडेटा का इस्तेमाल करना लेख पढ़ें.
try {
await mountainsRef.putFile(file, SettableMetadata(
contentType: "image/jpeg",
));
} on firebase_core.FirebaseException catch (e) {
// ...
}
अपलोड प्रबंधित करें
अपलोड शुरू करने के साथ-साथ, pause()
, resume()
, और cancel()
तरीकों का इस्तेमाल करके, अपलोड को रोका, फिर से शुरू किया, और रद्द किया जा सकता है. इवेंट को रोकने और फिर से शुरू करने पर, pause
और progress
स्टेट में बदलाव होता है. अपलोड रद्द करने पर, अपलोड नहीं हो पाता. साथ ही, गड़बड़ी का एक मैसेज दिखता है, जिसमें बताया जाता है कि अपलोड रद्द कर दिया गया है.
final task = mountainsRef.putFile(largeFile);
// Pause the upload.
bool paused = await task.pause();
print('paused, $paused');
// Resume the upload.
bool resumed = await task.resume();
print('resumed, $resumed');
// Cancel the upload.
bool canceled = await task.cancel();
print('canceled, $canceled');
अपलोड की स्थिति को मॉनिटर करना
अपलोड किए जा रहे टास्क के पूरा होने, पूरा न होने, उसकी प्रोग्रेस या उसमें रुकावट आने की जानकारी पाने के लिए, टास्क के इवेंट स्ट्रीम को सुना जा सकता है:
इवेंट टाइप | सामान्य इस्तेमाल |
---|---|
TaskState.running |
डेटा ट्रांसफ़र होने पर, इसे समय-समय पर भेजा जाता है. इसका इस्तेमाल, अपलोड/डाउनलोड इंडिकेटर को भरने के लिए किया जा सकता है. |
TaskState.paused |
टास्क के रुकने पर यह इवेंट ट्रिगर होता है. |
TaskState.success |
यह इवेंट तब ट्रिगर होता है, जब टास्क पूरा हो जाता है. |
TaskState.canceled |
टास्क रद्द होने पर, यह इवेंट कभी भी ट्रिगर हो सकता है. |
TaskState.error |
यह इवेंट तब ट्रिगर होता है, जब अपलोड नहीं हो पाता. ऐसा नेटवर्क टाइमआउट, पुष्टि न हो पाने या टास्क रद्द करने की वजह से हो सकता है. |
mountainsRef.putFile(file).snapshotEvents.listen((taskSnapshot) {
switch (taskSnapshot.state) {
case TaskState.running:
// ...
break;
case TaskState.paused:
// ...
break;
case TaskState.success:
// ...
break;
case TaskState.canceled:
// ...
break;
case TaskState.error:
// ...
break;
}
});
गड़बड़ी ठीक करना
अपलोड करते समय गड़बड़ियां होने की कई वजहें हो सकती हैं. जैसे, स्थानीय फ़ाइल मौजूद न होना या उपयोगकर्ता के पास, चुनी गई फ़ाइल को अपलोड करने की अनुमति न होना. दस्तावेज़ के गड़बड़ियां ठीक करना सेक्शन में जाकर, गड़बड़ियों के बारे में ज़्यादा जानकारी पाएं.
पूरा उदाहरण
प्रोग्रेस मॉनिटरिंग और गड़बड़ी ठीक करने की सुविधा के साथ अपलोड करने का पूरा उदाहरण यहां दिया गया है:
final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/path/to/mountains.jpg";
final file = File(filePath);
// Create the file metadata
final metadata = SettableMetadata(contentType: "image/jpeg");
// Create a reference to the Firebase Storage bucket
final storageRef = FirebaseStorage.instance.ref();
// Upload file and metadata to the path 'images/mountains.jpg'
final uploadTask = storageRef
.child("images/path/to/mountains.jpg")
.putFile(file, metadata);
// Listen for state changes, errors, and completion of the upload.
uploadTask.snapshotEvents.listen((TaskSnapshot taskSnapshot) {
switch (taskSnapshot.state) {
case TaskState.running:
final progress =
100.0 * (taskSnapshot.bytesTransferred / taskSnapshot.totalBytes);
print("Upload is $progress% complete.");
break;
case TaskState.paused:
print("Upload is paused.");
break;
case TaskState.canceled:
print("Upload was canceled");
break;
case TaskState.error:
// Handle unsuccessful uploads
break;
case TaskState.success:
// Handle successful uploads on complete
// ...
break;
}
});
अब आपने फ़ाइलें अपलोड कर ली हैं. आइए, अब Cloud Storage से उन्हें डाउनलोड करने का तरीका जानें.