'Firebase के लिए Cloud Storage' की मदद से, फ़ाइलों को तेज़ी और आसानी से Cloud Storage बकेट में अपलोड किया जा सकता है. यह बकेट, Firebase से मैनेज की जाती है और दी जाती है.
फ़ाइलें अपलोड करें
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
(इसे आम तौर पर MIME टाइप कहा जाता है). putFile()
तरीका, File
एक्सटेंशन से MIME टाइप का अपने-आप अनुमान लगा लेता है. हालांकि, मेटाडेटा में 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
इंस्टेंस के साथ कॉल किया जाता है. दूसरे पॉडकास्ट सुनने वालों को UploadTask.TaskSnapshot
ऑब्जेक्ट के साथ कॉल किया जाता है.
इवेंट के समय यह ऑब्जेक्ट टास्क का ऐसा व्यू है जिसमें बदलाव नहीं किया जा सकता.
UploadTask.TaskSnapshot
में ये प्रॉपर्टी शामिल होती हैं:
प्रॉपर्टी | टाइप | जानकारी |
---|---|---|
getDownloadUrl |
String |
ऐसा यूआरएल जिसका इस्तेमाल ऑब्जेक्ट को डाउनलोड करने के लिए किया जा सकता है. यह सार्वजनिक तौर पर दिखने वाला ऐसा यूआरएल है जिसे पहचाना नहीं जा सकता. इसे अन्य क्लाइंट के साथ शेयर किया जा सकता है. अपलोड पूरा होने के बाद, यह वैल्यू अपने-आप भर जाती है. |
getError |
Exception |
अगर टास्क पूरा नहीं हो पाता है, तो अपवाद के तौर पर ऐसा किया जाएगा. |
getBytesTransferred |
long |
इस स्नैपशॉट को लेने के दौरान, ट्रांसफ़र किए गए बाइट की कुल संख्या. |
getTotalByteCount |
long |
अपलोड किए जाने वाले बाइट की कुल संख्या. |
getUploadSessionUri |
String |
एक यूआरआई, जिसका इस्तेमाल इस टास्क को दूसरे कॉल के ज़रिए enterFile पर जारी रखने के लिए किया जा सकता है. |
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);
पिछले एक हफ़्ते के सेशन. अगर सेशन की समयसीमा खत्म होने के बाद उसे फिर से शुरू करने की कोशिश की जाती है या उसमें कोई गड़बड़ी हुई थी, तो आपको फ़ेलियर कॉलबैक मिलेगा. यह पक्का करना आपकी ज़िम्मेदारी है कि अलग-अलग अपलोड के बीच फ़ाइल में कोई बदलाव न हो.
गड़बड़ी ठीक करना
अपलोड करते समय गड़बड़ियां होने की कई वजहें हो सकती हैं. जैसे, डिवाइस पर मौजूद फ़ाइल का मौजूद न होना या उपयोगकर्ता को अपनी पसंद की फ़ाइल अपलोड करने की अनुमति न होना. आपको दस्तावेज़ों के गड़बड़ियां मैनेज करना सेक्शन में, गड़बड़ियों के बारे में ज़्यादा जानकारी मिल सकती है.
पूरा उदाहरण
प्रोग्रेस मॉनिटर करने और गड़बड़ियों को ठीक करने के तरीके के साथ अपलोड का पूरा उदाहरण नीचे दिया गया है:
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 से उन्हें डाउनलोड करने का तरीका जानें.