Cloud Storage for Firebase की मदद से, Firebase की ओर से उपलब्ध कराई गई और मैनेज की जाने वाली Cloud Storage बकेट में, फ़ाइलों को तेज़ी से और आसानी से अपलोड किया जा सकता है.
फ़ाइलें अपलोड करें
Cloud Storage पर कोई फ़ाइल अपलोड करने के लिए, सबसे पहले फ़ाइल के पूरे पाथ का रेफ़रंस बनाएं. इसमें फ़ाइल का नाम भी शामिल करें.
Kotlin
// Create a storage reference from our app val storageRef = storage.reference // Create a reference to "mountains.jpg" val mountainsRef = storageRef.child("mountains.jpg") // Create a reference to 'images/mountains.jpg' val mountainImagesRef = storageRef.child("images/mountains.jpg") // While the file names are the same, the references point to different files mountainsRef.name == mountainImagesRef.name // true mountainsRef.path == mountainImagesRef.path // false
Java
// Create a storage reference from our app StorageReference storageRef = storage.getReference(); // Create a reference to "mountains.jpg" StorageReference mountainsRef = storageRef.child("mountains.jpg"); // Create a reference to 'images/mountains.jpg' StorageReference mountainImagesRef = storageRef.child("images/mountains.jpg"); // While the file names are the same, the references point to different files mountainsRef.getName().equals(mountainImagesRef.getName()); // true mountainsRef.getPath().equals(mountainImagesRef.getPath()); // false
सही रेफ़रंस बनाने के बाद, Cloud Storage पर फ़ाइल अपलोड करने के लिए, putBytes(), putFile() या putStream() तरीके को कॉल करें.
Cloud Storage बकेट के रूट के रेफ़रंस के साथ डेटा अपलोड नहीं किया जा सकता. आपका रेफ़रंस, किसी चाइल्ड यूआरएल पर ले जाना चाहिए.
मेमोरी में मौजूद डेटा से अपलोड करना
putBytes() तरीका, Cloud Storage पर फ़ाइल अपलोड करने का सबसे आसान तरीका है. putBytes(), byte[] लेता है और UploadTask दिखाता है. इसका इस्तेमाल करके, अपलोड की स्थिति को मैनेज और मॉनिटर किया जा सकता है.
Kotlin
// Get the data from an ImageView as bytes imageView.isDrawingCacheEnabled = true imageView.buildDrawingCache() val bitmap = (imageView.drawable as BitmapDrawable).bitmap val baos = ByteArrayOutputStream() bitmap.compress(Bitmap.CompressFormat.JPEG, 100, baos) val data = baos.toByteArray() var uploadTask = mountainsRef.putBytes(data) uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
// Get the data from an ImageView as bytes imageView.setDrawingCacheEnabled(true); imageView.buildDrawingCache(); Bitmap bitmap = ((BitmapDrawable) imageView.getDrawable()).getBitmap(); ByteArrayOutputStream baos = new ByteArrayOutputStream(); bitmap.compress(Bitmap.CompressFormat.JPEG, 100, baos); byte[] data = baos.toByteArray(); UploadTask uploadTask = mountainsRef.putBytes(data); uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
putBytes(), byte[] को स्वीकार करता है. इसलिए, आपके ऐप्लिकेशन को एक बार में फ़ाइल का पूरा कॉन्टेंट मेमोरी में सेव करना होगा. कम मेमोरी इस्तेमाल करने के लिए, putStream() या putFile() का इस्तेमाल करें.
स्ट्रीम से अपलोड करना
putStream() तरीका, Cloud Storage में फ़ाइल अपलोड करने का सबसे आसान तरीका है. putStream(), InputStream लेता है और UploadTask दिखाता है. इसका इस्तेमाल करके, अपलोड की स्थिति को मैनेज और मॉनिटर किया जा सकता है.
Kotlin
val stream = FileInputStream(File("path/to/images/rivers.jpg")) uploadTask = mountainsRef.putStream(stream) uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
InputStream stream = new FileInputStream(new File("path/to/images/rivers.jpg")); uploadTask = mountainsRef.putStream(stream); uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
लोकल फ़ाइल से अपलोड करना
डिवाइस पर मौजूद लोकल फ़ाइलें अपलोड की जा सकती हैं. जैसे, कैमरे से ली गई फ़ोटो और वीडियो. इसके लिए, putFile() तरीके का इस्तेमाल करें. putFile(), File लेता है और UploadTask दिखाता है. इसका इस्तेमाल करके, अपलोड की स्थिति को मैनेज और मॉनिटर किया जा सकता है.
Kotlin
var file = Uri.fromFile(File("path/to/images/rivers.jpg")) val riversRef = storageRef.child("images/${file.lastPathSegment}") uploadTask = riversRef.putFile(file) // Register observers to listen for when the download is done or if it fails uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
Uri file = Uri.fromFile(new File("path/to/images/rivers.jpg")); StorageReference riversRef = storageRef.child("images/"+file.getLastPathSegment()); uploadTask = riversRef.putFile(file); // Register observers to listen for when the download is done or if it fails uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
डाउनलोड करने के लिए यूआरएल पाना
फ़ाइल अपलोड करने के बाद, उसे डाउनलोड करने के लिए यूआरएल पाया जा सकता है. इसके लिए, StorageReference पर getDownloadUrl() तरीके को कॉल करें:
Kotlin
val ref = storageRef.child("images/mountains.jpg") uploadTask = ref.putFile(file) val urlTask = uploadTask.continueWithTask { task -> if (!task.isSuccessful) { task.exception?.let { throw it } } ref.downloadUrl }.addOnCompleteListener { task -> if (task.isSuccessful) { val downloadUri = task.result } else { // Handle failures // ... } }
Java
final StorageReference ref = storageRef.child("images/mountains.jpg"); uploadTask = ref.putFile(file); Task<Uri> urlTask = uploadTask.continueWithTask(new Continuation<UploadTask.TaskSnapshot, Task<Uri>>() { @Override public Task<Uri> then(@NonNull Task<UploadTask.TaskSnapshot> task) throws Exception { if (!task.isSuccessful()) { throw task.getException(); } // Continue with the task to get the download URL return ref.getDownloadUrl(); } }).addOnCompleteListener(new OnCompleteListener<Uri>() { @Override public void onComplete(@NonNull Task<Uri> task) { if (task.isSuccessful()) { Uri downloadUri = task.getResult(); } else { // Handle failures // ... } } });
फ़ाइल का मेटाडेटा जोड़ना
फ़ाइलें अपलोड करते समय, मेटाडेटा भी शामिल किया जा सकता है.
इस मेटाडेटा में, फ़ाइल के मेटाडेटा की सामान्य प्रॉपर्टी शामिल होती हैं. जैसे, name, size, और contentType (आम तौर पर, इसे एमआईएमई टाइप कहा जाता है). putFile() तरीका, File एक्सटेंशन से एमआईएमई टाइप का अपने-आप पता लगाता है. हालांकि, मेटाडेटा में contentType की जानकारी देकर, अपने-आप पता लगाए गए टाइप को बदला जा सकता है. अगर आपने contentType नहीं दिया है और Cloud Storage फ़ाइल एक्सटेंशन से डिफ़ॉल्ट वैल्यू का अनुमान नहीं लगा पाता है, तो Cloud Storage, application/octet-stream का इस्तेमाल करता है. फ़ाइल के मेटाडेटा के बारे में ज़्यादा जानने के लिए, फ़ाइल के मेटाडेटा का इस्तेमाल करना सेक्शन देखें.
Kotlin
// Create file metadata including the content type var metadata = storageMetadata { contentType = "image/jpg" } // Upload the file and metadata uploadTask = storageRef.child("images/mountains.jpg").putFile(file, metadata)
Java
// Create file metadata including the content type StorageMetadata metadata = new StorageMetadata.Builder() .setContentType("image/jpg") .build(); // Upload the file and metadata uploadTask = storageRef.child("images/mountains.jpg").putFile(file, metadata);
अपलोड प्रबंधित करें
अपलोड शुरू करने के अलावा, pause(), resume(), और cancel() तरीकों का इस्तेमाल करके, अपलोड को रोका जा सकता है, फिर से शुरू किया जा सकता है, और रद्द किया जा सकता है. इवेंट को रोकने और फिर से शुरू करने से,
क्रमशः pause और progress स्टेटस में बदलाव होते हैं. अपलोड की प्रोसेस रद्द करने पर, अपलोड नहीं हो पाता है. साथ ही, एक गड़बड़ी का मैसेज दिखता है, जिसमें बताया जाता है कि अपलोड की प्रोसेस रद्द कर दी गई है.
Kotlin
uploadTask = storageRef.child("images/mountains.jpg").putFile(file) // Pause the upload uploadTask.pause() // Resume the upload uploadTask.resume() // Cancel the upload uploadTask.cancel()
Java
uploadTask = storageRef.child("images/mountains.jpg").putFile(file); // Pause the upload uploadTask.pause(); // Resume the upload uploadTask.resume(); // Cancel the upload uploadTask.cancel();
अपलोड होने की प्रोग्रेस को मॉनिटर करना
अपलोड टास्क के पूरा होने, पूरा न होने, प्रोग्रेस या रुकने की स्थिति को मैनेज करने के लिए, लिसनर जोड़े जा सकते हैं:
| लिसनर का टाइप | आम तौर पर इस्तेमाल |
|---|---|
OnProgressListener |
डेटा ट्रांसफ़र होने पर, इस लिसनर को समय-समय पर कॉल किया जाता है. इसका इस्तेमाल, अपलोड/डाउनलोड इंडिकेटर को पॉप्युलेट करने के लिए किया जा सकता है. |
OnPausedListener |
टास्क के रोके जाने पर, इस लिसनर को कॉल किया जाता है. |
OnSuccessListener |
टास्क पूरा होने पर, इस लिसनर को कॉल किया जाता है. |
OnFailureListener |
अपलोड न हो पाने पर, इस लिसनर को कॉल किया जाता है. ऐसा नेटवर्क टाइम आउट होने, अनुमति न मिलने या टास्क रद्द करने की वजह से हो सकता है. |
OnFailureListener को Exception इंस्टेंस के साथ कॉल किया जाता है. अन्य लिसनर को UploadTask.TaskSnapshot ऑब्जेक्ट के साथ कॉल किया जाता है.
यह ऑब्जेक्ट, इवेंट के समय टास्क का ऐसा व्यू है जिसमें बदलाव नहीं किया जा सकता.
UploadTask.TaskSnapshot में ये प्रॉपर्टी शामिल होती हैं:
| प्रॉपर्टी | टाइप | ब्यौरा |
|---|---|---|
getDownloadUrl |
String |
ऐसा यूआरएल जिसका इस्तेमाल करके ऑब्जेक्ट को डाउनलोड किया जा सकता है. यह एक सार्वजनिक यूआरएल है जिसका अनुमान नहीं लगाया जा सकता. इसे अन्य क्लाइंट के साथ शेयर किया जा सकता है. अपलोड पूरा होने के बाद, यह वैल्यू अपने-आप भर जाती है. |
getError |
Exception |
अगर टास्क पूरा नहीं हुआ, तो इसमें अपवाद के तौर पर इसकी वजह शामिल होगी. |
getBytesTransferred |
long |
यह स्नैपशॉट लेते समय, ट्रांसफ़र किए गए बाइट की कुल संख्या. |
getTotalByteCount |
long |
अपलोड किए जाने वाले बाइट की कुल संख्या. |
getUploadSessionUri |
String |
एक यूआरआई, जिसका इस्तेमाल putFile को किए जाने वाले किसी अन्य कॉल के ज़रिए, इस टास्क को जारी रखने के लिए किया जा सकता है. |
getMetadata |
StorageMetadata |
अपलोड पूरा होने से पहले, यह मेटाडेटा सर्वर को भेजा जाता है. अपलोड पूरा होने के बाद, सर्वर से यह मेटाडेटा मिलता है. |
getTask |
UploadTask |
वह टास्क जिसकी वजह से यह स्नैपशॉट बना. अपलोड की प्रोसेस को रद्द करने, रोकने या फिर से शुरू करने के लिए, इस टास्क का इस्तेमाल करें. |
getStorage |
StorageReference |
UploadTask बनाने के लिए इस्तेमाल किया गया StorageReference. |
UploadTask इवेंट लिसनर, अपलोड इवेंट को मॉनिटर करने का एक आसान और असरदार तरीका उपलब्ध कराते हैं.
Kotlin
// Observe state change events such as progress, pause, and resume // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 uploadTask.addOnProgressListener { (bytesTransferred, totalByteCount) -> val progress = (100.0 * bytesTransferred) / totalByteCount Log.d(TAG, "Upload is $progress% done") }.addOnPausedListener { Log.d(TAG, "Upload is paused") }
Java
// Observe state change events such as progress, pause, and resume uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { double progress = (100.0 * taskSnapshot.getBytesTransferred()) / taskSnapshot.getTotalByteCount(); Log.d(TAG, "Upload is " + progress + "% done"); } }).addOnPausedListener(new OnPausedListener<UploadTask.TaskSnapshot>() { @Override public void onPaused(UploadTask.TaskSnapshot taskSnapshot) { Log.d(TAG, "Upload is paused"); } });
ऐक्टिविटी लाइफ़साइकल में होने वाले बदलावों को मैनेज करना
गतिविधि पूरी होने की प्रोसेस में बदलाव होने के बाद भी, बैकग्राउंड में अपलोड जारी रहते हैं. जैसे, कोई डायलॉग दिखाना या स्क्रीन को घुमाना. आपने जो भी लिसनर अटैच किए थे वे भी अटैच रहेंगे. अगर गतिविधि बंद होने के बाद उन्हें कॉल किया जाता है, तो इससे अनचाहे नतीजे मिल सकते हैं.
इस समस्या को हल करने के लिए, अपने लिसनर को गतिविधि के स्कोप के साथ रजिस्टर करें. इससे गतिविधि बंद होने पर, वे अपने-आप अनरजिस्टर हो जाएंगे. इसके बाद, गतिविधि के फिर से शुरू होने पर getActiveUploadTasks तरीके का इस्तेमाल करें, ताकि अपलोड करने के ऐसे टास्क हासिल किए जा सकें जो अब भी चल रहे हैं या हाल ही में पूरे हुए हैं.
यहां दिए गए उदाहरण में, इस तरीके को दिखाया गया है. साथ ही, इस्तेमाल किए गए स्टोरेज के रेफ़रंस पाथ को बनाए रखने का तरीका भी बताया गया है.
Kotlin
override fun onSaveInstanceState(outState: Bundle) { super.onSaveInstanceState(outState) // If there's an upload in progress, save the reference so you can query it later outState.putString("reference", storageRef.toString()) } override fun onRestoreInstanceState(savedInstanceState: Bundle) { super.onRestoreInstanceState(savedInstanceState) // If there was an upload in progress, get its reference and create a new StorageReference val stringRef = savedInstanceState.getString("reference") ?: return storageRef = Firebase.storage.getReferenceFromUrl(stringRef) // Find all UploadTasks under this StorageReference (in this example, there should be one) val tasks = storageRef.activeUploadTasks if (tasks.size > 0) { // Get the task monitoring the upload val task = tasks[0] // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this) { // Success! // ... } } }
Java
@Override protected void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); // If there's an upload in progress, save the reference so you can query it later if (mStorageRef != null) { outState.putString("reference", mStorageRef.toString()); } } @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); // If there was an upload in progress, get its reference and create a new StorageReference final String stringRef = savedInstanceState.getString("reference"); if (stringRef == null) { return; } mStorageRef = FirebaseStorage.getInstance().getReferenceFromUrl(stringRef); // Find all UploadTasks under this StorageReference (in this example, there should be one) List<UploadTask> tasks = mStorageRef.getActiveUploadTasks(); if (tasks.size() > 0) { // Get the task monitoring the upload UploadTask task = tasks.get(0); // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this, new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot state) { // Success! // ... } }); } }
getActiveUploadTasks, दिए गए रेफ़रंस और उससे नीचे के सभी चालू अपलोड टास्क को वापस लाता है. इसलिए, आपको कई टास्क मैनेज करने पड़ सकते हैं.
प्रोसेस रीस्टार्ट होने पर भी अपलोड जारी रखना
अगर आपकी प्रोसेस बंद हो जाती है, तो अपलोड किए जा रहे वीडियो की प्रोसेस में रुकावट आएगी. हालांकि, प्रोसेस फिर से शुरू होने पर, सर्वर के साथ अपलोड सेशन को फिर से शुरू करके, अपलोड करना जारी रखा जा सकता है. इससे फ़ाइल को शुरुआत से अपलोड करने की ज़रूरत नहीं पड़ती. इससे समय और बैंडविड्थ की बचत होती है.
इसके लिए, putFile से अपलोड करना शुरू करें. नतीजे के तौर पर मिले StorageTask पर,
getUploadSessionUri को कॉल करें और नतीजे के तौर पर मिली वैल्यू को स्थायी स्टोरेज में सेव करें
(जैसे, SharedPreferences).
Kotlin
uploadTask = storageRef.putFile(localFile) uploadTask.addOnProgressListener { taskSnapshot -> sessionUri = taskSnapshot.uploadSessionUri if (sessionUri != null && !saved) { saved = true // A persisted session has begun with the server. // Save this to persistent storage in case the process dies. } }
Java
uploadTask = mStorageRef.putFile(localFile); uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { Uri sessionUri = taskSnapshot.getUploadSessionUri(); if (sessionUri != null && !mSaved) { mSaved = true; // A persisted session has begun with the server. // Save this to persistent storage in case the process dies. } } });
अपलोड की प्रोसेस में रुकावट आने के बाद, जब प्रोसेस फिर से शुरू हो जाए, तो putFile को फिर से कॉल करें. हालांकि, इस बार वह यूआरआई भी पास करें जिसे सेव किया गया था.
Kotlin
// resume the upload task from where it left off when the process died. // to do this, pass the sessionUri as the last parameter uploadTask = storageRef.putFile( localFile, storageMetadata { }, sessionUri, )
Java
//resume the upload task from where it left off when the process died. //to do this, pass the sessionUri as the last parameter uploadTask = mStorageRef.putFile(localFile, new StorageMetadata.Builder().build(), sessionUri);
सेशन एक हफ़्ते तक चलते हैं. अगर किसी सेशन के खत्म होने या उसमें कोई गड़बड़ी होने के बाद, उसे फिर से शुरू करने की कोशिश की जाती है, तो आपको गड़बड़ी का कॉलबैक मिलेगा. यह पक्का करना आपकी ज़िम्मेदारी है कि अपलोड के बीच फ़ाइल में कोई बदलाव न हुआ हो.
गड़बड़ी ठीक करना
अपलोड करते समय गड़बड़ियां होने की कई वजहें हो सकती हैं. जैसे, लोकल फ़ाइल मौजूद न होना या उपयोगकर्ता के पास अपनी पसंद की फ़ाइल अपलोड करने की अनुमति न होना. दस्तावेज़ों के गड़बड़ियों को ठीक करें सेक्शन में, गड़बड़ियों के बारे में ज़्यादा जानकारी मिल सकती है.
पूरी जानकारी वाला उदाहरण
अपलोड की प्रोसेस की प्रोग्रेस को मॉनिटर करने और गड़बड़ी को ठीक करने का पूरा उदाहरण यहां दिया गया है:
Kotlin
// File or Blob file = Uri.fromFile(File("path/to/mountains.jpg")) // Create the file metadata metadata = storageMetadata { contentType = "image/jpeg" } // Upload file and metadata to the path 'images/mountains.jpg' uploadTask = storageRef.child("images/${file.lastPathSegment}").putFile(file, metadata) // Listen for state changes, errors, and completion of the upload. // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 uploadTask.addOnProgressListener { (bytesTransferred, totalByteCount) -> val progress = (100.0 * bytesTransferred) / totalByteCount Log.d(TAG, "Upload is $progress% done") }.addOnPausedListener { Log.d(TAG, "Upload is paused") }.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { // Handle successful uploads on complete // ... }
Java
// File or Blob file = Uri.fromFile(new File("path/to/mountains.jpg")); // Create the file metadata metadata = new StorageMetadata.Builder() .setContentType("image/jpeg") .build(); // Upload file and metadata to the path 'images/mountains.jpg' uploadTask = storageRef.child("images/"+file.getLastPathSegment()).putFile(file, metadata); // Listen for state changes, errors, and completion of the upload. uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { double progress = (100.0 * taskSnapshot.getBytesTransferred()) / taskSnapshot.getTotalByteCount(); Log.d(TAG, "Upload is " + progress + "% done"); } }).addOnPausedListener(new OnPausedListener<UploadTask.TaskSnapshot>() { @Override public void onPaused(UploadTask.TaskSnapshot taskSnapshot) { Log.d(TAG, "Upload is paused"); } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // Handle successful uploads on complete // ... } });
फ़ाइलें अपलोड करने के बाद, चलिए Cloud Storage से उन्हें डाउनलोड करने का तरीक़ा जानते हैं.