Cloud Storage pour Firebase vous permet de télécharger rapidement et facilement des fichiers à partir d'un bucket Cloud Storage fourni et géré par Firebase.
Créer une référence
Pour télécharger un fichier, créez d'abord une référence Cloud Storage au fichier que vous souhaitez télécharger.
Vous pouvez créer une référence en ajoutant des chemins enfants à la racine de votre bucket Cloud Storage, ou vous pouvez créer une référence à partir d'une URL gs://
ou https://
existante faisant référence à un objet dans Cloud Storage.
Rapide
// 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")
Objectif 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"];
Telecharger des fichiers
Une fois que vous avez une référence, vous pouvez télécharger des fichiers depuis Cloud Storage de trois manières :
- Télécharger sur
NSData
en mémoire - Télécharger vers une
NSURL
représentant un fichier sur l'appareil - Générer un
NSURL
représentant le fichier en ligne
Télécharger en mémoire
Téléchargez le fichier dans un objet NSData
en mémoire à l'aide de la méthode dataWithMaxSize:completion:
C'est le moyen le plus simple de télécharger rapidement un fichier, mais il doit charger l'intégralité du contenu de votre fichier en mémoire. Si vous demandez un fichier plus volumineux que la mémoire disponible de votre application, votre application plantera. Pour vous protéger contre les problèmes de mémoire, assurez-vous de définir la taille maximale sur quelque chose que vous savez que votre application peut gérer, ou utilisez une autre méthode de téléchargement.
Rapide
// 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!) } }
Objectif 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]; } }];
Télécharger dans un fichier local
La méthode writeToFile:completion:
télécharge un fichier directement sur un périphérique local. Utilisez-le si vos utilisateurs souhaitent accéder au fichier hors ligne ou le partager dans une autre application. writeToFile:completion:
renvoie une FIRStorageDownloadTask
que vous pouvez utiliser pour gérer votre téléchargement et surveiller l'état du téléchargement.
Rapide
// 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 } }
Objectif 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 } }];
Si vous souhaitez gérer activement votre téléchargement, vous pouvez utiliser la méthode writeToFile:
et observer la tâche de téléchargement, plutôt que d'utiliser le gestionnaire d'achèvement. Voir Gérer les téléchargements pour plus d'informations.
Générer une URL de téléchargement
Si vous disposez déjà d'une infrastructure de téléchargement basée sur des URL, ou si vous souhaitez simplement partager une URL, vous pouvez obtenir l'URL de téléchargement d'un fichier en appelant la méthode downloadURLWithCompletion:
sur une référence Cloud Storage.
Rapide
// 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' } }
Objectif 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' } }];
Télécharger des images avec FirebaseUI
FirebaseUI fournit des liaisons mobiles natives simples, personnalisables et prêtes pour la production pour éliminer le code passe-partout et promouvoir les meilleures pratiques de Google. À l'aide de FirebaseUI, vous pouvez télécharger, mettre en cache et afficher rapidement et facilement des images à partir de Cloud Storage grâce à notre intégration avec SDWebImage .
Tout d'abord, ajoutez FirebaseUI à votre Podfile
:
pod 'FirebaseStorageUI'
Ensuite, vous pouvez charger des images directement depuis Cloud Storage dans un UIImageView
:
Rapide
// 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)
Objectif 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];
Gérer les téléchargements
En plus de démarrer les téléchargements, vous pouvez suspendre, reprendre et annuler les téléchargements à l'aide des méthodes pause
, resume
et cancel
. Ces méthodes déclenchent des événements pause
, resume
et cancel
que vous pouvez observer.
Rapide
// 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()
Objectif 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];
Surveiller la progression du téléchargement
Vous pouvez attacher des observateurs aux FIRStorageDownloadTask
afin de surveiller la progression du téléchargement. L'ajout d'un observateur renvoie un FIRStorageHandle
qui peut être utilisé pour supprimer l'observateur.
Rapide
// Add a progress observer to a download task let observer = downloadTask.observe(.progress) { snapshot in // A progress event occurred }
Objectif c
// Add a progress observer to a download task FIRStorageHandle observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) { // A progress event occurred }];
Ces observateurs peuvent être enregistrés à un événement FIRStorageTaskStatus
:
Événement `FIRStorageTaskStatus` | Utilisation typique |
---|---|
FIRStorageTaskStatusResume | Cet événement se déclenche lorsque la tâche démarre ou reprend le téléchargement et est souvent utilisé conjointement avec l'événement FIRStorageTaskStatusPause . |
FIRStorageTaskStatusProgress | Cet événement se déclenche chaque fois que des données sont téléchargées depuis Cloud Storage et peut être utilisé pour remplir un indicateur de progression du téléchargement. |
FIRStorageTaskStatusPause | Cet événement se déclenche chaque fois que le téléchargement est interrompu et est souvent utilisé conjointement avec l'événement FIRStorageTaskStatusResume . |
FIRStorageTaskStatusSuccess | Cet événement se déclenche lorsqu'un téléchargement s'est terminé avec succès. |
FIRStorageTaskStatusFailure | Cet événement se déclenche lorsqu'un téléchargement a échoué. Inspectez l’erreur pour déterminer la raison de l’échec. |
Lorsqu'un événement se produit, un objet FIRStorageTaskSnapshot
est renvoyé. Cet instantané est une vue immuable de la tâche, au moment où l'événement s'est produit. Cet objet contient les propriétés suivantes :
Propriété | Taper | Description |
---|---|---|
progress | NSProgress | Un objet NSProgress contenant la progression du téléchargement. |
error | NSError | Une erreur survenue lors du téléchargement, le cas échéant. |
metadata | FIRStorageMetadata | nil sur les téléchargements. |
task | FIRStorageDownloadTask | La tâche dont il s'agit est un instantané qui peut être utilisé pour gérer ( pause , resume , cancel ) la tâche. |
reference | FIRStorageReference | La référence d'où provient cette tâche. |
Vous pouvez également supprimer des observateurs, soit individuellement, par statut, soit en les supprimant tous.
Rapide
// 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()
Objectif 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];
Pour éviter les fuites de mémoire, tous les observateurs sont supprimés après un FIRStorageTaskStatusSuccess
ou FIRStorageTaskStatusFailure
.
Gérer les erreurs
Il existe un certain nombre de raisons pour lesquelles des erreurs peuvent survenir lors du téléchargement, notamment le fait que le fichier n'existe pas ou que l'utilisateur n'est pas autorisé à accéder au fichier souhaité. Plus d’informations sur les erreurs peuvent être trouvées dans la section Gérer les erreurs de la documentation.
Exemple complet
Un exemple complet de téléchargement vers un fichier local avec gestion des erreurs est présenté ci-dessous :
Rapide
// 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 } }
Objectif 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; } } }];
Vous pouvez également obtenir et mettre à jour les métadonnées des fichiers stockés dans Cloud Storage.