फायरबेस के लिए क्लाउड स्टोरेज आपको फायरबेस द्वारा प्रदान और प्रबंधित क्लाउड स्टोरेज बकेट में फ़ाइलों को जल्दी और आसानी से अपलोड करने की अनुमति देता है।
फाइलें अपलोड करें
किसी फ़ाइल को क्लाउड स्टोरेज पर अपलोड करने के लिए, आप पहले फ़ाइल नाम सहित फ़ाइल के पूर्ण पथ का एक संदर्भ बनाते हैं।
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
एक बार जब आप उचित संदर्भ बना लेते हैं, तो आप फ़ाइल को क्लाउड स्टोरेज पर अपलोड करने के लिए putBytes()
, putFile()
, या putStream()
विधि को कॉल करते हैं।
आप अपने क्लाउड स्टोरेज बकेट के रूट के संदर्भ में डेटा अपलोड नहीं कर सकते। आपका संदर्भ किसी चाइल्ड यूआरएल की ओर इंगित करना चाहिए।
मेमोरी में डेटा से अपलोड करें
क्लाउड स्टोरेज पर फ़ाइल अपलोड करने के लिए putBytes()
विधि सबसे सरल तरीका है। 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()
विधि सबसे बहुमुखी तरीका है। 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
प्रदान नहीं करते हैं और क्लाउड स्टोरेज फ़ाइल एक्सटेंशन से डिफ़ॉल्ट का अनुमान नहीं लगा सकता है, तो क्लाउड स्टोरेज 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);
अपलोड प्रबंधित करें
अपलोड शुरू करने के अलावा, आप stop pause()
और cancel()
तरीकों का उपयोग करके अपलोड को रोक सकते हैं, resume()
और रद्द कर सकते हैं। घटनाओं को रोकें और फिर से शुरू करें, क्रमशः 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 | एक यूआरआई जिसका उपयोग पुटफ़ाइल पर किसी अन्य कॉल के माध्यम से इस कार्य को जारी रखने के लिए किया जा सकता है। |
getMetadata | StorageMetadata | अपलोड पूरा होने से पहले, यह मेटाडेटा सर्वर पर भेजा जा रहा है। अपलोड पूरा होने के बाद, यह सर्वर द्वारा लौटाया गया मेटाडेटा है। |
getTask | UploadTask | वह कार्य जिसने यह स्नैपशॉट बनाया. अपलोड को रद्द करने, रोकने या फिर से शुरू करने के लिए इस कार्य का उपयोग करें। |
getStorage | StorageReference | StorageReference का उपयोग UploadTask बनाने के लिए किया जाता है। |
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 // ... } });
अब जब आपने फ़ाइलें अपलोड कर दी हैं, तो आइए जानें कि उन्हें क्लाउड स्टोरेज से कैसे डाउनलोड किया जाए ।