הורדת קבצים באמצעות Cloud Storage בפלטפורמות של Apple

Cloud Storage for Firebase מאפשר להוריד במהירות ובקלות קבצים מ-Cloud Storage קטגוריה שסופקה ומנוהלת על ידי Firebase.

הערה: כברירת מחדל, בקטגוריה Cloud Storage נדרש Firebase Authentication לבצע פעולה כלשהי על הנתונים או הקבצים של הקטגוריה. אפשר שינוי Firebase Security Rules של Cloud Storage כדי לאפשר גישה לא מאומתת. מאחר ש-Firebase ואפליקציית App Engine שמוגדרת כברירת מחדל בפרויקט משתפים את הקטגוריה הזו, הגדרת גישה ציבורית עשויה לגרום לכך שקבצים חדשים של App Engine שהועלו יהיו נגישים לכולם. חשוב להקפיד להגביל גישה נוספת לקטגוריה של Cloud Storage כשמגדירים את Authentication.

יצירת קובץ עזר

כדי להוריד קובץ, קודם יצירת קובץ עזר של Cloud Storage לקובץ שרוצים להוריד.

אפשר ליצור הפניה על ידי צירוף נתיבים של צאצאים לשורש הקטגוריה Cloud Storage, או ליצור הפניה מכתובת URL קיימת מסוג gs:// או https:// שמפנה לאובייקט ב-Cloud Storage.

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 שמייצגת את הקובץ אונליין

הורדה בזיכרון

מורידים את הקובץ לאובייקט NSData בזיכרון באמצעות dataWithMaxSize:completion:. זו הדרך הקלה ביותר להוריד קובץ במהירות, אבל צריך לטעון את כל תוכן הקובץ לזיכרון. אם תבקשו קובץ גדול יותר מהזיכרון הזמין של האפליקציה, האפליקציה לקרוס. כדי להגן מפני בעיות זיכרון, חשוב להגדיר את הגודל המקסימלי למשהו שאתם יודעים שהאפליקציה יכולה לטפל בו, או להשתמש באמצעי אחר להוריד דרך האינטרנט.

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: ולצפות במשימת ההורדה, במקום להשתמש ב-handler של ההשלמה. מידע נוסף זמין במאמר ניהול ההורדות.

יצירת כתובת URL להורדה

אם כבר יש לכם תשתית הורדות המבוססת על כתובות URL, או אם אתם רק רוצים לכתובת אתר לשיתוף, תוכל לקבל את כתובת האתר להורדה של קובץ באמצעות קריאה downloadURLWithCompletion: בהפניה של Cloud Storage.

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 מספק קישורים מותאמים אישית ומוכנים לייצור שיעזרו לך לבטל את ההתאמה האישית קוד סטנדרטי (boilerplate) ולקדם את השיטות המומלצות של Google. בעזרת FirebaseUI אפשר להוריד, לשמור במטמון ולהציג תמונות במהירות ובקלות מ-Cloud Storage באמצעות השילוב שלנו עם SDWebImage.

קודם כול, מוסיפים את FirebaseUI אל Podfile:

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];
    

מעקב אחר התקדמות ההורדה

אפשר לצרף צופים ל-FIRStorageDownloadTask כדי לעקוב התקדמות ההורדה. הוספת צופה מחזירה 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 מועבר חזרה. קובץ ה-snapshot הוא תצוגה קבועה של המשימה, בזמן שהאירוע התרחש. האובייקט מכיל את המאפיינים (properties) הבאים:

נכס	סוג	תיאור
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.