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 (आम तौर पर, इसे एमआईएमई टाइप कहा जाता है). putFile() तरीका, File एक्सटेंशन से एमआईएमई टाइप का अपने-आप पता लगाता है. हालांकि, मेटाडेटा में 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 से उन्हें डाउनलोड करने का तरीका जानें.