Cloud Storage for Firebase מאפשר לך להוריד במהירות ובקלות קבצים מ- Cloud Storage שסופק ומנוהל על ידי Firebase.
צור הפניה
כדי להוריד קובץ, תחילה צור הפניה ל-Cloud Storage לקובץ שברצונך להוריד.
אתה יכול ליצור הפניה על ידי הוספת נתיבים צאצאים לשורש של דלי Cloud Storage שלך, או שאתה יכול ליצור הפניה מכתובת URL קיימת של gs://
או https://
המפנה לאובייקט ב-Cloud Storage.
מָהִיר
// 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 בשלוש דרכים:
- הורד ל-
NSData
בזיכרון - הורד ל-
NSURL
המייצג קובץ במכשיר - צור
NSURL
המייצג את הקובץ באופן מקוון
הורדה בזיכרון
הורד את הקובץ לאובייקט NSData
בזיכרון באמצעות שיטת dataWithMaxSize:completion:
זוהי הדרך הקלה ביותר להוריד קובץ במהירות, אך היא חייבת לטעון את כל התוכן של הקובץ שלך לזיכרון. אם תבקש קובץ גדול מהזיכרון הזמין של האפליקציה שלך, האפליקציה שלך תתרסק. כדי להגן מפני בעיות זיכרון, הקפד להגדיר את הגודל המקסימלי למשהו שאתה יודע שהאפליקציה שלך יכולה להתמודד, או השתמש בשיטת הורדה אחרת.
מָהִיר
// 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
שבו אתה יכול להשתמש כדי לנהל את ההורדה שלך ולנטר את מצב ההעלאה.
מָהִיר
// 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:
ולצפות במשימת ההורדה, במקום להשתמש במטפל ההשלמה. ראה ניהול הורדות למידע נוסף.
צור כתובת אתר להורדה
אם כבר יש לך תשתית הורדה המבוססת על כתובות אתרים, או סתם רוצה שכתובת אתר שתשתף, תוכל לקבל את כתובת האתר להורדה של קובץ על ידי קריאה לשיטת downloadURLWithCompletion:
ב-Cloud Storage.
מָהִיר
// 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
:
מָהִיר
// 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
אירועים שאתה יכול לצפות בהם.
מָהִיר
// 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
שניתן להשתמש בו כדי להסיר את הצופה.
מָהִיר
// 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 | ההתייחסות שממנה הגיעה המשימה הזו. |
אתה יכול גם להסיר צופים, בנפרד, לפי סטטוס או על ידי הסרת כולם.
מָהִיר
// 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
.
טיפול בשגיאות
ישנן מספר סיבות לכך שגיאות עשויות להתרחש בהורדה, כולל הקובץ אינו קיים, או שלמשתמש אין הרשאה לגשת לקובץ הרצוי. מידע נוסף על שגיאות ניתן למצוא בקטע טיפול בשגיאות במסמכים.
דוגמה מלאה
דוגמה מלאה של הורדה לקובץ מקומי עם טיפול בשגיאות מוצגת להלן:
מָהִיר
// 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.