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: и отслеживать ход задачи загрузки, вместо использования обработчика завершения. Дополнительную информацию см. в разделе «Управление загрузками» .
Сгенерируйте URL-адрес для скачивания
Если у вас уже есть инфраструктура для загрузки файлов на основе URL-адресов или вы просто хотите поделиться URL-адресом, вы можете получить URL-адрес для загрузки файла, вызвав метод 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 предоставляет простые, настраиваемые и готовые к использованию нативные мобильные привязки, позволяющие избежать шаблонного кода и следовать рекомендациям 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 NSString *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 NSString *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 .