Cloud Storage की मदद से, Apple प्लैटफ़ॉर्म पर फ़ाइलें डाउनलोड करना

Cloud Storage for Firebase की मदद से, Firebase की ओर से उपलब्ध कराई गई और मैनेज की जाने वाली Cloud Storage बकेट से, फ़ाइलों को तुरंत और आसानी से डाउनलोड किया जा सकता है.

ध्यान दें: डिफ़ॉल्ट रूप से, Cloud Storage for Firebase बकेट के डेटा या फ़ाइलों पर कोई कार्रवाई करने के लिए, Firebase Authentication को अनुमति की ज़रूरत होती है. कुछ खास मामलों में, पुष्टि किए बिना ऐक्सेस करने की अनुमति देने के लिए, Firebase Security Rules को Cloud Storage में बदला जा सकता है. हालांकि, ज़्यादातर मामलों में, हमारा सुझाव है कि आप ऐक्सेस पर पाबंदी लगाएं और सुरक्षा के सख्त नियम सेट अप करें. ऐसा खास तौर पर, प्रोडक्शन ऐप्लिकेशन के लिए करें. ध्यान दें कि अगर Google App Engine का इस्तेमाल किया जाता है और आपके पास *.appspot.com नाम वाले फ़ॉर्मैट वाली डिफ़ॉल्ट Cloud Storage बकेट है, तो आपको यह देखना पड़ सकता है कि आपके सुरक्षा नियम, App Engine फ़ाइलों के ऐक्सेस पर कैसे असर डालते हैं.

रेफ़रंस बनाना

किसी फ़ाइल को डाउनलोड करने के लिए, सबसे पहले उस फ़ाइल का Cloud Storage रेफ़रंस बनाएं जिसे डाउनलोड करना है.

Cloud Storage बकेट के रूट में चाइल्ड पाथ जोड़कर रेफ़रंस बनाया जा सकता है. इसके अलावा, Cloud Storage में मौजूद किसी ऑब्जेक्ट का रेफ़रंस देने वाले किसी मौजूदा gs:// या https:// यूआरएल से भी रेफ़रंस बनाया जा सकता है.

Swift

// Create a reference with an initial file path and name
let pathReference = storage.reference(withPath: "images/stars.jpg")

// Create a reference from a Google Cloud Storage URI
let gsReference = storage.reference(forURL: "gs://<your-firebase-storage-bucket>/images/stars.jpg")

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
let httpsReference = storage.reference(forURL: "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg")

Objective-C

// Create a reference with an initial file path and name
FIRStorageReference *pathReference = [storage referenceWithPath:@"images/stars.jpg"];

// Create a reference from a Google Cloud Storage URI
FIRStorageReference *gsReference = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>/images/stars.jpg"];

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
FIRStorageReference *httpsReference = [storage referenceForURL:@"https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg"];
  

फ़ाइलें डाउनलोड करना

रेफ़रंस मिलने के बाद, Cloud Storage से फ़ाइलें डाउनलोड करने के तीन तरीके हैं:

1. 'यादें' में NSData पर डाउनलोड करें
2. डिवाइस पर मौजूद फ़ाइल को NSURL पर डाउनलोड करना
3. फ़ाइल को ऑनलाइन दिखाने के लिए NSURL जनरेट करना

मेमोरी में डाउनलोड करना

dataWithMaxSize:completion: तरीके का इस्तेमाल करके, फ़ाइल को मेमोरी में मौजूद NSData ऑब्जेक्ट में डाउनलोड करें. किसी फ़ाइल को तेज़ी से डाउनलोड करने का यह सबसे आसान तरीका है. हालांकि, इसके लिए ज़रूरी है कि फ़ाइल का पूरा कॉन्टेंट मेमोरी में लोड हो. अगर आपने ऐसी फ़ाइल का अनुरोध किया है जिसका साइज़, आपके ऐप्लिकेशन में उपलब्ध मेमोरी से ज़्यादा है, तो आपका ऐप्लिकेशन क्रैश हो जाएगा. मेमोरी से जुड़ी समस्याओं से बचने के लिए, ऐप्लिकेशन के लिए डाउनलोड किए जाने वाले वीडियो का ज़्यादा से ज़्यादा साइज़, उतना ही सेट करें जितना आपका ऐप्लिकेशन हैंडल कर सकता है. इसके अलावा, वीडियो डाउनलोड करने का कोई दूसरा तरीका भी अपनाया जा सकता है.

Swift

// Create a reference to the file you want to download
let islandRef = storageRef.child("images/island.jpg")

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
islandRef.getData(maxSize: 1 * 1024 * 1024) { data, error in
  if let error = error {
    // Uh-oh, an error occurred!
  } else {
    // Data for "images/island.jpg" is returned
    let image = UIImage(data: data!)
  }
}
    

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"];

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
[islandRef dataWithMaxSize:1 * 1024 * 1024 completion:^(NSData *data, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Data for "images/island.jpg" is returned
    UIImage *islandImage = [UIImage imageWithData:data];
  }
}];
    

किसी लोकल फ़ाइल में डाउनलोड करना

writeToFile:completion: तरीका, किसी फ़ाइल को सीधे लोकल डिवाइस पर डाउनलोड करता है. अगर आपके उपयोगकर्ताओं को ऑफ़लाइन रहते हुए फ़ाइल का ऐक्सेस चाहिए या किसी दूसरे ऐप्लिकेशन में फ़ाइल शेयर करनी है, तो इसका इस्तेमाल करें. writeToFile:completion: एक FIRStorageDownloadTask दिखाता है. इसका इस्तेमाल करके, डाउनलोड को मैनेज किया जा सकता है और अपलोड की स्थिति को मॉनिटर किया जा सकता है.

Swift

// Create a reference to the file you want to download
let islandRef = storageRef.child("images/island.jpg")

// Create local filesystem URL
let localURL = URL(string: "path/to/image")!

// Download to the local filesystem
let downloadTask = islandRef.write(toFile: localURL) { url, error in
  if let error = error {
    // Uh-oh, an error occurred!
  } else {
    // Local file URL for "images/island.jpg" is returned
  }
}
    

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"];

// Create local filesystem URL
NSURL *localURL = [NSURL URLWithString:@"path/to/image"];

// Download to the local filesystem
FIRStorageDownloadTask *downloadTask = [islandRef writeToFile:localURL completion:^(NSURL *URL, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Local file URL for "images/island.jpg" is returned
  }
}];
    

अगर आपको डाउनलोड को मैनेज करना है, तो writeToFile: के तरीके का इस्तेमाल करें और डाउनलोड टास्क को देखें. इसके बजाय, टास्क पूरा होने के बाद होने वाली कार्रवाई करने वाले फ़ंक्शन का इस्तेमाल न करें. ज़्यादा जानकारी के लिए, डाउनलोड मैनेज करना लेख पढ़ें.

डाउनलोड करने के लिए यूआरएल जनरेट करना

अगर आपके पास पहले से ही यूआरएल पर आधारित डाउनलोड इन्फ़्रास्ट्रक्चर है या आपको सिर्फ़ शेयर करने के लिए कोई यूआरएल चाहिए, तो किसी फ़ाइल के लिए डाउनलोड यूआरएल पाया जा सकता है. इसके लिए, Cloud Storage रेफ़रंस पर downloadURLWithCompletion: तरीके को कॉल करें.

Swift

// Create a reference to the file you want to download
let starsRef = storageRef.child("images/stars.jpg")

// Fetch the download URL
starsRef.downloadURL { url, error in
  if let error = error {
    // Handle any errors
  } else {
    // Get the download URL for 'images/stars.jpg'
  }
}
    

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"];

// Fetch the download URL
[starsRef downloadURLWithCompletion:^(NSURL *URL, NSError *error){
  if (error != nil) {
    // Handle any errors
  } else {
    // Get the download URL for 'images/stars.jpg'
  }
}];
    

FirebaseUI की मदद से इमेज डाउनलोड करना

FirebaseUI, आसान, पसंद के मुताबिक बनाई जा सकने वाली, और प्रोडक्शन के लिए तैयार नेटिव मोबाइल बाइंडिंग उपलब्ध कराता है. इससे, बोइलरप्लेट कोड को हटाया जा सकता है और Google के सबसे सही तरीकों को बढ़ावा दिया जा सकता है. FirebaseUI का इस्तेमाल करके, Cloud Storage से इमेज को तेज़ी से और आसानी से डाउनलोड, कैश मेमोरी में सेव, और दिखाया जा सकता है. इसके लिए, SDWebImage के साथ हमारे इंटिग्रेशन का इस्तेमाल करें.

सबसे पहले, अपने Podfile में FirebaseUI जोड़ें:

pod 'FirebaseStorageUI'

इसके बाद, इमेज को सीधे Cloud Storage से UIImageView में लोड किया जा सकता है:

Swift

// Reference to an image file in Firebase Storage
let reference = storageRef.child("images/stars.jpg")

// UIImageView in your ViewController
let imageView: UIImageView = self.imageView

// Placeholder image
let placeholderImage = UIImage(named: "placeholder.jpg")

// Load the image using SDWebImage
imageView.sd_setImage(with: reference, placeholderImage: placeholderImage)
    

Objective-C

// Reference to an image file in Firebase Storage
FIRStorageReference *reference = [storageRef child:@"images/stars.jpg"];

// UIImageView in your ViewController
UIImageView *imageView = self.imageView;

// Placeholder image
UIImage *placeholderImage;

// Load the image using SDWebImage
[imageView sd_setImageWithStorageReference:reference placeholderImage:placeholderImage];
    

डाउनलोड मैनेज करना

डाउनलोड शुरू करने के अलावा, pause, resume, और cancel तरीकों का इस्तेमाल करके, डाउनलोड को रोका, फिर से शुरू किया, और रद्द किया जा सकता है. ये तरीके pause, resume, और cancel इवेंट जनरेट करते हैं, जिन्हें देखा जा सकता है.

Swift

// Start downloading a file
let downloadTask = storageRef.child("images/mountains.jpg").write(toFile: localFile)

// Pause the download
downloadTask.pause()

// Resume the download
downloadTask.resume()

// Cancel the download
downloadTask.cancel()
    

Objective-C

// Start downloading a file
FIRStorageDownloadTask *downloadTask = [[storageRef child:@"images/mountains.jpg"] writeToFile:localFile];

// Pause the download
[downloadTask pause];

// Resume the download
[downloadTask resume];

// Cancel the download
[downloadTask cancel];
    

डाउनलोड की प्रोग्रेस मॉनिटर करना

डाउनलोड की प्रोग्रेस को मॉनिटर करने के लिए, FIRStorageDownloadTasks में ऑब्ज़र्वर जोड़े जा सकते हैं. ऑब्ज़र्वर जोड़ने पर, एक FIRStorageHandle मिलता है. इसका इस्तेमाल, ऑब्ज़र्वर को हटाने के लिए किया जा सकता है.

Swift

// Add a progress observer to a download task
let observer = downloadTask.observe(.progress) { snapshot in
  // A progress event occurred
}
    

Objective-C

// Add a progress observer to a download task
FIRStorageHandle observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress
                                                handler:^(FIRStorageTaskSnapshot *snapshot) {
                                                  // A progress event occurred
                                                }];
    

इन ऑब्ज़र्वर को FIRStorageTaskStatus इवेंट के लिए रजिस्टर किया जा सकता है:

`FIRStorageTaskStatus` इवेंट	आम तौर पर इस्तेमाल करने का तरीका
FIRStorageTaskStatusResume	यह इवेंट तब ट्रिगर होता है, जब टास्क डाउनलोड होना शुरू होता है या फिर से शुरू होता है. साथ ही, इसका इस्तेमाल अक्सर FIRStorageTaskStatusPause इवेंट के साथ किया जाता है.
FIRStorageTaskStatusProgress	यह इवेंट तब ट्रिगर होता है, जब Cloud Storage से डेटा डाउनलोड किया जाता है. इसका इस्तेमाल, डाउनलोड की प्रोग्रेस के इंडिकेटर को पॉप्युलेट करने के लिए किया जा सकता है.
FIRStorageTaskStatusPause	यह इवेंट तब ट्रिगर होता है, जब डाउनलोड रोका जाता है. आम तौर पर, इसका इस्तेमाल FIRStorageTaskStatusResume इवेंट के साथ किया जाता है.
FIRStorageTaskStatusSuccess	यह इवेंट तब ट्रिगर होता है, जब डाउनलोड पूरा हो जाता है.
FIRStorageTaskStatusFailure	यह इवेंट तब ट्रिगर होता है, जब डाउनलोड पूरा नहीं हो पाता. गड़बड़ी की वजह का पता लगाने के लिए, गड़बड़ी की जानकारी देखें.

जब कोई इवेंट होता है, तो FIRStorageTaskSnapshot ऑब्जेक्ट वापस पास किया जाता है. यह स्नैपशॉट, इवेंट होने के समय टास्क का ऐसा व्यू होता है जिसमें बदलाव नहीं किया जा सकता. इस ऑब्जेक्ट में ये प्रॉपर्टी शामिल हैं:

प्रॉपर्टी	टाइप	ब्यौरा
progress	NSProgress	डाउनलोड की प्रोग्रेस दिखाने वाला NSProgress ऑब्जेक्ट.
error	NSError	डाउनलोड करने के दौरान हुई गड़बड़ी, अगर कोई हो.
metadata	FIRStorageMetadata	nil पर जाएं.
task	FIRStorageDownloadTask	इस टास्क का स्नैपशॉट, जिसका इस्तेमाल टास्क को मैनेज करने के लिए किया जा सकता है (pause, resume, cancel).
reference	FIRStorageReference	वह रेफ़रंस जिससे यह टास्क आया है.

ऑब्ज़र्वर को एक-एक करके, स्थिति के हिसाब से या सभी को एक साथ भी हटाया जा सकता है.

Swift

// Create a task listener handle
let observer = downloadTask.observe(.progress) { snapshot in
// A progress event occurred
}

// Remove an individual observer
downloadTask.removeObserver(withHandle: observer)

// Remove all observers of a particular status
downloadTask.removeAllObservers(for: .progress)

// Remove all observers
downloadTask.removeAllObservers()
    

Objective-C

// Create a task listener handle
FIRStorageHandle observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress
                                                handler:^(FIRStorageTaskSnapshot *snapshot) {
                                                  // A progress event occurred
                                                }];

// Remove an individual observer
[downloadTask removeObserverWithHandle:observer];

// Remove all observers of a particular status
[downloadTask removeAllObserversForStatus:FIRStorageTaskStatusProgress];

// Remove all observers
[downloadTask removeAllObservers];
    

मेमोरी लीक को रोकने के लिए, FIRStorageTaskStatusSuccess या FIRStorageTaskStatusFailure होने के बाद सभी ऑब्ज़र्वर हटा दिए जाते हैं.

गड़बड़ियां ठीक करना

डाउनलोड करते समय गड़बड़ियां होने की कई वजहें हो सकती हैं. जैसे, फ़ाइल मौजूद न होना या उपयोगकर्ता के पास फ़ाइल को ऐक्सेस करने की अनुमति न होना. गड़बड़ियों के बारे में ज़्यादा जानकारी पाने के लिए, दस्तावेज़ों के गड़बड़ियों को मैनेज करें सेक्शन पर जाएं.

पूरा उदाहरण

गड़बड़ी को मैनेज करने के साथ-साथ, किसी लोकल फ़ाइल में डाउनलोड करने का पूरा उदाहरण यहां दिया गया है:

Swift

// Create a reference to the file we want to download
let starsRef = storageRef.child("images/stars.jpg")

// Start the download (in this case writing to a file)
let downloadTask = storageRef.write(toFile: localURL)

// Observe changes in status
downloadTask.observe(.resume) { snapshot in
  // Download resumed, also fires when the download starts
}

downloadTask.observe(.pause) { snapshot in
  // Download paused
}

downloadTask.observe(.progress) { snapshot in
  // Download reported progress
  let percentComplete = 100.0 * Double(snapshot.progress!.completedUnitCount)
    / Double(snapshot.progress!.totalUnitCount)
}

downloadTask.observe(.success) { snapshot in
  // Download completed successfully
}

// Errors only occur in the "Failure" case
downloadTask.observe(.failure) { snapshot in
  guard let errorCode = (snapshot.error as? NSError)?.code else {
    return
  }
  guard let error = StorageErrorCode(rawValue: errorCode) else {
    return
  }
  switch (error) {
  case .objectNotFound:
    // File doesn't exist
    break
  case .unauthorized:
    // User doesn't have permission to access file
    break
  case .cancelled:
    // User cancelled the download
    break

  /* ... */

  case .unknown:
    // Unknown error occurred, inspect the server response
    break
  default:
    // Another error occurred. This is a good place to retry the download.
    break
  }
}
    

Objective-C

// Create a reference to the file we want to download
FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"];

// Start the download (in this case writing to a file)
FIRStorageDownloadTask *downloadTask = [storageRef writeToFile:localURL];

// Observe changes in status
[downloadTask observeStatus:FIRStorageTaskStatusResume handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download resumed, also fires when the download starts
}];

[downloadTask observeStatus:FIRStorageTaskStatusPause handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download paused
}];

[downloadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download reported progress
  double percentComplete = 100.0 * (snapshot.progress.completedUnitCount) / (snapshot.progress.totalUnitCount);
}];

[downloadTask observeStatus:FIRStorageTaskStatusSuccess handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download completed successfully
}];

// Errors only occur in the "Failure" case
[downloadTask observeStatus:FIRStorageTaskStatusFailure handler:^(FIRStorageTaskSnapshot *snapshot) {
  if (snapshot.error != nil) {
    switch (snapshot.error.code) {
      case FIRStorageErrorCodeObjectNotFound:
        // File doesn't exist
        break;

      case FIRStorageErrorCodeUnauthorized:
        // User doesn't have permission to access file
        break;

      case FIRStorageErrorCodeCancelled:
        // User canceled the upload
        break;

      /* ... */

      case FIRStorageErrorCodeUnknown:
        // Unknown error occurred, inspect the server response
        break;
    }
  }
}];
    

Cloud Storage में सेव की गई फ़ाइलों के लिए, मेटाडेटा पाया और अपडेट भी जा सकता है.