Cloud Storage for Firebase की मदद से, Firebase की ओर से उपलब्ध कराई गई और मैनेज की जाने वाली Cloud Storage बकेट में फ़ाइलों को तेज़ी से और आसानी से अपलोड किया जा सकता है.
फ़ाइलें अपलोड करें
Cloud Storage में कोई फ़ाइल अपलोड करने के लिए, सबसे पहले फ़ाइल के पूरे पाथ का रेफ़रंस बनाएं. इसमें फ़ाइल का नाम भी शामिल होना चाहिए.
Kotlin+KTX
// 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+KTX
// 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+KTX
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+KTX
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+KTX
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+KTX
// 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+KTX
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
इंस्टेंस के साथ कॉल किया जाता है. अन्य Listener को 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+KTX
// 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+KTX
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+KTX
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+KTX
// 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);
सेशन एक हफ़्ते तक चलते हैं. अगर किसी सेशन की समयसीमा खत्म होने के बाद उसे फिर से शुरू करने की कोशिश की जाती है या उसमें कोई गड़बड़ी होती है, तो आपको 'कार्रवाई पूरी नहीं हो सकी' कॉलबैक मिलेगा. यह पक्का करना आपकी ज़िम्मेदारी है कि अपलोड के बीच फ़ाइल में कोई बदलाव न हुआ हो.
गड़बड़ी ठीक करना
अपलोड करने पर गड़बड़ियां होने की कई वजहें हो सकती हैं. जैसे, लोकल फ़ाइल मौजूद न होना या उपयोगकर्ता के पास अपनी पसंद की फ़ाइल अपलोड करने की अनुमति न होना. गड़बड़ियों के बारे में ज़्यादा जानकारी पाने के लिए, Docs के गड़बड़ियों को मैनेज करें सेक्शन पर जाएं.
पूरा उदाहरण
प्रोग्रेस मॉनिटर करने और गड़बड़ी को मैनेज करने के साथ अपलोड का पूरा उदाहरण यहां दिया गया है:
Kotlin+KTX
// 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 से उन्हें डाउनलोड करने का तरीका जानें.